Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes to polaris suite and geostrophic docs #137

Merged
merged 3 commits into from
Oct 17, 2023
Merged

Fixes to polaris suite and geostrophic docs #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c312a0
Remove `-s` flag from `polaris suite` in docs
xylar Oct 17, 2023
5cbb35d
Fix Geostrophic API
xylar Oct 17, 2023
4755f37
Fix incomplete analysis description for geostrophic
xylar Oct 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/developers_guide/deploying_spack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/developers_guide/ocean/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 6 additions & 1 deletion docs/developers_guide/ocean/tasks/geostrophic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/users_guide/quick_start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down