| Continuous Integration | 
|
| Documentation | 
|
| Package | 
|
| Meta | 
|
The NEMO command processor, nemo, is a command line tool for doing various operations
associated with running the NEMO ocean model.
The package uses Pixi to manage dependencies and operating environments. If you don't already have Pixi installed, please follow its installation instructions to do so. Please see the :ref:`NEMO-CmdPackageInstallation` or :ref:`NEMO-CmdPackageDevelopment` documentation sections for more details.
In the NEMO-Cmd/ directory,
use pixi run nemo --help to get a list of the sub-commands available.
Use pixi run nemo help <sub-command> to get a synopsis of what a sub-command does,
what its required arguments are,
and what options are available to control it.
Documentation for the command processor is in the docs/ directory and is rendered
at https://nemo-cmd.readthedocs.io/en/latest/.
This an extensible tool built on the OpenStack cliff
(Command Line Interface Formulation Framework)
package.
As such,
it can be used as the basis for domain-specific NEMO command processor tools,
and command processor tools for other ocean models.
Examples:
- SalishSeaCmd: for the SalishSeaCast NEMO configuration
- AtlantisCmd: for the Salish Sea configuration of the Atlantis marine ecosystem model
- WWatch3-Cmd: for the Salish Sea configuration of the WAVEWATCH III® wave model
- MOHID-Cmd: for the Salish Sea configuration of the MOHID oil spill model
-- _MOHID: https://www.mohid.com
The NEMO-Cmd package is based on v2.2 of the SalishSeaCast NEMO model project's
tools/SalishSeaCmd package.
The NEMO command processor and documentation are copyright 2013 – present by the SalishSeaCast Project Contributors and The University of British Columbia.
They are licensed under the Apache License, Version 2.0. https://www.apache.org/licenses/LICENSE-2.0 Please see the LICENSE file for details of the license.