Developer Documentation

Developer Documentation

Please read this documentation before modifying the MDMC code base. Any pull requests that are not consistent with this documentation will not be merged.

Coding Standards

Follow standards described in PEP 8, except where it differs from standards already adopted in surrounding code. For example, snake_case is used for all variables names, except when the variable contains an abbreviation. So a variable related to a molecular dynamics (MD) engine is MD_engine, rather than md_engine.

Documentation

MDMC follows the NumPy documentation style, which is consistent with PEP 257.

Code Checker/Linter

Use a code checker or linter such as pylint or flake8, to ensure that