Move examples to docs folder

pyet-org · Feb 15, 2024 · 5654889 · 5654889
1 parent 7b4d4b3
commit 5654889
Show file tree

Hide file tree

Showing 34 changed files with 734 additions and 480 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -12,8 +12,12 @@
 #
 import os
 import sys
+from datetime import date
+
 import requests
 
+year = date.today().strftime("%Y")
+
 sys.path.insert(0, os.path.abspath('.'))
 
 # Get a Bibtex reference file from the Zotero group for referencing
@@ -39,7 +43,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'pyet'
-copyright = '2021, M. Vremec, R.A. Collenteur'
+copyright = '{}, M. Vremec, R.A. Collenteur'.format(year)
 author = 'M. Vremec, R.A. Collenteur'
 
 # The full version, including alpha/beta/rc tags
@@ -62,9 +66,8 @@
     'sphinx.ext.viewcode',
     'IPython.sphinxext.ipython_console_highlighting',  # lowercase didn't work
     'sphinx.ext.autosectionlabel',
-    'nbsphinx',
-    'nbsphinx_link',
-    'sphinxcontrib.bibtex'
+    'sphinxcontrib.bibtex',
+    'myst_nb',
 ]
 
 # Create custom bracket style with round brackets
@@ -140,3 +143,8 @@ class MyReferenceStyle(AuthorYearReferenceStyle):
     "python": ("https://docs.python.org/3/", None),
     "xarray": ("https://docs.xarray.dev/en/stable/", None),
 }
