Demo Notebooks

Below we provide Jupyter notebooks that demonstrate Sorcha's capabilities and validate various functions and components within Sorcha. These notebooks are automatically generated in the online documentation so you can view the contents and output of the notebooks by clicking on the link to each notebook.

In addition to installing Sorcha and its dependencies, you will need to install (through pip/conda/mamba) the following additional packages to run all of the demo notebooks:

  • jupyter

  • seaborn

  • sorcha-addons

  • rubin_sim (only required for demo_CalculateLSSTColours.ipynb) and the associated filter/optical system throughputs via (running scheduler_download_data on the command line)

Note

These packages are installed (except for rubin_sim) if you install Sorcha from the source code via pip in editable development mode as described in the Installing Sorcha in Development Mode page.

Tip

The easiest way to run the notebooks is to clone the repository and install Sorcha from the source code via pip in editable development mode as described in the Installing Sorcha in Development Mode page. Then move to the docs/notebooks directory and run the notebooks from the there. We also provide the data files used below so you can try individual notebooks out without running them all or cloning the full repository.

Demo Notebooks

Supplementary Files Required To Run the Notebooks Individually

Tip

The easiest way to run the notebooks is to clone the repository and install Sorcha from the source code via pip in editable development mode as described in the Installing Sorcha in Development Mode page. Then move to the docs/notebooks directory and run the notebooks from the there. We also provide the data files used below so you can try individual notebooks out without running them all or cloning the full repository.