Skip to content

Commit

Permalink
Standardize styling for all references to Omega
Browse files Browse the repository at this point in the history
  • Loading branch information
altheaden committed Jul 25, 2024
1 parent d04aadd commit 6fdcb02
Show file tree
Hide file tree
Showing 12 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ ocean, land-ice and sea-ice components of the Exascale Energy Earth System
Model ([E3SM](https://e3sm.org/)).

Supported models include:
* [OMEGA](https://github.com/E3SM-Project/Omega) (in early stages of development)
* [Omega](https://github.com/E3SM-Project/Omega) (in early stages of development)
* [MPAS-Albany Land Ice (MALI)](https://mpas-dev.github.io/land_ice/land_ice.html)
* [MPAS-Ocean](https://mpas-dev.github.io/ocean/ocean.html)
* [MPAS-Seaice](https://mpas-dev.github.io/sea_ice/sea_ice.html)
Expand Down
6 changes: 3 additions & 3 deletions docs/developers_guide/command_line.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,8 @@ You can supply the directory where you have built the MPAS component with the
default for the `landice` component is
`e3sm_submodules/MALI-Dev/components/mpas-albany-landice`
and the default for the `ocean` component depends on whether you are using
MPAS-Ocean or OMEGA. For MPAS-Ocean, it is
`e3sm_submodules/E3SM-Project/components/mpas-ocean`. For OMEGA, it is
MPAS-Ocean or Omega. For MPAS-Ocean, it is
`e3sm_submodules/E3SM-Project/components/mpas-ocean`. For Omega, it is
`e3sm_submodules/Omega/components/omega`

You can also supply a config file with config options pointing to the
Expand Down Expand Up @@ -348,5 +348,5 @@ because the compass namelist files don't include the namelist sections,
required by the yaml format. Note that, for the `ocean` component, the `model`
is a keyword that will be added at the top of the yaml file but is ignored when
the yaml file gets parsed, so its value doesn't matter. We recommend using
`omega` since the yaml file is in OMEGA's format, but it will also be usable
`omega` since the yaml file is in Omega's format, but it will also be usable
when the task is configured for MPAS-Ocean.
12 changes: 6 additions & 6 deletions docs/developers_guide/ocean/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ default config options:

```cfg
# This config file has default config options for the ocean component, which
# can either be MPAS-Ocean or OMEGA
# can either be MPAS-Ocean or Omega
# Options related the ocean component
[ocean]
# Which model, MPAS-Ocean or OMEGA, is used
# Which model, MPAS-Ocean or Omega, is used
model = mpas-ocean
Expand All @@ -32,7 +32,7 @@ MPAS-Ocean tasks also have these config options:
[paths]
# the relative or absolute path to the root of a branch where MPAS-Ocean
# or OMEGA has been built
# or Omega has been built
component_path = ${paths:compass_branch}/e3sm_submodules/E3SM-Project/components/mpas-ocean
# The namelists section defines paths to example_compact namelists that will
Expand All @@ -57,7 +57,7 @@ init = ${paths:component_path}/default_inputs/streams.ocean.init
# The executables section defines paths to required executables. These
# executables are provided for use by specific tasks. Most tools that
# compass needs should be in the conda environment, so this is only the path
# to the MPAS-Ocean or OMEGA executable by default.
# to the MPAS-Ocean or Omega executable by default.
[executables]
component = ${paths:component_path}/ocean_model
```
Expand All @@ -72,9 +72,9 @@ of the submodule should always be guaranteed to be compatible with the
corresponding version of polaris.

Similarly, the `e3sm_submodules/Omega` submodule is where you can find
a verison of OMEGA that is compatible with the current polaris. The model
a verison of Omega that is compatible with the current polaris. The model
can be built from the `components/omega` directory. The submodule may not
point to the latest OMEGA code in on the `Omega`
point to the latest Omega code in on the `Omega`
[develop](https://github.com/E3SM-Project/Omega/tree/develop)
branch but, again, the plan is to update the submodule frequently and to
maintain compatibility of the submodule with polaris.
Expand Down
2 changes: 1 addition & 1 deletion docs/developers_guide/organization/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Components

Currently, there are two components, `ocean`, which encompasses all the tasks
for MPAS-Ocean and OMEGA, and `seaice`, which implements tasks for MPAS-Seaice.
for MPAS-Ocean and Omega, and `seaice`, which implements tasks for MPAS-Seaice.

From a developer's perspective, a component is a package within polaris
that has four major pieces:
Expand Down
4 changes: 2 additions & 2 deletions docs/developers_guide/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ git submodule update --init --recursive
```

There are 3 submodules with different versions of E3SM (`E3SM-Project` for
MPAS-Ocean, `OMEGA` for OMEGA and `MALI-Dev` for MALI) in a `e3sm_submodules`
MPAS-Ocean, `Omega` for Omega and `MALI-Dev` for MALI) in a `e3sm_submodules`
directory of the polaris repository.

(dev-conda-env)=
Expand Down Expand Up @@ -487,7 +487,7 @@ For MPAS-Ocean and MALI both, see the last column of the table in
{ref}`dev-supported-machines` for the right `<mpas_make_target>` command for
each machine and compiler.

Instructions for building OMEGA will be added as development proceeds.
Instructions for building Omega will be added as development proceeds.

(dev-working-with-polaris)=

Expand Down
2 changes: 1 addition & 1 deletion docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Compass
Component

: This term refers to the collection of tasks associated with one or more
E3SM components, `ocean` for MPAS-Ocean and OMEGA, `seaice` for MPAS-Seaice,
E3SM components, `ocean` for MPAS-Ocean and Omega, `seaice` for MPAS-Seaice,
and `landice` for MALI.

Step
Expand Down
4 changes: 2 additions & 2 deletions docs/users_guide/ocean/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

The `ocean` component in polaris contains tasks for the
[MPAS-Ocean](https://mpas-dev.github.io/ocean/ocean.html)) and
[OMEGA](https://github.com/E3SM-Project/Omega) components of E3SM. For more
[Omega](https://github.com/E3SM-Project/Omega) components of E3SM. For more
information on MPAS-Ocean, see the most recent
[user's guide](https://doi.org/10.5281/zenodo.1246893) for version 6. OMEGA
[user's guide](https://doi.org/10.5281/zenodo.1246893) for version 6. Omega
is still in the early stages of development, but more information will be
provided in the coming months and years.

Expand Down
10 changes: 5 additions & 5 deletions docs/users_guide/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ For each polaris release, we maintain a
MPI using [spack](https://spack.io/) on our standard machines (Anvil, Chicoma,
Chrysalis, Compy, and Perlmutter). Once there is a polaris release,
these will be the commands to load the environments and set you up for building
the desired E3SM component (MPAS-Ocean, MALI or OMEGA):
the desired E3SM component (MPAS-Ocean, MALI or Omega):

- Anvil (Blues):

Expand Down Expand Up @@ -121,8 +121,8 @@ You will need to check out a branch of E3SM to build one of the supported
components.

Typically, for MPAS-Ocean, you will clone
[E3SM](https://github.com/E3SM-Project/E3SM), for OMEGA, you will clone
[OMEGA](https://github.com/E3SM-Project/Omega), and for MALI, you will clone
[E3SM](https://github.com/E3SM-Project/E3SM), for Omega, you will clone
[Omega](https://github.com/E3SM-Project/Omega), and for MALI, you will clone
[MALI-Dev](https://github.com/MALI-Dev/E3SM).

To build MPAS-Ocean, first source the appropriate load script (see
Expand All @@ -134,7 +134,7 @@ git submodule update --init --recursive
make <mpas_make_target>
```

OMEGA is still in the early stages of development to the appropriate commands
Omega is still in the early stages of development to the appropriate commands
have not yet been determined for building it.

MALI can be compiled with or without the Albany library that contains the
Expand Down Expand Up @@ -288,7 +288,7 @@ parallel_executable = mpirun -host localhost
```

The `database_root` directory can point to a location where you would like to
download data for MALI, MPAS-Seaice, MPAS-Ocean and OMEGA. This data is
download data for MALI, MPAS-Seaice, MPAS-Ocean and Omega. This data is
downloaded only once and cached for the next time you call `polaris setup` or
`polaris suite` (see below).

Expand Down
4 changes: 2 additions & 2 deletions polaris/ocean/mpas_ocean.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[paths]

# the relative or absolute path to the root of a branch where MPAS-Ocean
# or OMEGA has been built
# or Omega has been built
component_path = ${paths:polaris_branch}/e3sm_submodules/E3SM-Project/components/mpas-ocean

# The namelists section defines paths to example_compact namelists that will
Expand Down Expand Up @@ -32,6 +32,6 @@ processed = ${paths:component_path}/src/Registry_processed.xml
# The executables section defines paths to required executables. These
# executables are provided for use by specific test cases. Most tools that
# polaris needs should be in the conda environment, so this is only the path
# to the MPAS-Ocean or OMEGA executable by default.
# to the MPAS-Ocean or Omega executable by default.
[executables]
component = ${paths:component_path}/ocean_model
4 changes: 2 additions & 2 deletions polaris/ocean/ocean.cfg
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# This config file has default config options for the ocean component, which
# can either be MPAS-Ocean or OMEGA
# can either be MPAS-Ocean or Omega

# Options related the ocean component
[ocean]
# Which model, MPAS-Ocean or OMEGA, is used
# Which model, MPAS-Ocean or Omega, is used
model = mpas-ocean

# the number of cells per core to aim for
Expand Down
2 changes: 1 addition & 1 deletion polaris/yaml.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
class PolarisYaml:
"""
A class for reading writing and combining config files in yaml format
(e.g. as used in OMEGA).
(e.g. as used in Omega).
Attributes
----------
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = polaris
version = attr: polaris.version.__version__
author = E3SM Development Team
author_email = [email protected]
description = Testing and analysis for OMEGA, MPAS-Ocean, MALI and MPAS-Seaice
description = Testing and analysis for Omega, MPAS-Ocean, MALI and MPAS-Seaice
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/E3SM-Project/polaris
Expand Down

0 comments on commit 6fdcb02

Please sign in to comment.