• IsopycnalSurfaces.jl was originally started by G Jake Gebbie as a part of the ECCOtour.jl package (https://github.com/ggebbie/ECCOtour.jl)

• Core functionality: Take a profile (water column) of temperature and salinity on pressure or depth coordinates and transfer onto a vertical coordinate of density.

Equations of state include -"EOS80" from UNESCO 1980 (Saunders et al. 1980)
-"JMD95" from Jackett and McDougall 1995, used with MITgcm

• Other goals: Permit other properties besides temperature and salinity to be mapped onto depth. Allow 3D or 4D input fields. Allow various equations of state (partially implemented).

• This Julia package is in early development and breaking changes are expected.

• See the function list in the documentation linked through the badge above

• After setting up the Julia environment (instructions below), check that all tests pass via the following shell command in the repository base directory: julia --project=@. test/runtests.jl

• This project was originally called SigmaShift.jl.

• Also see Greg Wagner's package Isopycnal.jl (https://github.com/glwagner/Isopycnal.jl).

Compatibility with the built-in tests requires Julia 1.6+.

pkg> add IsopycnalSurfaces (see open Issue #12)

Optional: cd ./IsopycnalSurfaces.jl
pkg> activate .

Details about setting up a Julia environment are available at https://github.com/ggebbie/ECCOtour.jl#readme .

The Julia code is designed to download input files from Google Drive (using GoogleDrive.jl) and to place them in the data directory.

Available functions are listed in the documentation at https://ggebbie.github.io/IsopycnalSurfaces.jl/dev/ .

This package was generated using PkgTemplates.jl.

Steps:

1. Use PkgTemplates to make git repo.

Run the following Julia code

using Revise, PkgTemplates

t = Template(; user="ggebbie", dir="~/projects", authors="G Jake Gebbie", julia=v"1.6", plugins=[ License(; name="MIT"), Git(; manifest=true, ssh=true), GitHubActions(; x86=false), Codecov(), Documenter{GitHubActions}(), Develop(), ], )

t("IsopycnalSurfaces.jl")

2. Make a new empty repository on GitHub.\

3. Then push this existing repository from the command line: git remote add origin git@github.com:ggebbie/IsopycnalSurfaces.jl.git
git branch -M main
git push -u origin main

4. Use Documenter.jl and DocumenterTools to automatically deploy documentation following: https://m3g.github.io/JuliaNotes.jl/stable/publish_docs/ .