Oliver Beckstein edited this page Apr 7, 2015 · 3 revisions

The MDAnalysis source code is stored in a git repository at https://github.com/MDAnalysis/mdanalysis/.

Git repository structure

The full description of the git repository structure is available here.

To clone/download/checkout the repository, use one of the following URLs:

  1. git@github.com:MDAnalysis/mdanalysis.git
  2. https://github.com/MDAnalysis/mdanalysis.git
  3. fork it on GitHub

Option (1) requires that you have a username on GitHub.

Stable source code

Production-ready code is stored in the main branch.

You can browse the master branch.

Please note that main development is done using the develop branch.

Development source code

Development code is stored in the develop branch.

You can browse the develop branch.

Source code organisation

When you check out the source code you'll get a directory hierarchy that looks like

mdanalysis/README
           package/
           testsuite/

When you add a new feature (in package) then you should also add a test case (see UnitTests) and possibly data files in testsuite and commit both together.

(See also Issue 87.)

Project Information

About
GNU GPL v2 code license
Labels: python, molecular dynamics, analysis, DCD, CHARMM, LAMMPS, NAMD, Gromacs, computer simulation, atoms, coordinates, trajectory, XTC, Library, object-oriented
Core Developers

Essentials

Applications
Downloads
Install
Release Notes
Guide for Developers
Google Summer of Code

Code of Conduct

Links

@mdanalysis on Twitter
Documentation
Tutorials
Downloads (PyPi)
Mailing Lists:
User discussion group
Developer mailing list

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.