Add Examples
April 22, 2025 · View on GitHub
Goal
Provide a runnable demonstration in a Jupyter notebook.
Rules
- Runtime <30 s on a typical laptop (in most cases).
- Use only the public API – no private helpers.
import particula as par
- End with at least one plot or printed result.
- Contextualize the example with a short description of what it does and why it's useful.
Steps
- Create a new issue on GitHub and assign it to yourself.
- Create a branch on your forked repo for this issue.
- Create
docs/examples/**/<feature_name>.ipynb.- Add a new folder if needed, but please keep it organized.
- These can also be under
docs/Theory/**/<feature_name>.ipynbto validate the implementation of the theory.
- Interleave Markdown explanations with code cells.
- Verify it runs top‑to‑bottom.
- Commit the .ipynb file in your PR branch.
- The website builder will automatically convert it to markdown and HTML during PR.
- Create your pull‑request description.