Merge pull request #41 from IMMM-SFA/feature/centralized_notebook_urls

add centralized notebook links to sphinx config; fixes #39

docs/source/3.3.4_low_discrepancy_sequences.rst

@@ -5,4 +5,4 @@ Low-discrepancy sequences is another sampling technique that employs a pseudo-ra
 
 .. note::
 
-    Put this into practice! Click the following link to try out an interactive tutorial which uses Sobol sequence sampling for the purposes of a Sobol sensitivity analysis:  `Sobol SA using SALib Jupyter Notebook <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fsa_saltelli_sobol_ishigami.ipynb>`_
+    Put this into practice! Click the following link to try out an interactive tutorial which uses Sobol sequence sampling for the purposes of a Sobol sensitivity analysis:  `Sobol SA using SALib Jupyter Notebook <nb_saltelli_sobol_>`_

docs/source/3.4.5_variance_based_methods.rst

@@ -29,4 +29,4 @@ Besides the Sobol method, there are some other variance-based sensitivity analys
 
 .. note::
 
-    Put this into practice! Click the following link to try out an interactive tutorial which demonstrates the application of a Sobol sensitivity analysis:  `Sobol SA using SALib Jupyter Notebook <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fsa_saltelli_sobol_ishigami.ipynb>`_
+    Put this into practice! Click the following link to try out an interactive tutorial which demonstrates the application of a Sobol sensitivity analysis:  `Sobol SA using SALib Jupyter Notebook <nb_saltelli_sobol_>`_

docs/source/4.1_understanding_errors_what_is_controlling_model_performance.rst

@@ -22,4 +22,4 @@ A comprehensive model diagnostic workflow typically entails the components demon
 
 .. note::
 
-    Put this into practice! Click the following badge to try out an interactive tutorial on implementing a time-varying sensitivity analysis of HYMOD model parameters:  `HYMOD Jupyter Notebook <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fhymod.ipynb>`_
+    Put this into practice! Click the following badge to try out an interactive tutorial on implementing a time-varying sensitivity analysis of HYMOD model parameters:  `HYMOD Jupyter Notebook <nb_hymod_>`_

docs/source/4.2_consequential_dynamics_what_is_controlling_model_behaviors_of_interest.rst

@@ -45,4 +45,4 @@ Despite these challenges, recent advanced sensitivity analysis methods can help
 
 .. note::
 
-    Put this into practice! Click the following badge to try out an interactive tutorial on performing a sensitivity analysis to discover consequential dynamics:  `Factor Discovery Jupyter Notebook <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Ffishery_dynamics.ipynb>`_
+    Put this into practice! Click the following badge to try out an interactive tutorial on performing a sensitivity analysis to discover consequential dynamics:  `Factor Discovery Jupyter Notebook <nb_fishery_dynamics_>`_

docs/source/4.3_consequential_scenarios_what_is_controlling_consequential_outcomes.rst

@@ -46,4 +46,4 @@ Below we provide an example application of two scenario discovery methods, PRIM
 
 .. note::
 
-    Put this into practice! Click the following link to try out an interactive tutorial on performing factor mapping using logistic regression:  `Logistic Regression Jupyter Notebook <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fbasin_users_logistic_regression.ipynb>`_
+    Put this into practice! Click the following link to try out an interactive tutorial on performing factor mapping using logistic regression:  `Logistic Regression Jupyter Notebook <nb_logistic_regression_>`_

docs/source/A1.3_Precalibration.rst

@@ -21,4 +21,4 @@ A related method, widely used in hydrological studies, is generalized likelihood
 
 .. note::
 
-    Put this into practice! Click the following badge to try out an interactive tutorial on utilizing Pre-Calibration and GLUE for HYMOD model calibration:  `Pre-Calibration Jupyter Notebook <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fhymod.ipynb>`_
+    Put this into practice! Click the following badge to try out an interactive tutorial on utilizing Pre-Calibration and GLUE for HYMOD model calibration:  `Pre-Calibration Jupyter Notebook <nb_hymod_>`_

docs/source/A2.1_fishgame.rst

@@ -3,7 +3,7 @@ Fishery Dynamics Tutorial
 
 .. note::
 
