Nowcast Figures Development Environment

SalishSeaNowcast uses Pixi for package and environment management. If you don’t already have Pixi installed, please follow its installation instructions to do so.

Use pixi install -e fig-dev command to download the package dependencies for the figure development and link them into the environment named fig-dev.

Most commands are executed using pixi run in the SalishSeaNowcast/ directory (or a sub-directory).

• The fig-dev environment has the packages installed that are required to run the commands needed to develop and test figures. For example, to see the information about how to run the make_plots worker, use the command pixi run -e fig-dev python -m nowcast.workers.make_plots --help

• Other environments used for other SalishSeaNowcast Package Development tasks have addition packages for running the test suite, building and link checking the documentation, etc.

• If you are using an integrated development environment like VSCode or PyCharm where you need a Python interpreter to support coding assistance features, run development tasks, etc., use the interpreter in the fig-dev environment. You can get its full path with pixi run -e fig-dev which python

You can launch a sub-shell in the fig-dev environment with a command like pixi shell -e fig-dev. That is convenient if you are running a lot of commands because it removed the need to type pixi run -e fig-dev before each of them. Use exit to leave the sub-shell.

SalishSeaNowcast figure development depends on a collection of other Python packages developed by the SalishSeaCast project and friends:

• NEMO_Nowcast

• moad_tools

• Reshapr

• SalishSeaTools Package

• NEMO-Cmd

• SalishSeaCast NEMO Command Processor

• salishsea-site

Those packages are installed by the pixi install command.

To get detailed information about the environments, the packages installed in them, Pixi tasks that are defined for them, etc., use pixi info.

SalishSeaNowcast is installed in editable install mode in all of the environments that Pixi creates. That means that changes you make to the code are immediately reflected in the environments.