clarify readmes & break down into more specific readme for each section

NCAR · Sep 20, 2023 · 0c2ab18 · 0c2ab18
1 parent 52c4d2f
commit 0c2ab18
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -80,25 +80,13 @@ This gives you a local copy of the material you'll need for the tutorial
 - Click on the `notebooks` directory
 - Click on the `Day0a_GitStarted.ipynb` notebook in the sidebar of your JupyterLab window.
 
-## Notebook Table of Contents
- - GettingStarted: These notebooks are the building blocks for all additional notebooks.
-     - 1_NEON_Simulation_Tutorial.ipynb : This notebook shows how to run a NEON simulation
-     - 2_NEON_Simulation_Visualization.ipynb : This notebook shows how to visualize NEON simulation output
- - ProjectExamples: These notebooks are project-specific and build upon the GettingStarted notebooks
-     - Basic_CTSM-NEON_Plots.ipynb : This notebook shows how to create plots from NEON data, as well as perform time averaging, etc
-     - CTSMsp_NEON_fromScratch.ipynb : This notebook focuses on using CTSM with satellite phenology
-     - Clone_Case.ipynb : This notebook shares how to clone a case
-     - FATES_NEON_fromScratch.ipynb : This notebook works on creating a FATES case from scratch with NEON
-     - Plot_flux_climatology.ipynb : This notebook provides climatology plotting examples
-     - QuickPlot_CTSM-FATESsp.ipynb : This notebook provides plotting tools for use with FATES run with satellite phenology
-     - QuickPlot_CTSM_h0.ipynb : This plots monthly CTSM data
-     - QuickPlot_CTSM_spinup.ipynb : This plots CTSM cases that have been spun up
-     - customizeCase_PRISM.ipynb : This customizes a case to use PRISM precipitation input data
-     - customizeCase_modelFeatures.ipynb : This customizes various model features
-     - customizeCase_parameterModifications.ipynb : This notebook provides tools for parameter modifications and takes input that is generated from modifyParameterFile.ipynb
-     - modifyParameterFile.ipynb : This notebook modifies a parameter file that can then be used by customizeCase_parameterModifications.ipynb
-     - modifySurfdataFile.ipynb : This notebook modifies a surface data file that can then be used by customizeCase_modelFeatures.ipynb
- - ContributedNotebooks: These notebooks are contributed by workshop participants who dove further into a particular project.
+## Notebook Table of Contents (Note: see individual section README.md files for more details on each section)
+ - Global: These tutorials focus on cases that are run globally.
+ - SinglePoint: These tutorials focus on cases that are run at a single point.
+     - GettingStarted: These notebooks are the building blocks for all additional notebooks.
+     - BuildingBlocks: These notebooks are intended as tools that you can add to your toolbox to better understand details from ProjectExamples.
+     - ProjectExamples: These notebooks are project-specific and build upon the GettingStarted notebooks
+     - ContributedNotebooks: These notebooks are contributed by workshop participants who dove further into a particular project.
 
 ## 📚 Resources
 

diff --git a/notebooks/Global/README.md b/notebooks/Global/README.md
@@ -0,0 +1 @@
+Use the notebooks in this section to run a global case.
diff --git a/notebooks/SinglePoint/BuildingBlocks/README.md b/notebooks/SinglePoint/BuildingBlocks/README.md
@@ -0,0 +1 @@
+These tutorials are intended to be used to support users in having additional tools in their toolbox that will contribute to larger projects such as those in ProjectExamples.
diff --git a/...glePoint/1_NEON_Simulation_Tutorial.ipynb → ...gStarted/1_NEON_Simulation_Tutorial.ipynb b/...glePoint/1_NEON_Simulation_Tutorial.ipynb → ...gStarted/1_NEON_Simulation_Tutorial.ipynb
diff --git a/...int/2_NEON_Simulation_Visualization.ipynb → ...ted/2_NEON_Simulation_Visualization.ipynb b/...int/2_NEON_Simulation_Visualization.ipynb → ...ted/2_NEON_Simulation_Visualization.ipynb
diff --git a/notebooks/SinglePoint/GettingStarted/README.md b/notebooks/SinglePoint/GettingStarted/README.md
@@ -0,0 +1,3 @@
+These notebooks are the building blocks for all additional notebooks.
+     - 1_NEON_Simulation_Tutorial.ipynb : This notebook shows how to run a NEON simulation
+     - 2_NEON_Simulation_Visualization.ipynb : This notebook shows how to visualize NEON simulation output
diff --git a/notebooks/SinglePoint/ProjectExamples/README.md b/notebooks/SinglePoint/ProjectExamples/README.md
@@ -0,0 +1,14 @@
+These notebooks are project-specific and build upon the GettingStarted notebooks. They reference skills learned through the BuildingBlocks Notebooks.
+     - Basic_CTSM-NEON_Plots.ipynb : This notebook shows how to create plots from NEON data, as well as perform time averaging, etc
+     - CTSMsp_NEON_fromScratch.ipynb : This notebook focuses on using CTSM with satellite phenology
+     - Clone_Case.ipynb : This notebook shares how to clone a case
+     - FATES_NEON_fromScratch.ipynb : This notebook works on creating a FATES case from scratch with NEON
+     - Plot_flux_climatology.ipynb : This notebook provides climatology plotting examples
+     - QuickPlot_CTSM-FATESsp.ipynb : This notebook provides plotting tools for use with FATES run with satellite phenology
+     - QuickPlot_CTSM_h0.ipynb : This plots monthly CTSM data
+     - QuickPlot_CTSM_spinup.ipynb : This plots CTSM cases that have been spun up
+     - customizeCase_PRISM.ipynb : This customizes a case to use PRISM precipitation input data
+     - customizeCase_modelFeatures.ipynb : This customizes various model features
+     - customizeCase_parameterModifications.ipynb : This notebook provides tools for parameter modifications and takes input that is generated from modifyParameterFile.ipynb
+     - modifyParameterFile.ipynb : This notebook modifies a parameter file that can then be used by customizeCase_parameterModifications.ipynb
+     - modifySurfdataFile.ipynb : This notebook modifies a surface data file that can then be used by customizeCase_modelFeatures.ipynb