Skip to content

Add Theory

Goal

Create a short, citable document that explains the science behind the new feature.

What to include

Include enough information that a new reader would be able to understand and implement the feature. This should include:

  • An overview of the physical/chemical process.
  • Governing equations (Unicode symbols preferred) with variable definitions.
  • Assumptions or limitations.
  • At least one primary literature citation.

Steps

  1. Create a new issue on GitHub and assign it to yourself.
  2. Create a branch on your forked repo for this issue.
  3. Add a new markdown file at docs/Theory/**/<feature_name>.md. This can be a new folder if needed, but please keep it organized.
  4. Link the file in the index.md file in the same folder.
  5. Write using Markdown; no specific imports needed.
  6. Commit this file in a branch.
  7. Create your pull request.