Updated directory name for notebooks

British-Oceanographic-Data-Centre · Oct 31, 2023 · aaa01c6 · aaa01c6
1 parent a916dc5
commit aaa01c6
Show file tree

Hide file tree

Showing 22 changed files with 11 additions and 11 deletions.
diff --git a/.github/workflows/push_notebooks.yml b/.github/workflows/push_notebooks.yml
@@ -4,7 +4,7 @@ on:
   push:
     branches: develop
     paths:
-      - example_scripts/notebooks/**
+      - example_scripts/notebook_tutorials/**
 jobs:
   push-notebooks:
     runs-on: ubuntu-latest

diff --git a/.gitignore b/.gitignore
@@ -33,6 +33,6 @@ docs/source/generated/
 
 docstring2md.log
 
-example_scripts/notebooks/markdown/*
+example_scripts/notebook_tutorials/markdown/*
 
 markdown/
diff --git a/...ebooks/altimetry/altimetry_tutorial.ipynb → ...ebooks/altimetry/altimetry_tutorial.ipynb b/...ebooks/altimetry/altimetry_tutorial.ipynb → ...ebooks/altimetry/altimetry_tutorial.ipynb
diff --git a/...ebooks/general/climatology_tutorial.ipynb → ...ebooks/general/climatology_tutorial.ipynb b/...ebooks/general/climatology_tutorial.ipynb → ...ebooks/general/climatology_tutorial.ipynb
diff --git a/...eral/dask_wrapper_template_tutorial.ipynb → ...eral/dask_wrapper_template_tutorial.ipynb b/...eral/dask_wrapper_template_tutorial.ipynb → ...eral/dask_wrapper_template_tutorial.ipynb
diff --git a/...able_notebooks/general/eof_tutorial.ipynb → ...able_notebooks/general/eof_tutorial.ipynb b/...able_notebooks/general/eof_tutorial.ipynb → ...able_notebooks/general/eof_tutorial.ipynb
diff --git a/...s/general/export_to_netcdf_tutorial.ipynb → ...s/general/export_to_netcdf_tutorial.ipynb b/...s/general/export_to_netcdf_tutorial.ipynb → ...s/general/export_to_netcdf_tutorial.ipynb
diff --git a/...tebooks/general/mask_maker_tutorial.ipynb → ...tebooks/general/mask_maker_tutorial.ipynb b/...tebooks/general/mask_maker_tutorial.ipynb → ...tebooks/general/mask_maker_tutorial.ipynb
diff --git a/...oks/general/seasonal_decomp_example.ipynb → ...oks/general/seasonal_decomp_example.ipynb b/...oks/general/seasonal_decomp_example.ipynb → ...oks/general/seasonal_decomp_example.ipynb
diff --git a/..._notebooks/gridded/contour_tutorial.ipynb → ..._notebooks/gridded/contour_tutorial.ipynb b/..._notebooks/gridded/contour_tutorial.ipynb → ..._notebooks/gridded/contour_tutorial.ipynb
diff --git a/...idded/introduction_to_gridded_class.ipynb → ...idded/introduction_to_gridded_class.ipynb b/...idded/introduction_to_gridded_class.ipynb → ...idded/introduction_to_gridded_class.ipynb
diff --git a/...s/gridded/potential_energy_tutorial.ipynb → ...s/gridded/potential_energy_tutorial.ipynb b/...s/gridded/potential_energy_tutorial.ipynb → ...s/gridded/potential_energy_tutorial.ipynb
diff --git a/...tebooks/gridded/pycnocline_tutorial.ipynb → ...tebooks/gridded/pycnocline_tutorial.ipynb b/...tebooks/gridded/pycnocline_tutorial.ipynb → ...tebooks/gridded/pycnocline_tutorial.ipynb
diff --git a/...dded/regridding_with_xesmf_tutorial.ipynb → ...dded/regridding_with_xesmf_tutorial.ipynb b/...dded/regridding_with_xesmf_tutorial.ipynb → ...dded/regridding_with_xesmf_tutorial.ipynb
diff --git a/...ed/seasia_dic_example_plot_tutorial.ipynb → ...ed/seasia_dic_example_plot_tutorial.ipynb b/...ed/seasia_dic_example_plot_tutorial.ipynb → ...ed/seasia_dic_example_plot_tutorial.ipynb
diff --git a/...notebooks/gridded/transect_tutorial.ipynb → ...notebooks/gridded/transect_tutorial.ipynb b/...notebooks/gridded/transect_tutorial.ipynb → ...notebooks/gridded/transect_tutorial.ipynb
diff --git a/...ofile/introduction_to_profile_class.ipynb → ...ofile/introduction_to_profile_class.ipynb b/...ofile/introduction_to_profile_class.ipynb → ...ofile/introduction_to_profile_class.ipynb
diff --git a/...ooks/profile/wod_bgc_ragged_example.ipynb → ...ooks/profile/wod_bgc_ragged_example.ipynb b/...ooks/profile/wod_bgc_ragged_example.ipynb → ...ooks/profile/wod_bgc_ragged_example.ipynb
diff --git a/...gauge/tidegauge_validation_tutorial.ipynb → ...gauge/tidegauge_validation_tutorial.ipynb b/...gauge/tidegauge_validation_tutorial.ipynb → ...gauge/tidegauge_validation_tutorial.ipynb
diff --git a/...ebooks/tidegauge/tidetable_tutorial.ipynb → ...ebooks/tidegauge/tidetable_tutorial.ipynb b/...ebooks/tidegauge/tidetable_tutorial.ipynb → ...ebooks/tidegauge/tidetable_tutorial.ipynb
diff --git a/notebook_to_md.sh b/notebook_to_md.sh
@@ -5,18 +5,18 @@ directory=$1
 
 # Convert ipynb files to markdown.
 echo "starting notebook execute for ${directory}"
-jupyter nbconvert --to notebook --execute example_scripts/notebooks/runnable_notebooks/${directory}/*.ipynb --allow-errors --output-dir example_scripts/notebooks/runnable_notebooks/executed/${directory}/
+jupyter nbconvert --to notebook --execute example_scripts/notebook_tutorials/runnable_notebooks/${directory}/*.ipynb --allow-errors --output-dir example_scripts/notebook_tutorials/runnable_notebooks/executed/${directory}/
 echo "starting notebook convert"
-jupyter nbconvert --to markdown example_scripts/notebooks/runnable_notebooks/executed/${directory}/*.ipynb --output-dir example_scripts/notebooks/markdown/${directory}/
+jupyter nbconvert --to markdown example_scripts/notebook_tutorials/runnable_notebooks/executed/${directory}/*.ipynb --output-dir example_scripts/notebook_tutorials/markdown/${directory}/
 echo "starting clean up (rm)"
-#rm -rf example_scripts/notebooks/runnable_notebooks/executed/${directory}  # Delete temp executed notebook dir.
-#rm -rf example_scripts/notebooks/runnable_notebooks/${directory}/*.nc  # Delete output nc files.
+#rm -rf example_scripts/notebook_tutorials/runnable_notebooks/executed/${directory}  # Delete temp executed notebook dir.
+#rm -rf example_scripts/notebook_tutorials/runnable_notebooks/${directory}/*.nc  # Delete output nc files.
 
-mkdir -p example_scripts/notebooks/markdown_images/${directory}/ # image folder
+mkdir -p example_scripts/notebook_tutorials/markdown_images/${directory}/ # image folder
 
 echo "starting loop"
 # Loop through generated markdown files.
-for FILE in $(find example_scripts/notebooks/markdown/${directory} -name '*.md'); do
+for FILE in $(find example_scripts/notebook_tutorials/markdown/${directory} -name '*.md'); do
     # Get filename information.
     fullname=$(basename $FILE)
     filename=${fullname%.*}
@@ -37,7 +37,7 @@ EOM
     # Echo hugo header to beginning of generated md file.
     echo "$VAR" | cat - $FILE > temp && mv temp $FILE
     sed -i "s+${filename}_files/+/COAsT/${filename}_files/+g" $FILE
-    [ -d example_scripts/notebooks/markdown/${directory}/${filename}_files ] && mv  example_scripts/notebooks/markdown/${directory}/${filename}_files example_scripts/notebooks/markdown_images/${directory}/
+    [ -d example_scripts/notebook_tutorials/markdown/${directory}/${filename}_files ] && mv  example_scripts/notebook_tutorials/markdown/${directory}/${filename}_files example_scripts/notebook_tutorials/markdown_images/${directory}/
     echo "script is all done"
 done
 
diff --git a/notebooks.dockerfile b/notebooks.dockerfile
@@ -8,6 +8,6 @@ COPY setup.py .
 COPY notebook_to_md.sh .
 RUN python -m pip install .
 COPY example_scripts ./example_scripts
-COPY config ./example_scripts/notebooks/runnable_notebooks/config
-RUN unzip COAsT_example_files.zip && mv COAsT_example_files ./example_scripts/notebooks/runnable_notebooks/example_files
+COPY config ./example_scripts/notebook_tutorials/runnable_notebooks/config
+RUN unzip COAsT_example_files.zip && mv COAsT_example_files ./example_scripts/notebook_tutorials/runnable_notebooks/example_files
 RUN bash notebook_to_md.sh