Coding conventions

The following conventions should be followed at all times for any code to be accepted into the relax repository. A Python script which tests if code meets relax's coding conventions is distributed with relax and is located at scripts/code_validator. The main reason for these conventions is for readability. By using a consistent coding style and a high comment ratio, the code becomes much easier to read for non-coders and those new to Python. It significantly decreases the barrier of entry into the relax source code for NMR spectroscopists.


The relax user manual (PDF), created 2024-06-08.