Oceanostics is a Julia package created to facilitate obtaining diagnostic quantities in Oceananigans simulations. It was created solely as a companion package to Oceananigans, so we refer users first to the Oceananigans documentation before getting started with Oceanostics.

To install the latest stable version from Julia:

julia> ]
(@v1.9) pkg> add Oceanostics

If you want the latest developments (which may or may not be unstable) you can add the latest version from Github in the main branch:

julia> ]
(@v1.9) pkg> add Oceanostics#main