mdna 0.1.0

Software module for DNA structure analysis and generation

MDNA: a software module for DNA structure generation and analysis

Description

MDNA is a Python toolkit for building, modifying and analyzing double stranded DNA structures at atomic resolution. It generates arbitrary DNA shapes through spline based mapping, supports canonical and non canonical base modifications, and applies Monte Carlo minimization to obtain physically consistent configurations. The toolkit implements full rigid base analysis, including intra base pair parameters shear, stretch, stagger, buckle, propeller, and opening, as well as inter base pair step parameters shift, slide, rise, tilt, roll, and twist. With built in linking number calculations and seamless interoperability with MDTraj and OpenMM, MDNA unifies structure generation, editing, and analysis in a single modular framework for complex DNA and DNA protein assemblies.

Installation

To install MDNA use pip:

pip install mdna

Or if you want to install the most recent version of MDNA, follow these steps:

git clone --recurse-submodules https://github.com/heezch/mdna.git

After that go to the 'mdna' project folder and do:

pip install .

Usage

See our documentation page

Citation

Link to the publication

Contributing

We welcome contributions from the community! To contribute:

• Fork the repository.
• Create a new branch (git checkout -b feature-branch).
• Make your changes and commit them (git commit -am 'Add new feature').
• Push to the branch (git push origin feature-branch).
• Create a new Pull Request.

Please ensure your code adheres to our coding standards and includes relevant tests.

Optional full filament dataset (tutorial)

The filament tutorial runs in minimal mode by default using bundled filament_minimal data. If you want full-trajectory mode, download the optional dataset:

cd examples
export MDNA_FILAMENT_DATASET_URL='https://doi.org/10.6084/m9.figshare.31423193'
python ./scripts/fetch_filament_dataset.py --output-root ./data

Optional integrity check (only if you know the real archive hash):

cd examples
export MDNA_FILAMENT_DATASET_URL='https://doi.org/10.6084/m9.figshare.31423193'
export MDNA_FILAMENT_DATASET_SHA256='<REAL_SHA256>'
python ./scripts/fetch_filament_dataset.py --output-root ./data --force

If you do not have a published SHA256 yet, leave MDNA_FILAMENT_DATASET_SHA256 unset and run the download command without checksum verification.

What happens behind the scenes: the DOI points to a Figshare item page, and the fetch script automatically resolves the direct file download URL before downloading and unpacking the archive into examples/data/filament_dataset.

Optional: build PyLk Cython extensions (faster + no fallback warnings)

MDNA vendors PyLk inside mdna/PMCpy/pmcpy/Evals/PyLk. If you see warnings like "Cython version of writhemap/linkingnumber not compiled", you can compile the extensions in-place:

Prerequisite: ensure Cython is installed in the same environment where you run MDNA.

# example for conda/mamba env named `mdna`
mamba run -n mdna python -m pip install Cython

# from repository root
cd mdna/PMCpy/pmcpy/Evals/PyLk
python setup.py build_ext --inplace

If you use conda/mamba, run with your env explicitly:

mamba run -n mdna python mdna/PMCpy/pmcpy/Evals/PyLk/setup.py build_ext --inplace

Quick verification:

mamba run -n mdna python - <<'PY'
from mdna.PMCpy.pmcpy.Evals.PyLk.pylk import writhemap, eval_link
print('PyLk import OK:', writhemap.__name__, eval_link.__name__)
PY

License

This project is licensed under the MIT License. See the LICENSE file for details.