Source - MDAnalysis/mdanalysis GitHub Wiki

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:

[email protected]:MDAnalysis/mdanalysis.git
https://github.com/MDAnalysis/mdanalysis.git
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/

package contains the MDAnalysis toolkit source code.
testsuite contains the code for the UnitTests and the datafiles

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.)