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. Use the following 3 steps to install OceanSpy.

  1. First, download and install Miniconda or Anaconda.

  2. Second, OceanSpy and its dependencies need to be installed. The easiest way to install OceanSpy’s dependencies is to use the conda-forge channel.

Open a terminal, then run the following commands:

$ conda update conda
$ conda config --set channel_priority strict
$ conda config --prepend channels conda-forge
$ conda install -y dask distributed bottleneck netCDF4 xarray cartopy esmpy ffmpeg intake-xarray tqdm geopy xgcm xesmf xmitgcm Ipython tqdm oceanspy
$ pip install --upgrade xmitgcm

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

  1. 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/malmans2/oceanspy.git