Merge pull request #137 from xylar/fix-polaris-suite-docs

Fixes to `polaris suite` and `geostrophic` docs
E3SM-Project · Oct 17, 2023 · 519e63c · 519e63c
2 parents d1db9b5 + 4755f37
commit 519e63c
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 7 deletions.
diff --git a/docs/developers_guide/deploying_spack.md b/docs/developers_guide/deploying_spack.md
@@ -293,7 +293,7 @@ git submodule update --init --recursive
 cd E3SM-Project/components/mpas-ocean
 # this will build with PIO and OpenMP
 make ifort
-polaris suite -s -c ocean -t pr -p . \
+polaris suite -c ocean -t pr -p . \
     -w /lcrc/group/e3sm/ac.xylar/polaris/test_20230202/ocean_pr_chrys_intel_openmpi
 cd /lcrc/group/e3sm/ac.xylar/polaris/test_20230202/ocean_pr_chrys_intel_openmpi
 sbatch job_script.pr.bash
@@ -311,7 +311,7 @@ cd ../e3sm_chrys_gnu_openmpi
 git submodule update --init --recursive
 cd components/mpas-ocean
 make gfortran
-polaris suite -s -c ocean -t pr -p . \
+polaris suite -c ocean -t pr -p . \
     -w /lcrc/group/e3sm/ac.xylar/polaris/test_20230202/ocean_pr_chrys_gnu_openmpi
 cd /lcrc/group/e3sm/ac.xylar/polaris/test_20230202/ocean_pr_chrys_gnu_openmpi
 sbatch job_script.pr.bash
@@ -334,7 +334,7 @@ git submodule update --init --recursive
 cd MALI-Dev/components/mpas-albany-landice
 # you need to tell it to build with Albany
 make ALBANY=true gfortran
-polaris suite -s -c landice -t full_integration -p . \
+polaris suite -c landice -t full_integration -p . \
     -w /lcrc/group/e3sm/ac.xylar/polaris/test_20230202/landice_full_chrys_gnu_openmpi
 cd /lcrc/group/e3sm/ac.xylar/polaris/test_20230202/landice_full_chrys_gnu_openmpi
 sbatch job_script.full_integration.bash

diff --git a/docs/developers_guide/ocean/api.md b/docs/developers_guide/ocean/api.md
@@ -132,8 +132,8 @@
    forward.Forward
 
    analysis.Analysis
-   analysis.Analysis.run
-   analysis.Analysis.compute_rmse
+   analysis.Analysis.exact_solution
+   analysis.Analysis.get_output_field
 
    viz.VizMap
    viz.VizMap.run

diff --git a/docs/developers_guide/ocean/tasks/geostrophic.md b/docs/developers_guide/ocean/tasks/geostrophic.md
@@ -43,7 +43,12 @@ section.  Other model config options are taken from `forward.yaml`.
 ### analysis
 
 The class {py:class}`polaris.ocean.tasks.geostrophic.analysis.Analysis`
-defines a step for 
+descends from
+{py:class}`polaris.ocean.convergence.ConvergenceAnalysis`,
+and defines a step for computing the error norm (L2) for the water-column
+thickness and normal velocity at each resolution, saving them in
+`convergence_h.csv` and `convergence_normalVelocity.csv`, and plotting them
+in `convergence_h.png` and `convergence_normalVelocity.png`.
 
 ### viz
 

diff --git a/docs/users_guide/quick_start.md b/docs/users_guide/quick_start.md
@@ -432,7 +432,7 @@ Suites:
 You can set up a suite as follows:
 
 ```bash
-polaris suite -s -c ocean -t nightly -w <workdir> -p <component_path>
+polaris suite -c ocean -t nightly -w <workdir> -p <component_path>
 ```
 
 where the details are similar to setting up a case. You can use the same