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:

  • $HOME/anaconda3/bin is included in your PATH environment variable if you are using the Anaconda, or $HOME/miniconda3/bin is included in your PATH environment variable if you are using Miniconda

To install the NEMO-Cmd package in your root Anaconda or Miniconda environment use:

$ cd NEMO-Cmd
$ pip install --user --editable .

The --editable option in the pip install commands installs the packages via symlinks so that nemo will be automatically updated as the repo evolves.

The Nemo-Cmd package can also be installed in an isolated conda environment. The common use case for doing so it development, testing, and documentation of the package; please see the NEMO-Cmd Package Development section for details.

<TAB> Completion

Note

<TAB> completion is only available in recent versions of bash. The instructions below are only useful if you are working on Ubuntu 14.04 or later.

The nemo command line interface includes a sub-command that enables it to hook into the bash <TAB> completion machinery. (<TAB> completion or command-line completion is a shell feature whereby partially typed commands are filled out by the shell when the user presses the <TAB> key.) The nemo complete command prints a blob of bash code that does the job, so, capturing that code and executing it with the eval command will enable completion for nemo in your current shell session. You can do that with the compound command:

eval "$(nemo complete)"

Including that line in your ~/.bashrc file will ensure that completion for nemo is available in every shell you launch.