Guide for Developers

Useful Links for Developing MDAnalysis

Searching: GitHub does not provide a search for wikis itself (!) but you can install the GitHub Wiki Search plugin into your browser, which patches a search box into any GitHub wiki that you visit. Or use the Search This Repository functionality at the top of the page and look under the Wiki tab.

First read

• Code of conduct
• Style Guide

Then look at (in no particular order)

• Setup Development Environment
• Contributing code
• Working on the MDAnalysis core
• Distributed development with git
• Workflow and conventions
• Preparing a release
• Testing
• Source Code Management
• Writing documentation
• Trying the development branch

Developer docs:

• Online docs (development branch)
• Trajectory API
• Writing a new topology reader
• Guide to new topology format
• Topology data structures
• Semantic Versioning
• Extensions and Python 3

New Topology Docs:

• Upcoming changes
• Using TopologyAttributes

Website and repository management

• OAuth tokens for doc deployment
• Moving the Project to GitHub