Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds missing tutorials to docs #459

Merged
merged 3 commits into from
Sep 10, 2023
Merged

adds missing tutorials to docs #459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf97f7e
add missing tutorials to page
ismael-mendoza Sep 10, 2023
e674d42
remove advanced plots from pytest because it takes too long to run
ismael-mendoza Sep 10, 2023
bf1b713
Merge branch 'dev' into i/455
ismael-mendoza Sep 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/notebooks.yml
View file
Open in desktop
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
View file
Open in desktop
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.
Loading