OceanStateEstimation.ECCO_diagnostics.driver
— Methoddriver(P)
Call main computation loop as specified by parameters P
.
The main computation loop choice depends on the P
parameter values. Methods include:
main_clim
main_glo
main_zonmean
main_overturn
main_MHT
main_trsp
OceanStateEstimation.ECCO_io.read_monthly
— Methodread_monthly(P,nam,t)
Read record t
for variable nam
from file locations specified via parameters P
.
The method used to read nam
is selected based on nam
's value. Methods include:
read_monthly_default
read_monthly_SSH
read_monthly_MHT
read_monthly_BSF
OceanStateEstimation.ECCO_helpers.parameters
— Methodparameters(P0,params)
Prepare parameter NamedTuple for use in ECCO_diagnostics.driver
.
P1=parameters(P0,p)
is faster than e.g. parameters(pth,"r2",p)
as grid, etc get copied from P0
to P1
.
OceanStateEstimation.ECCO_helpers.parameters
— Methodparameters(pth0::String,sol0::String,params)
Prepare parameter NamedTuple for use in ECCO_diagnostics.driver
.
For example, to compute zonal mean temperatures at level 5:
p=(calc = "zonmean", nam = "THETA", lev = 5)
pth=ECCO.standard_analysis_setup(ScratchSpaces.ECCO)
P0=ECCO_helpers.parameters(pth,"r2",p)
or, from a predefined list:
list0=ECCO_helpers.standard_list_toml("")
pth=ECCO.standard_analysis_setup(ScratchSpaces.ECCO)
P1=ECCO_helpers.parameters(pth,"r2",list0[1])
OceanStateEstimation.downloads.CBIOMESclim_download
— MethodCBIOMESclim_download()
Download lazy artifact to scratch space.
OceanStateEstimation.downloads.ECCOdiags_add
— MethodECCOdiags_add(nam::String)
Add data to the scratch space folder. Known options for nam
include "release1", "release2", "release3", "release4", "release5", and "OCCA2HR1".
OceanStateEstimation.downloads.MITPROFclim_download
— MethodMITPROFclim_download()
Download lazy artifact to scratch space.
OceanStateEstimation.downloads.get_ecco_files
— Functionget_ecco_files(γ::gcmgrid,v::String,t=1)
using MeshArrays, OceanStateEstimation, MITgcm
γ=GridSpec("LatLonCap",MeshArrays.GRID_LLC90)
tmp=OceanStateEstimation.get_ecco_files(γ,"oceQnet")
OceanStateEstimation.downloads.get_ecco_variable_if_needed
— Methodget_ecco_variable_if_needed(v::String)
Download ECCO output for variable v
to scratch space if needed
OceanStateEstimation.downloads.get_ecco_velocity_if_needed
— Methodget_ecco_velocity_if_needed()
Download ECCO output for u,v,w
to scratch space if needed
OceanStateEstimation.downloads.get_occa_variable_if_needed
— Methodget_occa_variable_if_needed(v::String)
Download OCCA output for variable v
to scratch space if needed
OceanStateEstimation.downloads.get_occa_velocity_if_needed
— Methodget_occa_velocity_if_needed()
Download OCCA output for u,v,w
to scratch space if needed
OceanStateEstimation.ECCO.standard_analysis_setup
— FunctionECCO.standard_analysis_setup(pth0::String)
Create temporary run folder pth
where data folder pth0
will be linked.
Data folder pth0
should be the path to ECCO data.
For example:
using OceanStateEstimation, Pkg
pth=ECCO.standard_analysis_setup(ScratchSpaces.ECCO)
The Project.toml
file found in pth
provides an environment ready for ECCO
analyses.
This environment can be activated and instantiated:
Pkg.activate(pth)
Pkg.instantiate()
OceanStateEstimation.examples
— Methodexamples()
List of examples provided in OceanStateEstimation.jl (full paths)