Skip to content

Commit

Permalink
adds missing tutorials to docs (#459)
Browse files Browse the repository at this point in the history
* add missing tutorials to page

* remove advanced plots from pytest because it takes too long to run
  • Loading branch information
ismael-mendoza authored Sep 10, 2023
1 parent 336c8ac commit 9dd1b25
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/notebooks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ jobs:
# just checks if they run
- name: Run notebooks
run: |
poetry run pytest --nbmake notebooks
poetry run pytest --nbmake notebooks --ignore notebooks/02-advanced-plot.ipynb
2 changes: 2 additions & 0 deletions docs/source/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ The following jupyter notebooks are included in the `notebooks/ <https://github.

- ``00-quickstart.ipynb``: A quickstart guide to using `btk`.
- ``01-scarlet.ipynb``: A tutorial on using `scarlet` within `btk`.
- ``01-catsim-scenes.ipynb``: A tutorial on generating galaxy scenes from `CatSim` catalogs within `btk`.
- ``02-advanced-plots.ipynb``: A tutorial on using `btk` to generate advanced plots to evaluate one or multiple deblenders.

0 comments on commit 9dd1b25

Please sign in to comment.