example-conf.yml

# ----------------
# ----------------
# Required entries
# ----------------
# ----------------

# -----------------------
# Input Dataset variables
# -----------------------
# file_path and var_name are required, index is optional

# longitude grid of the SSH
lon:
  file_path: "notebooks/data/alboransea_sossheig.nc"
  var_name: "nav_lon"

# latitude grid of the SSH
lat:
  file_path: "notebooks/data/alboransea_sossheig.nc"
  var_name: "nav_lat"

# SSH grid
ssh:
  file_path: "notebooks/data/alboransea_sossheig.nc"
  var_name: "sossheig"
  index: [0]

# ------------------------
# Output Dataset full path
# ------------------------

out_path: "notebooks/data/out.nc"


# --------------
# --------------
# Optional entry
# --------------
# --------------

# -----------------------
# Input Dataset variables
# -----------------------
# file_path and var_name are required, index is optional
# mask arrays are expected to be boolean or numeric, with True (or 1) for marine pixels and False (or 0) for land ones.

# mask of the SSH
mask:
  file_path: "notebooks/data/mask_alboransea.nc"
  var_name: "tmask"
  index: [0, 0]  # here we select the first time and elevation elements (optional, depends on the data structure)

# ---------------------------------------
# Arguments to the cyclogeostrophy method
# ---------------------------------------
# allows to tune the cyclogeostrophic approach applied, and its hyperparameters.
# refer to the documentation for a comprehensive list of the available optional arguments:
# https://meom-group.github.io/jaxparrow/jaxparrow.cyclogeostrophy.html
# if not provided, default values are used.

cyclogeostrophy:
  method: "variational"
  n_it: 1000
  optim: "sgd"
  optim_kwargs:
    learning_rate: 0.001

# -------------------------
# Output Dataset attributes
# -------------------------
# allows to customize some metadata attributes included to the outputted dataset.
# follows CF-1.10 convention (see http://cfconventions.org/conventions.html)
# attributes listed in the convention but not here are not expected to be modified, but we do not enforce it.
# provided example values are the default ones. Note that if not provided, the institution entry will remain empty.

out_attrs:
  title: "ocean geostrophic and cyclogeostrophic currents"
  institution: ""