-    | Run the tutorial interactively using Binder:  `Fishery Dynamics Notebook <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Ffishery_dynamics.ipynb>`_.
+    | Run the tutorial interactively using Binder:  `Fishery Dynamics Notebook <nb_fishery_dynamics_>`_.
     | Please be aware that Binder notebooks can take up to 10 minutes to launch.
     | To run the notebooks yourself, download the files `here <https://github.com/IMMM-SFA/msd_uncertainty_ebook/tree/main/notebooks>`_ and use these `requirements <https://github.com/IMMM-SFA/msd_uncertainty_ebook/blob/main/requirements.txt>`_.
 

docs/source/A2.2_saltelli.rst

@@ -3,7 +3,7 @@ Sobol SA Tutorial
 
 .. note::
 
-    | Run the tutorial interactively using Binder:  `Sobol SA Tutorial <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fsa_saltelli_sobol_ishigami.ipynb>`_.
+    | Run the tutorial interactively using Binder:  `Sobol SA Tutorial <nb_saltelli_sobol_>`_.
     | Please be aware that Binder notebooks can take up to 10 minutes to launch.
     | To run the notebooks yourself, download the files `here <https://github.com/IMMM-SFA/msd_uncertainty_ebook/tree/main/notebooks>`_ and use these `requirements <https://github.com/IMMM-SFA/msd_uncertainty_ebook/blob/main/requirements.txt>`_.
 

docs/source/A2.3_logistic.rst

@@ -3,7 +3,7 @@ Logistic Regression Tutorial
 
 .. note::
 
-    | Run the tutorial interactively using Binder:  `Logistic Regression Tutorial <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fbasin_users_logistic_regression.ipynb>`_.
+    | Run the tutorial interactively using Binder:  `Logistic Regression Tutorial <nb_logistic_regression_>`_.
     | Please be aware that Binder notebooks can take up to 10 minutes to launch.
     | To run the notebooks yourself, download the files `here <https://github.com/IMMM-SFA/msd_uncertainty_ebook/tree/main/notebooks>`_ and use these `requirements <https://github.com/IMMM-SFA/msd_uncertainty_ebook/blob/main/requirements.txt>`_.
 

docs/source/A2.4_hymod.rst

@@ -3,7 +3,7 @@ HYMOD Dynamics Tutorial
 
 .. note::
 
-    | Run the tutorial interactively using Binder:  `HYMOD Notebook <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fhymod.ipynb>`_.
+    | Run the tutorial interactively using Binder:  `HYMOD Notebook <nb_hymod_>`_.
     | Please be aware that Binder notebooks can take up to 10 minutes to launch.
     | To run the notebooks yourself, download the files `here <https://github.com/IMMM-SFA/msd_uncertainty_ebook/tree/main/notebooks>`_ and use these `requirements <https://github.com/IMMM-SFA/msd_uncertainty_ebook/blob/main/requirements.txt>`_.
 

docs/source/conf.py

@@ -21,6 +21,16 @@
 today = f"Last updated: {datetime.utcnow().strftime('%b %d, %Y')}"
 
 
+# -- Notebook URLs -----------------------------------------------------------
+
+rst_prolog = """
+.. _nb_logistic_regression: https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fbasin_users_logistic_regression.ipynb
+.. _nb_saltelli_sobol: https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fsa_saltelli_sobol_ishigami.ipynb
+.. _nb_hymod: https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fhymod.ipynb
+.. _nb_fishery_dynamics: https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Ffishery_dynamics.ipynb
+"""
+
+
 # -- Project information -----------------------------------------------------
 
 project = 'Addressing Uncertainty in MultiSector Dynamics Research'

docs/source/index.rst

@@ -28,10 +28,10 @@ Addressing Uncertainty in MultiSector Dynamics Research
 
     **Interactive Tutorials**
 
-    * `Factor Discovery <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Ffishery_dynamics.ipynb>`_
-    * `Model Calibration <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fhymod.ipynb>`_
-    * `Sobol Sensitivity Analysis <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fsa_saltelli_sobol_ishigami.ipynb>`_
-    * `Factor Mapping using Logistic Regression <https://mybinder.org/v2/gh/IMMM-SFA/msd_uncertainty_ebook/main?labpath=notebooks%2Fbasin_users_logistic_regression.ipynb>`_
+    * `Factor Discovery <nb_fishery_dynamics_>`_
+    * `Model Calibration <nb_hymod_>`_
+    * `Sobol Sensitivity Analysis <nb_saltelli_sobol_>`_
+    * `Factor Mapping using Logistic Regression <nb_logistic_regression_>`_
 
     .. tip::