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
• Testing
• Writing documentation

Developer docs

The online docs (development branch) for the development branch are updated with every merge into develop. Check these docs (and make sure that your own documentation changes look ok).

• Trajectory API
  • Trajectory API
  • File formats
• Topology API
  • Writing a new topology reader
  • Guide to new topology format
  • Topology data structures
  • New Topology Docs (since 0.16.0, aka "#363")
    • changes in the new topology system
    • Using TopologyAttributes
• MDAnalysis.analysis API

For maintainers/release managers

• Preparing a release
• Semantic Versioning

Website and repository management

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

Benchmarking and Performance

• benchmark with asv (wiki)