Skip to content

Commit

Permalink
exclude some notebooks from being built because their require larger …
Browse files Browse the repository at this point in the history
…datasets
  • Loading branch information
vuillaut committed Sep 24, 2024
1 parent fce447f commit 41126c2
Show file tree
Hide file tree
Showing 9 changed files with 55 additions and 19 deletions.
14 changes: 14 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,21 @@

# Always build notebooks
nbsphinx_execute = "auto" # "never" | "always" | "auto" (build a notebook if its cell outputs are empty)

"""
note: these notebooks are excluded from build from their metadata ("nbsphinx": {"execute": "never"}})
"calculate_sensitivity_from_Crab.ipynb",
"explore_DL2.ipynb",
"read_and_plot_LST_Data.ipynb",
"read_LST1_data.ipynb",
"DL1b_to_DL2.ipynb",
"data_quality.ipynb",
"cleaning_dl1_with_pedestal.ipynb",
"time_calibration.ipynb",
"""

notebooks = [f for f in os.listdir(example_notebooks_output) if f.endswith('.ipynb')]

with open('notebooks.rst', 'w') as rst_file:
rst_file.write('Example notebooks\n=================\n\n')
rst_file.write('.. toctree::\n')
Expand Down
5 changes: 4 additions & 1 deletion notebooks/DL1b_to_DL2.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1371,7 +1371,10 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.5"
"version": "3.11.9"
},
"nbsphinx": {
"execute": "never"
}
},
"nbformat": 4,
Expand Down
5 changes: 4 additions & 1 deletion notebooks/calculate_sensitivity_from_Crab.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2006,7 +2006,10 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.8"
"version": "3.11.9"
},
"nbsphinx": {
"execute": "never"
}
},
"nbformat": 4,
Expand Down
7 changes: 5 additions & 2 deletions notebooks/cleaning_dl1_with_pedestal.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -207,7 +207,10 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.10"
"version": "3.11.9"
},
"nbsphinx": {
"execute": "never"
}
},
"nbformat": 4,
Expand Down
5 changes: 4 additions & 1 deletion notebooks/data_quality.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1846,7 +1846,10 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.8"
"version": "3.11.9"
},
"nbsphinx": {
"execute": "never"
}
},
"nbformat": 4,
Expand Down
5 changes: 4 additions & 1 deletion notebooks/explore_DL2.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,10 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.7"
"version": "3.11.9"
},
"nbsphinx": {
"execute": "never"
}
},
"nbformat": 4,
Expand Down
13 changes: 7 additions & 6 deletions notebooks/read_LST1_data.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,7 @@
{
"cell_type": "code",
"execution_count": 3,
"metadata": {
"scrolled": false
},
"metadata": {},
"outputs": [
{
"name": "stdout",
Expand Down Expand Up @@ -1240,7 +1238,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -1254,9 +1252,12 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.6"
"version": "3.11.9"
},
"nbsphinx": {
"execute": "never"
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
11 changes: 7 additions & 4 deletions notebooks/read_and_plot_LST_Data.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
}
],
"source": [
"source = EventSource(input_url=\"/Users/thomasvuillaume/Work/CTA/Data/LST1/LST-1.1.Run00088.0000.fits.fz\",\n",
"source = EventSource(input_url=\"test_data/real/R0/20240310/LST-1.1.Run17016.0000_first10.fits.fz\",\n",
" max_events=20)"
]
},
Expand Down Expand Up @@ -148,7 +148,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -162,9 +162,12 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.6.7"
"version": "3.11.9"
},
"nbsphinx": {
"execute": "never"
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
9 changes: 6 additions & 3 deletions notebooks/time_calibration.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -233,9 +233,12 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.6"
"version": "3.11.9"
},
"nbsphinx": {
"execute": "never"
}
},
"nbformat": 4,
"nbformat_minor": 1
"nbformat_minor": 4
}

0 comments on commit 41126c2

Please sign in to comment.