Installation

If you would like to use OceanSpy for your own datasets and run it on a local machine or server, you will need to download and install it first.

Required dependencies

• Python 3.9

• dask

• xarray

• xgcm

Optional dependencies

For optimal performance and to enable all OceanSpy features, it is highly recommended that you install the following dependencies:

• bottleneck

• Cartopy

• Dask.distributed

• ESMPy

• FFmpeg

• GeoPy

• intake_xarray

• IPython

• netCDF4

• tqdm

• xESMF

• xmitgcm

Step-by-step instructions

1. First, download and install Miniconda or Anaconda.

2. The easiest way to install OceanSpy and the above mentioned dependencies is to use the conda-forge channel. Open a terminal, then run the following command:

$ conda create -n oceanspy-env -c conda-forge oceanspy xarray "cartopy<0.20" esmpy intake-xarray geopy xesmf esmf xgcm Ipython tqdm ffmpeg aiohttp pandas xmitgcm

The commands above install the latest stable release of OceanSpy along with its dependencies.

3. Finally, in case you would like to use the latest version of OceanSpy under development rather than the stable release, add the following command:

$ pip install --upgrade git+https://github.com/hainegroup/oceanspy.git

Note

For experts: Use the following command to Create an environment identical to the Oceanography environment available on SciServer:

$ conda env create -f https://raw.githubusercontent.com/hainegroup/oceanspy/main/sciserver_catalogs/environment.yml

Then, activate the Oceanography environment:

$ conda activate Oceanography

Test suite

Step-by-step instructions on how to run the test suite are available in Contributing to the Code.