In this page, we would like to provide information for developers willing to help contribute to this project.
Clone the repository and start a branch for whatever work you are doing. If your project is well formulated, you can also raise it as an enhancement in the issues tab, and we can assign the work to you.
All public subroutines should be documented using FORD (Fortran) or Doxygen (C++). Private routines can also optionally be documented this way.
All text that is written to the console should be written through the logging module (this makes it easier to parse the output).
The source code is beautified using the atom beautify package. If you don't want to install a beautifier that is ok, just mention that you need someone to run a beautify script in your pull request. The C++ beautifier is set to clang-format. For python code, the code is checked for style issues with the flake8 tool during the CI stage.
If your code makes use of something from the literature, put a reference to it in the Citations.bib file.
For floating point values, please use the types in the DataTypesModule. This helps maintain C compatibility and makes it easier to change the precision.