From c0dfc85641dd801396aa189bb0c2ee318dcfe9f1 Mon Sep 17 00:00:00 2001 From: Teagan King Date: Thu, 21 Nov 2024 11:30:49 -0700 Subject: [PATCH] move nblibrary out of examples --- docs/addingnotebookstocollection.md | 2 +- examples/coupled_model/config.yml | 2 +- examples/external_diag_packages/config.yml | 2 +- examples/key_metrics/config.yml | 2 +- helper_scripts/generate_adf_config_file.py | 2 +- helper_scripts/generate_cupid_config_for_cesm_case.py | 2 +- {examples/nblibrary => nblibrary}/.gitignore | 0 .../atm/Global_PSL_NMSE_compare_obs_lens.ipynb | 0 {examples/nblibrary => nblibrary}/atm/adf_quick_run.ipynb | 0 {examples/nblibrary => nblibrary}/atm/averaging_utils.py | 0 ...onfig_f.cam6_3_119.FLTHIST_ne30.r328_gamma0.33_soae.001.yaml | 0 {examples/nblibrary => nblibrary}/atm/link_to_ADF.ipynb | 0 {examples/nblibrary => nblibrary}/atm/nmse_utils.py | 0 .../glc/Greenland_SMB_visual_compare_obs.ipynb | 0 {examples/nblibrary => nblibrary}/glc/utils.py | 0 {examples/nblibrary => nblibrary}/ice/cice_masks.yml | 0 {examples/nblibrary => nblibrary}/ice/cice_vars.yml | 0 {examples/nblibrary => nblibrary}/ice/plot_diff.py | 0 {examples/nblibrary => nblibrary}/ice/seaice.ipynb | 0 {examples/nblibrary => nblibrary}/ice/vect_diff.py | 0 {examples/nblibrary => nblibrary}/infrastructure/index.ipynb | 0 .../lnd/Global_TerrestrialCouplingIndex_VisualCompareObs.ipynb | 0 {examples/nblibrary => nblibrary}/lnd/land_comparison.ipynb | 0 {examples/nblibrary => nblibrary}/ocn/ocean_surface.ipynb | 0 .../rof/global_discharge_gauge_compare_obs.ipynb | 0 .../rof/global_discharge_ocean_compare_obs.ipynb | 0 {examples/nblibrary => nblibrary}/rof/scripts/colors.py | 0 {examples/nblibrary => nblibrary}/rof/scripts/metrics.py | 0 {examples/nblibrary => nblibrary}/rof/scripts/utility.py | 0 {examples/nblibrary => nblibrary}/rof/setup/large_river_50.txt | 0 {examples/nblibrary => nblibrary}/rof/setup/setup.yaml | 0 31 files changed, 6 insertions(+), 6 deletions(-) rename {examples/nblibrary => nblibrary}/.gitignore (100%) rename {examples/nblibrary => nblibrary}/atm/Global_PSL_NMSE_compare_obs_lens.ipynb (100%) rename {examples/nblibrary => nblibrary}/atm/adf_quick_run.ipynb (100%) rename {examples/nblibrary => nblibrary}/atm/averaging_utils.py (100%) rename {examples/nblibrary => nblibrary}/atm/config_f.cam6_3_119.FLTHIST_ne30.r328_gamma0.33_soae.001.yaml (100%) rename {examples/nblibrary => nblibrary}/atm/link_to_ADF.ipynb (100%) rename {examples/nblibrary => nblibrary}/atm/nmse_utils.py (100%) rename {examples/nblibrary => nblibrary}/glc/Greenland_SMB_visual_compare_obs.ipynb (100%) rename {examples/nblibrary => nblibrary}/glc/utils.py (100%) rename {examples/nblibrary => nblibrary}/ice/cice_masks.yml (100%) rename {examples/nblibrary => nblibrary}/ice/cice_vars.yml (100%) rename {examples/nblibrary => nblibrary}/ice/plot_diff.py (100%) rename {examples/nblibrary => nblibrary}/ice/seaice.ipynb (100%) rename {examples/nblibrary => nblibrary}/ice/vect_diff.py (100%) rename {examples/nblibrary => nblibrary}/infrastructure/index.ipynb (100%) rename {examples/nblibrary => nblibrary}/lnd/Global_TerrestrialCouplingIndex_VisualCompareObs.ipynb (100%) rename {examples/nblibrary => nblibrary}/lnd/land_comparison.ipynb (100%) rename {examples/nblibrary => nblibrary}/ocn/ocean_surface.ipynb (100%) rename {examples/nblibrary => nblibrary}/rof/global_discharge_gauge_compare_obs.ipynb (100%) rename {examples/nblibrary => nblibrary}/rof/global_discharge_ocean_compare_obs.ipynb (100%) rename {examples/nblibrary => nblibrary}/rof/scripts/colors.py (100%) rename {examples/nblibrary => nblibrary}/rof/scripts/metrics.py (100%) rename {examples/nblibrary => nblibrary}/rof/scripts/utility.py (100%) rename {examples/nblibrary => nblibrary}/rof/setup/large_river_50.txt (100%) rename {examples/nblibrary => nblibrary}/rof/setup/setup.yaml (100%) diff --git a/docs/addingnotebookstocollection.md b/docs/addingnotebookstocollection.md index 9ef0a4b..5ff9e0d 100644 --- a/docs/addingnotebookstocollection.md +++ b/docs/addingnotebookstocollection.md @@ -15,7 +15,7 @@ Generally, a good fit for a diagnostic notebook is one that reads in CESM output --- **If you want to run your notebook through the `CUPiD` workflow yourself, follow the rest of the instructions:** -4. Move your new diagnostic notebook to the folder called `examples/nblibrary`. +4. Move your new diagnostic notebook to the folder called `nblibrary`. 5. Open `config.yml`. First, add your new notebook (as its name, minus the `.ipynb`) to the list of notebooks that will be computed (`compute_notebooks`). The notebooks will be executed in the order they are listed here. For example: diff --git a/examples/coupled_model/config.yml b/examples/coupled_model/config.yml index ac3e83a..42fd8d5 100644 --- a/examples/coupled_model/config.yml +++ b/examples/coupled_model/config.yml @@ -17,7 +17,7 @@ data_sources: ### look for your template notebooks in. It doesn't have to ### be inside run_dir, or be specific to this project, as ### long as the notebooks are there - nb_path_root: ../nblibrary + nb_path_root: nblibrary ###################### # Computation Config # diff --git a/examples/external_diag_packages/config.yml b/examples/external_diag_packages/config.yml index a9d7327..3e99304 100644 --- a/examples/external_diag_packages/config.yml +++ b/examples/external_diag_packages/config.yml @@ -17,7 +17,7 @@ data_sources: ### look for your template notebooks in. It doesn't have to ### be inside run_dir, or be specific to this project, as ### long as the notebooks are there - nb_path_root: ../nblibrary + nb_path_root: nblibrary ###################### # Computation Config # diff --git a/examples/key_metrics/config.yml b/examples/key_metrics/config.yml index d6eb0a3..48273df 100644 --- a/examples/key_metrics/config.yml +++ b/examples/key_metrics/config.yml @@ -17,7 +17,7 @@ data_sources: ### look for your template notebooks in. It doesn't have to ### be inside run_dir, or be specific to this project, as ### long as the notebooks are there - nb_path_root: ../nblibrary + nb_path_root: nblibrary ###################### # Computation Config # diff --git a/helper_scripts/generate_adf_config_file.py b/helper_scripts/generate_adf_config_file.py index 810ebf9..ddecaba 100755 --- a/helper_scripts/generate_adf_config_file.py +++ b/helper_scripts/generate_adf_config_file.py @@ -58,7 +58,7 @@ def generate_adf_config(cesm_root, cupid_example, adf_file, out_file): valid_examples = [ example for example in next(os.walk(cupid_examples))[1] - if example not in ["ilamb", "nblibrary"] + if example not in ["ilamb"] ] if cupid_example not in valid_examples: error_msg = f"argument --cupid-example: invalid choice '{cupid_example}'" diff --git a/helper_scripts/generate_cupid_config_for_cesm_case.py b/helper_scripts/generate_cupid_config_for_cesm_case.py index 4edb075..74edfce 100755 --- a/helper_scripts/generate_cupid_config_for_cesm_case.py +++ b/helper_scripts/generate_cupid_config_for_cesm_case.py @@ -95,7 +95,7 @@ def generate_cupid_config(case_root, cesm_root, cupid_example): valid_examples = [ example for example in next(os.walk(cupid_examples))[1] - if example not in ["ilamb", "nblibrary"] + if example not in ["ilamb"] ] if cupid_example not in valid_examples: error_msg = f"argument --cupid-example: invalid choice '{cupid_example}'" diff --git a/examples/nblibrary/.gitignore b/nblibrary/.gitignore similarity index 100% rename from examples/nblibrary/.gitignore rename to nblibrary/.gitignore diff --git a/examples/nblibrary/atm/Global_PSL_NMSE_compare_obs_lens.ipynb b/nblibrary/atm/Global_PSL_NMSE_compare_obs_lens.ipynb similarity index 100% rename from examples/nblibrary/atm/Global_PSL_NMSE_compare_obs_lens.ipynb rename to nblibrary/atm/Global_PSL_NMSE_compare_obs_lens.ipynb diff --git a/examples/nblibrary/atm/adf_quick_run.ipynb b/nblibrary/atm/adf_quick_run.ipynb similarity index 100% rename from examples/nblibrary/atm/adf_quick_run.ipynb rename to nblibrary/atm/adf_quick_run.ipynb diff --git a/examples/nblibrary/atm/averaging_utils.py b/nblibrary/atm/averaging_utils.py similarity index 100% rename from examples/nblibrary/atm/averaging_utils.py rename to nblibrary/atm/averaging_utils.py diff --git a/examples/nblibrary/atm/config_f.cam6_3_119.FLTHIST_ne30.r328_gamma0.33_soae.001.yaml b/nblibrary/atm/config_f.cam6_3_119.FLTHIST_ne30.r328_gamma0.33_soae.001.yaml similarity index 100% rename from examples/nblibrary/atm/config_f.cam6_3_119.FLTHIST_ne30.r328_gamma0.33_soae.001.yaml rename to nblibrary/atm/config_f.cam6_3_119.FLTHIST_ne30.r328_gamma0.33_soae.001.yaml diff --git a/examples/nblibrary/atm/link_to_ADF.ipynb b/nblibrary/atm/link_to_ADF.ipynb similarity index 100% rename from examples/nblibrary/atm/link_to_ADF.ipynb rename to nblibrary/atm/link_to_ADF.ipynb diff --git a/examples/nblibrary/atm/nmse_utils.py b/nblibrary/atm/nmse_utils.py similarity index 100% rename from examples/nblibrary/atm/nmse_utils.py rename to nblibrary/atm/nmse_utils.py diff --git a/examples/nblibrary/glc/Greenland_SMB_visual_compare_obs.ipynb b/nblibrary/glc/Greenland_SMB_visual_compare_obs.ipynb similarity index 100% rename from examples/nblibrary/glc/Greenland_SMB_visual_compare_obs.ipynb rename to nblibrary/glc/Greenland_SMB_visual_compare_obs.ipynb diff --git a/examples/nblibrary/glc/utils.py b/nblibrary/glc/utils.py similarity index 100% rename from examples/nblibrary/glc/utils.py rename to nblibrary/glc/utils.py diff --git a/examples/nblibrary/ice/cice_masks.yml b/nblibrary/ice/cice_masks.yml similarity index 100% rename from examples/nblibrary/ice/cice_masks.yml rename to nblibrary/ice/cice_masks.yml diff --git a/examples/nblibrary/ice/cice_vars.yml b/nblibrary/ice/cice_vars.yml similarity index 100% rename from examples/nblibrary/ice/cice_vars.yml rename to nblibrary/ice/cice_vars.yml diff --git a/examples/nblibrary/ice/plot_diff.py b/nblibrary/ice/plot_diff.py similarity index 100% rename from examples/nblibrary/ice/plot_diff.py rename to nblibrary/ice/plot_diff.py diff --git a/examples/nblibrary/ice/seaice.ipynb b/nblibrary/ice/seaice.ipynb similarity index 100% rename from examples/nblibrary/ice/seaice.ipynb rename to nblibrary/ice/seaice.ipynb diff --git a/examples/nblibrary/ice/vect_diff.py b/nblibrary/ice/vect_diff.py similarity index 100% rename from examples/nblibrary/ice/vect_diff.py rename to nblibrary/ice/vect_diff.py diff --git a/examples/nblibrary/infrastructure/index.ipynb b/nblibrary/infrastructure/index.ipynb similarity index 100% rename from examples/nblibrary/infrastructure/index.ipynb rename to nblibrary/infrastructure/index.ipynb diff --git a/examples/nblibrary/lnd/Global_TerrestrialCouplingIndex_VisualCompareObs.ipynb b/nblibrary/lnd/Global_TerrestrialCouplingIndex_VisualCompareObs.ipynb similarity index 100% rename from examples/nblibrary/lnd/Global_TerrestrialCouplingIndex_VisualCompareObs.ipynb rename to nblibrary/lnd/Global_TerrestrialCouplingIndex_VisualCompareObs.ipynb diff --git a/examples/nblibrary/lnd/land_comparison.ipynb b/nblibrary/lnd/land_comparison.ipynb similarity index 100% rename from examples/nblibrary/lnd/land_comparison.ipynb rename to nblibrary/lnd/land_comparison.ipynb diff --git a/examples/nblibrary/ocn/ocean_surface.ipynb b/nblibrary/ocn/ocean_surface.ipynb similarity index 100% rename from examples/nblibrary/ocn/ocean_surface.ipynb rename to nblibrary/ocn/ocean_surface.ipynb diff --git a/examples/nblibrary/rof/global_discharge_gauge_compare_obs.ipynb b/nblibrary/rof/global_discharge_gauge_compare_obs.ipynb similarity index 100% rename from examples/nblibrary/rof/global_discharge_gauge_compare_obs.ipynb rename to nblibrary/rof/global_discharge_gauge_compare_obs.ipynb diff --git a/examples/nblibrary/rof/global_discharge_ocean_compare_obs.ipynb b/nblibrary/rof/global_discharge_ocean_compare_obs.ipynb similarity index 100% rename from examples/nblibrary/rof/global_discharge_ocean_compare_obs.ipynb rename to nblibrary/rof/global_discharge_ocean_compare_obs.ipynb diff --git a/examples/nblibrary/rof/scripts/colors.py b/nblibrary/rof/scripts/colors.py similarity index 100% rename from examples/nblibrary/rof/scripts/colors.py rename to nblibrary/rof/scripts/colors.py diff --git a/examples/nblibrary/rof/scripts/metrics.py b/nblibrary/rof/scripts/metrics.py similarity index 100% rename from examples/nblibrary/rof/scripts/metrics.py rename to nblibrary/rof/scripts/metrics.py diff --git a/examples/nblibrary/rof/scripts/utility.py b/nblibrary/rof/scripts/utility.py similarity index 100% rename from examples/nblibrary/rof/scripts/utility.py rename to nblibrary/rof/scripts/utility.py diff --git a/examples/nblibrary/rof/setup/large_river_50.txt b/nblibrary/rof/setup/large_river_50.txt similarity index 100% rename from examples/nblibrary/rof/setup/large_river_50.txt rename to nblibrary/rof/setup/large_river_50.txt diff --git a/examples/nblibrary/rof/setup/setup.yaml b/nblibrary/rof/setup/setup.yaml similarity index 100% rename from examples/nblibrary/rof/setup/setup.yaml rename to nblibrary/rof/setup/setup.yaml