+
+# -- myst_nb options ------------------------------------------------------------------
+
+nb_execution_allow_errors = True  # Allow errors in notebooks, to see the error online
+nb_execution_mode = "auto"
diff --git a/docs/examples/01_example_zamg.ipynb b/docs/examples/01_example_zamg.ipynb
diff --git a/docs/examples/02_example_zamg_netcdf.ipynb b/docs/examples/02_example_zamg_netcdf.ipynb
diff --git a/examples/03_example_knmi.ipynb → docs/examples/03_example_knmi.ipynb b/examples/03_example_knmi.ipynb → docs/examples/03_example_knmi.ipynb
diff --git a/examples/04_example_coagmet.ipynb → docs/examples/04_example_coagmet.ipynb b/examples/04_example_coagmet.ipynb → docs/examples/04_example_coagmet.ipynb
diff --git a/examples/05_example_calibration.ipynb → docs/examples/05_example_calibration.ipynb b/examples/05_example_calibration.ipynb → docs/examples/05_example_calibration.ipynb
diff --git a/...6_worked_examples_McMahon_etal_2013.ipynb → ...6_worked_examples_McMahon_etal_2013.ipynb b/...6_worked_examples_McMahon_etal_2013.ipynb → ...6_worked_examples_McMahon_etal_2013.ipynb
diff --git a/examples/07_example_climate_change.ipynb → .../examples/07_example_climate_change.ipynb b/examples/07_example_climate_change.ipynb → .../examples/07_example_climate_change.ipynb
diff --git a/examples/08_crop_coefficient.ipynb → docs/examples/08_crop_coefficient.ipynb b/examples/08_crop_coefficient.ipynb → docs/examples/08_crop_coefficient.ipynb
diff --git a/examples/09_CMIP6_data.ipynb → docs/examples/09_CMIP6_data.ipynb b/examples/09_CMIP6_data.ipynb → docs/examples/09_CMIP6_data.ipynb
diff --git a/examples/10_example_paper.ipynb → docs/examples/10_example_paper.ipynb b/examples/10_example_paper.ipynb → docs/examples/10_example_paper.ipynb
diff --git a/examples/data/example_1/klima_daily.csv → docs/examples/data/example_1/klima_daily.csv b/examples/data/example_1/klima_daily.csv → docs/examples/data/example_1/klima_daily.csv
diff --git a/...ples/data/example_10/10_example_meteo.csv → ...ples/data/example_10/10_example_meteo.csv b/...ples/data/example_10/10_example_meteo.csv → ...ples/data/example_10/10_example_meteo.csv
diff --git a/...example_10/co2_conc/RCP3PD_MIDYR_CONC.DAT → ...example_10/co2_conc/RCP3PD_MIDYR_CONC.DAT b/...example_10/co2_conc/RCP3PD_MIDYR_CONC.DAT → ...example_10/co2_conc/RCP3PD_MIDYR_CONC.DAT
diff --git a/.../example_10/co2_conc/RCP45_MIDYR_CONC.DAT → .../example_10/co2_conc/RCP45_MIDYR_CONC.DAT b/.../example_10/co2_conc/RCP45_MIDYR_CONC.DAT → .../example_10/co2_conc/RCP45_MIDYR_CONC.DAT
diff --git a/...a/example_10/co2_conc/RCP6_MIDYR_CONC.DAT → ...a/example_10/co2_conc/RCP6_MIDYR_CONC.DAT b/...a/example_10/co2_conc/RCP6_MIDYR_CONC.DAT → ...a/example_10/co2_conc/RCP6_MIDYR_CONC.DAT
diff --git a/.../example_10/co2_conc/RCP85_MIDYR_CONC.DAT → .../example_10/co2_conc/RCP85_MIDYR_CONC.DAT b/.../example_10/co2_conc/RCP85_MIDYR_CONC.DAT → .../example_10/co2_conc/RCP85_MIDYR_CONC.DAT
diff --git a/examples/data/example_10/df_Guo_2016.xlsx → ...examples/data/example_10/df_Guo_2016.xlsx b/examples/data/example_10/df_Guo_2016.xlsx → ...examples/data/example_10/df_Guo_2016.xlsx
diff --git a/...example_10/elev_ens_0.25deg_reg_v25.0e.nc → ...example_10/elev_ens_0.25deg_reg_v25.0e.nc b/...example_10/elev_ens_0.25deg_reg_v25.0e.nc → ...example_10/elev_ens_0.25deg_reg_v25.0e.nc
diff --git a/...10/fg_ens_mean_0.25deg_reg_2018_v25.0e.nc → ...10/fg_ens_mean_0.25deg_reg_2018_v25.0e.nc b/...10/fg_ens_mean_0.25deg_reg_2018_v25.0e.nc → ...10/fg_ens_mean_0.25deg_reg_2018_v25.0e.nc
diff --git a/...10/hu_ens_mean_0.25deg_reg_2018_v25.0e.nc → ...10/hu_ens_mean_0.25deg_reg_2018_v25.0e.nc b/...10/hu_ens_mean_0.25deg_reg_2018_v25.0e.nc → ...10/hu_ens_mean_0.25deg_reg_2018_v25.0e.nc
diff --git a/...10/qq_ens_mean_0.25deg_reg_2018_v25.0e.nc → ...10/qq_ens_mean_0.25deg_reg_2018_v25.0e.nc b/...10/qq_ens_mean_0.25deg_reg_2018_v25.0e.nc → ...10/qq_ens_mean_0.25deg_reg_2018_v25.0e.nc
diff --git a/...acus-daily_19610101T0000_20211231T0000.nc → ...acus-daily_19610101T0000_20211231T0000.nc b/...acus-daily_19610101T0000_20211231T0000.nc → ...acus-daily_19610101T0000_20211231T0000.nc
diff --git a/...le_10/tasAdjust_AUT_AT.ST_area_annual.csv → ...le_10/tasAdjust_AUT_AT.ST_area_annual.csv b/...le_10/tasAdjust_AUT_AT.ST_area_annual.csv → ...le_10/tasAdjust_AUT_AT.ST_area_annual.csv
diff --git a/...10/tg_ens_mean_0.25deg_reg_2018_v25.0e.nc → ...10/tg_ens_mean_0.25deg_reg_2018_v25.0e.nc b/...10/tg_ens_mean_0.25deg_reg_2018_v25.0e.nc → ...10/tg_ens_mean_0.25deg_reg_2018_v25.0e.nc
diff --git a/...10/tn_ens_mean_0.25deg_reg_2018_v25.0e.nc → ...10/tn_ens_mean_0.25deg_reg_2018_v25.0e.nc b/...10/tn_ens_mean_0.25deg_reg_2018_v25.0e.nc → ...10/tn_ens_mean_0.25deg_reg_2018_v25.0e.nc
diff --git a/...10/tx_ens_mean_0.25deg_reg_2018_v25.0e.nc → ...10/tx_ens_mean_0.25deg_reg_2018_v25.0e.nc b/...10/tx_ens_mean_0.25deg_reg_2018_v25.0e.nc → ...10/tx_ens_mean_0.25deg_reg_2018_v25.0e.nc
diff --git a/...cal_hourly_20120501T0000_20120930T2300.nc → ...cal_hourly_20120501T0000_20120930T2300.nc b/...cal_hourly_20120501T0000_20120930T2300.nc → ...cal_hourly_20120501T0000_20120930T2300.nc
diff --git a/examples/data/example_3/etmgeg_260.txt → docs/examples/data/example_3/etmgeg_260.txt b/examples/data/example_3/etmgeg_260.txt → docs/examples/data/example_3/etmgeg_260.txt
diff --git a/examples/data/example_4/et_coagmet.txt → docs/examples/data/example_4/et_coagmet.txt b/examples/data/example_4/et_coagmet.txt → docs/examples/data/example_4/et_coagmet.txt
diff --git a/...4i1p1f1_gr_21000601-21000630_v20200425.nc → ...4i1p1f1_gr_21000601-21000630_v20200425.nc b/...4i1p1f1_gr_21000601-21000630_v20200425.nc → ...4i1p1f1_gr_21000601-21000630_v20200425.nc
diff --git a/examples/utils.py → docs/examples/utils.py b/examples/utils.py → docs/examples/utils.py
diff --git a/examples/01_example_zamg.ipynb b/examples/01_example_zamg.ipynb