Installation

Warning

The version of veros-extra-setups must match the version of Veros core. When in doubt, you can retrieve the installed Veros version via

$ veros --version

To install veros-extra-setups, just run

$ pip install veros-extra-setups==<veros-version>

Then, you can use veros copy-setup to start using the setup files in this package.

$ veros copy-setup --help

Usage: veros copy-setup [OPTIONS] SETUP

  Copy a standard setup to another directory.

  Available setups:

      acc, acc_basic, global_1deg, global_4deg, global_flexible, north_atlantic

  Example:

      $ veros copy-setup global_4deg --to ~/veros-setups/4deg-lowfric

  Further directories containing setup templates can be added to this command
  via the VEROS_SETUP_DIR environment variable.

Options:
  --to PATH  Target directory, must not exist (default: copy to current working
             directory)
  --help     Show this message and exit.