---
# System prepended metadata

title: Swarm Notebooks & Dashboards

---

# Swarm Notebooks & Dashboards

[ complex to-do list. is there a better way to track ideas on this? - there are many different directions possible ]

Try https://github.com/Swarm-DISC/Swarm_notebooks/discussions & https://github.com/Swarm-DISC/Swarm_notebooks/projects

General notebook development guide, e.g. https://github.com/spacetelescope/style-guides/blob/master/guides/jupyter-notebooks.md, but accounting for different purposes of notebooks: *how-to/documentation, reproducible analysis, tutorial ...*

Rules for writing notebooks:
Check https://swarm.magneticearth.org/docs/notebook-development.html for more discussion. Some additional rules:
- Notebook should execute from top to bottom without human intervention (so it can be automated)
- Each title and subtitle should be in their own separate cell (so that, in JupyterLab, the section collapse button works correctly)
- Use a structure like:
  ```
  # Notebook title
   ...
  ## Section 1
   ...
  ## Section 2
   ...
  ### Subsection 2.1
  ```
  The first `#` will be the title of the page and used in the sidebar contents navigation. Don't skip straight from `#` to `###` or `jupyter-book` will complain
  
 See https://ploomber.io/blog/clean-nbs/ for more ideas. Check out https://notebooks.academy/en/latest/lessons/02-clean-nbs.html once it has been written... and see what Turing Way & Code Refinery have to offer.