Questions and How to Contribute

Questions

Questions can be submitted here Before you ask a question, it is best to search for existing answers that might help you. To ask a question:

  • Open an Issue.

  • Provide as much context as you can about what you’re running into.

We will then take care of the issue as soon as possible.

Making Contributions

Suggesting Enhancements

If you have suggestions on how to improve the documentation visit GitHub issues to offer ideas.

Contributions

If you want to submit changes to the documentation or add additional examples, follow the following guidelines:

  • New documentation can be added as an rst file or as a Jupyter notebook.

    • rst files are stored in source/pages and notebooks in source/notebooks

  • Make sure new notebooks are formatted with title and the code is well commented.

  • Execute the notebook prior to uploading (notebooks are not run when the docs are built).

  • Add new files to source/index.rst

  • After adding a new file, run make html (.\make.bat html if in PowerShell) in the docs directory to make sure there are no bugs

  • If additional libraries are required, update docs/environment.yml

  • Outline all changes made in the commit message