Merge pull request #92 from bsipocz/MAINT_jupyter_cache

CI: adding caching for notebooks

Author: bsipocz

.circleci/config.yml

@@ -7,21 +7,38 @@ jobs:
       - image: cimg/python:3.12
 
     steps:
+      - attach_workspace:
+          at: ~/
+
       - checkout
 
       - run:
           name: Install CI dependencies
           command: python -m pip install --upgrade tox
 
+      - restore_cache:
+          keys:
+              - jupyter_ch
+
       - run:
           name: Build HTML rendering of notebooks
           no_output_timeout: 30m
           command: |
             python -m tox -e py312-buildhtml
 
+      - save_cache:
+          key: jupyter_ch
+          paths:
+            - _build/.jupyter_cache
+
       - store_artifacts:
           path: _build/html
 
+      - persist_to_workspace:
+          root: _build
+          paths:
+            - html
+
 workflows:
   version: 2
   default:

conf.py

@@ -15,7 +15,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Caltech/IPAC--IRSA Demo Notebooks'
-copyright = '2022-2024, IRSA developers'
+copyright = '2022-2025, IRSA developers'
 author = 'IRSA developers'
 
 
@@ -44,6 +44,7 @@
 # MyST-NB configuration
 nb_execution_timeout = 1200
 nb_merge_streams = True
+nb_execution_mode = "cache"
 
 nb_execution_excludepatterns = []
 

tox.ini

@@ -56,7 +56,7 @@ commands =
     !buildhtml: bash -c 'if [[ $GITHUB_EVENT_NAME == pull_request && -z "$(grep force_run:all_tests ${GITHUB_EVENT_PATH})" ]]; then git fetch origin main --depth=1; git diff origin/main --name-only tutorials | grep .md; else find tutorials -name "*.md"; fi | grep -vf ignore_testing | xargs jupytext --to notebook '
 
     !buildhtml: pytest --nbval-lax -vv --suppress-no-test-exit-code --durations=10 tutorials
-    buildhtml: sphinx-build -b html . _build/html -D nb_execution_mode=auto -nWT --keep-going
+    buildhtml: sphinx-build -b html . _build/html -nWT --keep-going
     # SED magic to remove the toctree captions from the rendered index page while keeping them in the sidebar TOC
     buildhtml: sed -E -i.bak '/caption-text/{N; s/.+caption-text.+\n<ul>/<ul>/; P;D;}' _build/html/index.html
     buildhtml: bash -c 'rm _build/html/index.html.bak'

tutorials/euclid_access/2_Euclid_intro_MER_catalog.md

@@ -155,8 +155,8 @@ plt.title('10k Stars in MER catalog -- IRSA')
 
 ## About this Notebook
 
-**Author**: Tiffany Meshkat (IPAC Scientist)
+**Author**: Tiffany Meshkat, Anahita Alavi, Anastasia Laity, Andreas Faisst, Brigitta Sipőcz, Dan Masters, Harry Teplitz, Jaladh Singhal, Shoubaneh Hemmati, Vandana Desai
 
-**Updated**: 2025-03-19
+**Updated**: 2025-03-31
 
 **Contact:** [the IRSA Helpdesk](https://irsa.ipac.caltech.edu/docs/help_desk.html) with questions or reporting problems.

tutorials/euclid_access/4_Euclid_intro_PHZ_catalog.md

@@ -437,8 +437,8 @@ fc.show_table(uploaded_table)
 
 ## About this Notebook
 
-**Author**: Tiffany Meshkat, Anahita Alavi, Anastasia Laity, Andreas Faisst, Brigitta Sipőcz, Dan Masters, Harry Teplitz, Jaladh Singhal,  Shoubaneh Hemmati.
+**Author**: Tiffany Meshkat, Anahita Alavi, Anastasia Laity, Andreas Faisst, Brigitta Sipőcz, Dan Masters, Harry Teplitz, Jaladh Singhal, Shoubaneh Hemmati, Vandana Desai
 
-**Updated**: 2025-03-26
+**Updated**: 2025-03-31
 
 **Contact:** [the IRSA Helpdesk](https://irsa.ipac.caltech.edu/docs/help_desk.html) with questions or reporting problems.

tutorials/openuniversesims/openuniverse2024_roman_simulated_timedomainsurvey.md

@@ -4,9 +4,9 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.16.2
+    jupytext_version: 1.16.7
 kernelspec:
-  display_name: science_demo
+  display_name: Python 3 (ipykernel)
   language: python
   name: python3
 ---
@@ -52,11 +52,11 @@ from scipy.ndimage import rotate
 
 # Needed to access data in the cloud
 import s3fs
-s3 = s3fs.S3FileSystem(anon=True) # create an S3 client
+s3 = s3fs.S3FileSystem(anon=True)  # create an S3 client
 
 # Filter out the FITSFixedWarning, which is consequenceless and gets thrown every time you deal with a WCS
 # in a Roman openuniverse simulated image using astropy.
-warnings.simplefilter('ignore',category=FITSFixedWarning)
+warnings.simplefilter('ignore', category=FITSFixedWarning)
 ```
 
 ## Define a module to get the date (mjd) of a particular pointing.
@@ -86,7 +86,7 @@ def get_mjd(pointing,
 ## Define a module to create an animated gif from a collection of cutouts.
 
 ```{code-cell} ipython3
-def animate_stamps(stamps,savepath,no_whitespace=True,
+def animate_stamps(stamps, savepath, no_whitespace=True,
                    labels=[],labelxy=(0.05,0.95),
                    **kwargs):
     """
@@ -290,13 +290,9 @@ for i, row in enumerate(instances.itertuples()):
 ```{code-cell} ipython3
 savepath = f'SN{oid}.gif'
 savepath
-animate_stamps(stamps,savepath,labels=mjd)
+animate_stamps(stamps, savepath, labels=mjd)
 ```
 
-![animated gif](SN20000808.gif)
-
-+++
-
 ***
 
 ## About this notebook