oxDNA

oxDNA: coarse-grained simulations of nucleic acids made simple - Published in JOSS (2023)

https://github.com/lorenzo-rovigatti/oxdna

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 13 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    5 of 38 committers (13.2%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

dna physics-simulation simulation

Keywords from Contributors

mesh

Scientific Fields

Biology Life Sciences - 40% confidence
Last synced: 4 months ago · JSON representation

Repository

A new version of the code to simulate the oxDNA/oxRNA models, now equipped with Python bindings

Basic Info
  • Host: GitHub
  • Owner: lorenzo-rovigatti
  • License: gpl-3.0
  • Language: C++
  • Default Branch: master
  • Homepage: https://dna.physics.ox.ac.uk/
  • Size: 49.4 MB
Statistics
  • Stars: 60
  • Watchers: 9
  • Forks: 36
  • Open Issues: 9
  • Releases: 10
Topics
dna physics-simulation simulation
Created over 6 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing License

README.md

oxDNA

oxDNA is a simulation code that was initially conceived as an implementation of the coarse-grained DNA model introduced by T. E. Ouldridge, J. P. K. Doye and A. A. Louis. It has been since reworked and it is now an extensible simulation+analysis framework. It natively supports DNA, RNA, Lennard-Jones and patchy particle simulations of different kinds on both single CPU cores and NVIDIA GPUs.

The development of this software has been partially supported by the European Commission through the Marie Skłodowska−Curie Fellowship No.702298-DELTAS, and ONR grant N000142012094.

Documentation

The documentation can be browsed here.

The HTML documentation can also be generated locally by running make html in the docs folder, and the resulting docs can be browsed by opening the docs/build/html/index.html file. Run pip install -r docs_requirements.txt to install the requirements.

Installation

Installation instructions can be found in the docs/source/install.md file or online here.

Examples

The examples folder contains many examples showing the main features of the code. Note that the METADYNAMICS, OXPY and OXPY_REMD examples require oxpy, oxDNA's python bindings that can be compiled by setting -DPython=ON during the compilation stage.

The analysis/paper_examples folder contains examples for oxDNA_analysis_tools, a suite of command line Python tools for performing generic structural analyses of oxDNA simulations.

FAQ

Q: How do I simulate oxDNA with LAMMPS?

A: This repository contains the standalone oxDNA software and it is not linked to the code that powers the LAMMPS version of the oxDNA coarse-grained model. If you have any issues/enquiries about the oxDNA LAMMPS package your best bet is to directly contact its authors.

Q: Can oxDNA be run on multiple CPU cores or GPUs?

A: No, oxDNA can run simulations on single cores or single GPUs only. However, the Python bindings (oxpy) can be used to implement parallel algorithms on top of oxDNA. See for instance examples/METADYNAMICS and examples/OXPY_REMD.

Q: How is the oxDNA force field defined?

A: The functional forms can be found in the original publications:

Citing oxDNA

DOI

Please cite these publications for any work that uses the oxDNA simulation package:

Acknowledgements

oxDNA depends on a minimum number of external libraries (a c++-14-compliant standard library and NVIDIA's CUDA if the user wishes to enable it).

Internally, oxDNA uses the following libraries, which are included in the source tree:

As far as I know, this is compatible with their licenses. If you are a developer or a mantainer of one of these projects and you think that oxDNA does not comply with your license, please contact us.

Owner

  • Name: Lorenzo Rovigatti
  • Login: lorenzo-rovigatti
  • Kind: user
  • Location: Rome
  • Company: Sapienza University of Rome

Associate professor of computational physics

JOSS Publication

oxDNA: coarse-grained simulations of nucleic acids made simple
Published
January 21, 2023
Volume 8, Issue 81, Page 4693
Authors
Erik Poppleton ORCID
School of Molecular Sciences and Center for Molecular Design and Biomimetics, The Biodesign Institute, Arizona State University, United States of America
Michael Matthies
School of Molecular Sciences and Center for Molecular Design and Biomimetics, The Biodesign Institute, Arizona State University, United States of America
Debesh Mandal
Department of Materials, Imperial College London, United Kingdom
Flavio Romano
Dipartimento di Scienze Molecolari e Nanosistemi, Universitá Ca Foscari di Venezia, Italy
Petr Šulc ORCID
School of Molecular Sciences and Center for Molecular Design and Biomimetics, The Biodesign Institute, Arizona State University, United States of America
Lorenzo Rovigatti ORCID
Department of Physics, Sapienza University of Rome, Italy, CNR-ISC UoS Sapienza, Rome, Italy
Editor
Antonia Mey ORCID
Tags
C++ DNA DNA nanotechnology Molecular simulations

GitHub Events

Total
  • Create event: 4
  • Release event: 1
  • Issues event: 36
  • Watch event: 15
  • Delete event: 3
  • Issue comment event: 83
  • Push event: 57
  • Pull request review event: 6
  • Pull request review comment event: 3
  • Pull request event: 26
  • Fork event: 8
Last Year
  • Create event: 4
  • Release event: 1
  • Issues event: 36
  • Watch event: 15
  • Delete event: 3
  • Issue comment event: 83
  • Push event: 57
  • Pull request review event: 6
  • Pull request review comment event: 3
  • Pull request event: 26
  • Fork event: 8

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 1,627
  • Total Committers: 38
  • Avg Commits per committer: 42.816
  • Development Distribution Score (DDS): 0.441
Past Year
  • Commits: 84
  • Committers: 10
  • Avg Commits per committer: 8.4
  • Development Distribution Score (DDS): 0.548
Top Committers
Name Email Commits
Lorenzo Rovigatti l****i@g****m 910
Erik Poppleton r****n@g****m 181
flavioromano 3****o 127
Ferdinando Randisi f****i@g****m 87
Eryk Ratajczyk 0****k@g****m 62
tgfrancesco 5****o 45
sulcp 3****p 38
bsnodin b****n@8****6 34
fochtman f****n@8****6 19
Erik Poppleton e****n@b****e 18
zoombya p****b@g****m 17
Debesh-XPS d****l@h****m 14
herbinaberry h****y@8****6 11
mc2engel m****l@8****6 9
francescotg f****g@n***** 7
Erik Poppleton p****k@r****e 6
Erik Poppleton p****k@r****e 5
Constantine Evans c****t@c****u 4
Erik Poppleton e****n@b****l 4
henjacob h****b@8****6 3
elija feigl e****l 3
Luca Monari w****7@u****e 2
Subhajit Roy 4****o 2
dependabot[bot] 4****] 2
Debesh Mandal d****3@i****k 2
cmatek c****k@8****6 2
lorenzo l****o@c****9 2
Dominik Schiwietz 6****k 1
mtortora m****a@8****6 1
lorenzo l****o@l****p 1
and 8 more...

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 66
  • Total pull requests: 58
  • Average time to close issues: 26 days
  • Average time to close pull requests: 7 days
  • Total issue authors: 40
  • Total pull request authors: 15
  • Average comments per issue: 2.95
  • Average comments per pull request: 1.53
  • Merged pull requests: 46
  • Bot issues: 0
  • Bot pull requests: 5
Past Year
  • Issues: 27
  • Pull requests: 27
  • Average time to close issues: 22 days
  • Average time to close pull requests: 8 days
  • Issue authors: 14
  • Pull request authors: 9
  • Average comments per issue: 2.3
  • Average comments per pull request: 1.26
  • Merged pull requests: 21
  • Bot issues: 0
  • Bot pull requests: 3
Top Authors
Issue Authors
  • JeDeveloper (5)
  • lorenzo-rovigatti (5)
  • alec-cook (5)
  • elija-feigl (3)
  • AdaABen (3)
  • SimonGrall (3)
  • simonecodispoti (3)
  • songge1111 (3)
  • dave-doty (2)
  • jinhzhou (2)
  • lgruenewald (2)
  • swapnilbaral-git (2)
  • Zehui127 (2)
  • jche0092 (1)
  • BradyAJohnston (1)
Pull Request Authors
  • eryykr (9)
  • ErikPoppleton (7)
  • Subhajit-Roy-Partho (5)
  • elija-feigl (5)
  • dependabot[bot] (5)
  • Lucandia (4)
  • zoombya (4)
  • lorenzo-rovigatti (3)
  • mlsample (3)
  • jinhzhou (2)
  • tgfrancesco (2)
  • dominjack (2)
  • cgevans (2)
  • JeDeveloper (2)
  • RodenLuo (1)
Top Labels
Issue Labels
bug (39) enhancement (18) documentation (9) question (1) wontfix (1)
Pull Request Labels
dependencies (5) python (2)

Dependencies

.github/workflows/build-docs.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • ad-m/github-push-action master composite
.github/workflows/build-linux.yml actions
  • actions/checkout v2 composite
.github/workflows/oxpy-build-linux.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/test-linux.yml actions
  • actions/checkout v2 composite
analysis/pyproject.toml pypi
analysis/setup.py pypi
analysis/src/oxDNA_analysis_tools/cython_utils/setup.py pypi
docs/docs_requirements.txt pypi
  • Jinja2 <3.1
  • Sphinx ==3.4.1
  • docutils ==0.16
  • ipython >=7.26.0
  • myst_parser ==0.17.2
  • sphinx-argparse >=0.3.1
  • sphinx_rtd_theme ==0.5.0
oxpy/pybind11/pyproject.toml pypi
oxpy/pybind11/setup.py pypi
oxpy/pybind11/tools/pyproject.toml pypi
setup.py pypi
  • oxDNA_analysis_tools *