Software Open Access

OceanSpy: A Python package to facilitate ocean model data analysis and visualization

Almansi, Mattia; Gelderloos, Renske; Haine, Thomas W. N.; Saberi, Atousa; Siddiqui, Ali H.

OceanSpy is an open-source and user-friendly Python package that enables scientists and interested amateurs to analyze and visualize oceanographic data sets. OceanSpy builds on software packages developed by the Pangeo community, in particular Xarray, Dask, and Xgcm. The integration of Dask facilitates scalability, which is important for the petabyte-scale simulations that are becoming available. OceanSpy can be used as a standalone package for analysis of local circulation model output, or it can be run on a remote data-analysis cluster, such as the Johns Hopkins University SciServer system, which hosts several simulations and is publicly available. OceanSpy enables extraction, processing, and visualization of model data to (i) compare with oceanographic observations, and (ii) portray the kinematic and dynamic space-time properties of the circulation.

Files (3.9 MB)
Name Size
3.9 MB Download
  • Dask Development Team. (2016). Dask: Library for dynamic task scheduling. Retrieved from

  • Hoyer, S., & Hamman, J. (2017). Xarray: N-D labeled arrays and datasets in Python. Journal of Open Research Software, 5(1). doi:10.5334/jors.148

  • Klinger, B. A., & Haine, T. W. N. (2019). Ocean Circulation in Three Dimensions (1st ed.). cup. doi:10.1017/9781139015721

  • Marshall, J., Adcroft, A., Hill, C., Perelman, L., & Heisey, C. (1997). A finite-volume, incompressible navier stokes model for studies of the ocean on parallel computers. Journal of Geophysical Research: Oceans, 102(C3), 5753–5766. doi:10.1029/96JC02775

  • Medvedev, D., Lemson, G., & Rippin, M. (2016). SciServer compute: Bringing analysis close to the data. In Proceedings of the 28th international conference on scientific and statistical database management, SSDBM '16 (pp. 27:1–27:4). New York, NY, USA: ACM. doi:10.1145/2949689.2949700

  • Xgcm: General circulation model postprocessing with xarray. (n.d.). xgcm/xgcm/blob/master/doc/index.rst. doi:10.5281/zenodo.826926

All versions This version
Views 3131
Downloads 11
Data volume 3.9 MB3.9 MB
Unique views 3030
Unique downloads 11


Cite as