pyroms | Python tools for the Regional Ocean Modeling System

Pyroms is still a bit rough around the edges, particularly with regard to installation. Recent development has been done in Python environments managed by Conda. However Pyroms itself cannot yet be installed with Conda. If you are starting from scratch, we recommend that you install Anaconda or Miniconda and create a Python 3 environment (as of December 2020, version 3.8 is your best bet) for Pyroms and your other scientific software. You should also consider making conda-forge your default channel. See the conda-forge tips and tricks page. If you don't want to use Conda, that's fine, but you will have to do more of the work yourself.
To clone a copy of the source and install the pyroms packages, you can use the following commands. This installs three PIP packages with the names pyroms, pyroms_toolbox and bathy_smoother, each with an eponymous module. An editable-mode installation is recommended becauses it means changes you make to your copy of the source code will take effect when you import the modules. If you don't want this you can omit the "-e" option. The "pip install" command runs "python setup.py install" (or "python setup.py develop" with the "-e" switch) in each of the subdirectories listed. The "pip install" form is recommended because it allow easy removal (see below). The above should work on most Linuces and on OSX with the system gcc and gfortran compilers. They have also been verified to work in a Conda environment on Windows, provided you install the m2w64-gcc and m2w64-gfortran compilers.
If you install as above and try to import the three Pyroms modules without having installed scrip you will get a warning like this:. The scrip module is not available via Conda or any other package repository and we are looking at alternatives. In the meantime, scrip can be built and installed from source as follows.