`NEMO-Cmd` Package Installation

NEMO-Cmd is a Python package that provides the nemo command-line tool for doing various operations associated running with the NEMO ocean model.

These instructions assume that:

You have an up to date clone of the NEMO-Cmd package repository.
You have installed the Pixi package and environments manager (installation instructions).

Use Pixi to create an isolated environment for NEMO-Cmd to avoid conflicts with other Python packages installed on your system. That environment will have all of the Python packages necessary to use the nemo command that is provided by the NEMO-Cmd package.

$ cd NEMO-Cmd
$ pixi install

When you are in the NEMO-Cmd/ directory (or a sub-directory) you can run the nemo command with with the pixi run command. Example:

$ pixi run nemo help

A common use-case is to execute the nemo run command in the directory containing your run description YAML file. To accomplish that, we have to tell Pixi where to find the NEMO-Cmd/ directory so that it can use the correct environment. We do that by using the -m or --manifest option of pixi run. Example:

$ cd run_descriptions/
$ pixi run -m $HOME/MEOPAR/NEMO-Cmd nemo run run_description.yaml \
    /scratch/allen/Carbon/MoreSens/Now/01jan11/

For doing development, testing, and documentation of the NEMO-Cmd package, please see the NEMO-Cmd Package Development section.

NEMO-Cmd Package Installation

`NEMO-Cmd` Package Installation