Contributing to the Project

Documentation

The documentation is created using sphinx and read-the-docs, which uses the reStructuredText format to create documents. To add documentation, go to the docs folder, where you will find a list of .rst files, the home page is written in index.rst, and links to the other subpages which are in the other .rst files.

These documents can be opened in any text editor of your choice, to learn more about hwo to write in reStructuredText, you can read:

• https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

• https://sublime-and-sphinx-guide.readthedocs.io/en/latest/index.html

Code

To contribute code to the project, create a new branch of the analysis pipeline from the github site, make your changes, and create a pull request.

Suggestions / Troubleshooting

For general code suggestions, such as adding new features, or troubleshooting, open up a new issue in the issues page of the github site. You can see an example issue here.