Skip to content

Commit

Permalink
Update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xylar committed Dec 25, 2024
1 parent 145d6b6 commit ab0df16
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 15 deletions.
2 changes: 2 additions & 0 deletions docs/developers_guide/ocean/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@
viz.Viz
viz.Viz.run
decomp.Decomp
restart.Restart
restart.RestartStep
Expand Down
7 changes: 7 additions & 0 deletions docs/developers_guide/ocean/tasks/cosine_bell.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@ colorbar_limits = 0.0, 1.0

See {ref}`dev-visualization-global` for more details.

## decomp

The class {py:class}`polaris.ocean.tasks.cosine_bell.decomp.Decomp` defines
a decomposition test across core counts. It runs Cosine Bell test at coarse
resolution once each on 12 and 24 cores to verify bit-for-bit reproducibility
for tracer advection across different core counts.

## restart

The {py:class}`polaris.ocean.tasks.cosine_bell.restart.Restart` class defines
Expand Down
31 changes: 18 additions & 13 deletions docs/users_guide/ocean/suites.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,30 @@ run of the same tasks.

(ocean-suite-cosine-bell)=

## cosine_bell and cosine_bell_cached_init suite
## cosine_bell suite

```bash
polaris suite -c ocean -t cosine_bell ...
```

```bash
polaris suite -c ocean -t cosine_bell_cached_init ...
```

Both `cosine_bell` suites include the following tasks:
The `cosine_bell` suite includes the following tasks:

```none
ocean/global_convergence/icos/cosine_bell
ocean/global_convergence/qu/cosine_bell
ocean/spherical/icos/cosine_bell/convergence_space
ocean/spherical/icos/cosine_bell/convergence_space/with_viz
ocean/spherical/icos/cosine_bell/convergence_time
ocean/spherical/icos/cosine_bell/convergence_time/with_viz
ocean/spherical/icos/cosine_bell/convergence_both
ocean/spherical/icos/cosine_bell/convergence_both/with_viz
ocean/spherical/icos/cosine_bell/decomp
ocean/spherical/icos/cosine_bell/restart
ocean/spherical/qu/cosine_bell/convergence_space
ocean/spherical/qu/cosine_bell/convergence_space/with_viz
ocean/spherical/qu/cosine_bell/convergence_time
ocean/spherical/qu/cosine_bell/convergence_time/with_viz
ocean/spherical/qu/cosine_bell/convergence_both
ocean/spherical/qu/cosine_bell/convergence_both/with_viz
ocean/spherical/qu/cosine_bell/decomp
ocean/spherical/qu/cosine_bell/restart
```

The `cosine_bell` suite runs both tasks from
{ref}`ocean-cosine-bell` in full, whereas the
`cosine_bell_cached_init` suite only runs the ocean simulations from as set
of meshes and initial conditions that have been saved from a previous run
(see {ref}`dev-cache`).
11 changes: 9 additions & 2 deletions docs/users_guide/ocean/tasks/cosine_bell.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,12 @@ and final state on a lat-lon grid for each resolution. The visualization is
not included in the other versions of the task in order to not slow down
regression testing.

Another task, `cosine_bell/restart`, performs two time steps of the Cosine Bell
Another task, `cosine_bell/decomp`, performs two runs of the Cosine Bell
test at coarse resolution, once with 12 and once with 24 cores, to verify the
bit-for-bit identical results for tracer advection across different core
counts.

A final task, `cosine_bell/restart`, performs two time steps of the Cosine Bell
test at coarse resolution, then performs reruns the second time step,
as a restart run to verify the bit-for-bit restart capability for tracer
advection.
Expand All @@ -51,13 +56,15 @@ ocean/spherical/icos/cosine_bell/convergence_time
ocean/spherical/icos/cosine_bell/convergence_time/with_viz
ocean/spherical/icos/cosine_bell/convergence_both
ocean/spherical/icos/cosine_bell/convergence_both/with_viz
ocean/spherical/icos/cosine_bell/decomp
ocean/spherical/icos/cosine_bell/restart
ocean/spherical/qu/cosine_bell/convergence_space
ocean/spherical/qu/cosine_bell/convergence_space/with_viz
ocean/spherical/qu/cosine_bell/convergence_time
ocean/spherical/qu/cosine_bell/convergence_time/with_viz
ocean/spherical/qu/cosine_bell/convergence_both
ocean/spherical/qu/cosine_bell/convergence_both/with_viz
ocean/spherical/icos/cosine_bell/decomp
ocean/spherical/qu/cosine_bell/restart
```
The default resolutions used in the task depends on the mesh type.
Expand Down Expand Up @@ -99,7 +106,7 @@ your own config file (or add a `spherical_convergence` section to a config file
if you're already using one). The resolutions are a comma-separated list of
the resolution of the mesh in km. If you specify a different list
before setting up `cosine_bell`, steps will be generated with the requested
resolutions. (If you alter `icos_resolutions` or `qu_resolutions`) in the
resolutions. (If you alter `icos_resolutions` or `qu_resolutions` in the
task's config file in the work directory, nothing will happen.) For `icos`
meshes, make sure you use a resolution close to those listed in
{ref}`dev-spherical-meshes`. Each resolution will be rounded to the nearest
Expand Down

0 comments on commit ab0df16

Please sign in to comment.