Creating Custom ERA5Variables
While the list of available ERA5Variables in the Climate Data Store is very extensive, they are not exhaustive. There is therefore a need to define a list of custom ERA5Variables that will be otherwise calculated (although this has to be done separately outside of ERA5Reanalysis.jl), and then can thus be saved and manipulated and analyzed in the same way that the default ERA5Variables in ERA5Reanalysis.jl can be. In this page, we break this down into the SingleLevel and PressureLevel components
Custom SingleLevel Variables
As of ERA5Reanalysis.jl v0.3, we have predefined all the single-level variables that are available directly from the CDS. As such, all custom SingleLevel variables are defined under the SingleCustom type.
ERA5Reanalysis ≧ v0.3
All Single-Level variables defined in the Climate Data Store are now available in ERA5Reanalysis.jl, but only for versions ≧ v0.3.
Defining a new SingleCustom variable
To define aSingleCustom variables, we use the funciton SingleVariable().
ERA5Reanalysis.SingleVariable Type
julia
SingleVariable(
ST = String;
ID :: AbstractString,
long :: AbstractString = "",
name :: AbstractString,
units :: AbstractString
) -> evar :: SingleLevelCreate a custom Single-Level variable that is not in the default list exported by ERA5Reanalysis.jl. These variables are not available in the CDS store, and so they must be separately calculated from other variables and analyzed.
Keyword Arguments
ID: variable ID (in string format) used in the NetCDF filelong: long-name for variable (used in specifying variable for CDS downloads)name: user-defined variable nameunits: user-defined units of the variableinCDS: Boolean that indicates if this variable is available on the CDS store. True if available.
Removing Custom SingleLevel Variables
To remove a SingleCustom variable, we can use the rmSingle() function:
Missing docstring.
Missing docstring for rmSingle( varID :: AbstractString ). Check Documenter's build log for details.
An Example!
In this example, we add a SingleLevel variable to the list:
eke, for Eddy Kinetic Energy, which is not downloadable and must be calculated using other variables
The Eddy Kinetic Energy is calculated by the following:
And it is often used as a measure of storm-track intensity.
julia
julia> using ERA5Reanalysis
julia> SingleVariable(
ID = "eke",
units = "J m**-2",
name = "Eddy Kinetic Energy",
long = "eddy_kinetic_energy"
)
[33m[1m┌ [22m[39m[33m[1mWarning: [22m[39m2026-02-08T04:02:53.677 - ERA5Reanalysis.jl - "eke" is not a valid SingleVariable identifier, use the function SingleVariable() or SingleCustom() to add this ERA5Variable to the list.
[33m[1m└ [22m[39m[90m@ ERA5Reanalysis ~/work/ERA5Reanalysis.jl/ERA5Reanalysis.jl/src/variable/is.jl:59[39m
The Single-Level Custom Variable "eke" has the following properties:
Variable ID (ID/ncID) : eke
Long Name (long) : eddy_kinetic_energy
Variable Name (name) : Eddy Kinetic Energy
Variable Units (units) : J m**-2
julia> tableSingles(custom=true)
[33m[1m┌ [22m[39m[33m[1mWarning: [22m[39m2026-02-08T04:02:55.800 - ERA5Reanalysis.jl - The custom file does "singlecustom.txt" does not exist in /home/runner, use `setupERA5Variables()` to copy templates and empty custom lists to /home/runner.
[33m[1m└ [22m[39m[90m@ ERA5Reanalysis ~/work/ERA5Reanalysis.jl/ERA5Reanalysis.jl/src/variable/tables.jl:87[39m
------------ ---------------- ----------------------- ------- ----------------------------------------------------------------- --------- ----------------
[1m ID [0m [1m Variable Type [0m [1m Name [0m [1m Units [0m [1m ERA5 Long-Name [0m [1m DKRZ ID [0m [1m DKRZ Invariant [0m
------------ ---------------- ----------------------- ------- ----------------------------------------------------------------- --------- ----------------
alnid SingleVariable (0 - 1) true Near IR albedo for diffuse radiation true false
alnip SingleVariable (0 - 1) true Near IR albedo for direct radiation true false
aluvd SingleVariable (0 - 1) true UV visible albedo for diffuse radiation true false
aluvp SingleVariable (0 - 1) true UV visible albedo for direct radiation true false
anor SingleVariable radians true Angle of sub-gridscale orography missing missing
asn SingleVariable (0 - 1) true Snow albedo true false
bfi SingleVariable dimensionless true Benjamin-Feir index true false
bld SingleVariable J m**-2 false Boundary layer dissipation true false
blh SingleVariable m true Boundary layer height true false
cape SingleVariable J kg**-1 true Convective available potential energy true false
cbh SingleVariable m false Cloud base height true false
cdir SingleVariable J m**-2 false Clear-sky direct solar radiation at surface true false
cdww SingleVariable dimensionless true Coefficient of drag with waves true false
chnk SingleVariable ~ true Charnock true false
ci SingleVariable (0 - 1) true Sea ice area fraction true false
cin SingleVariable J kg**-1 false Convective inhibition true false
cl SingleVariable (0 - 1) true Lake cover true true
cp SingleVariable m false Convective precipitation true false
crr SingleVariable kg m**-2 s**-1 false Convective rain rate true false
csf SingleVariable m of water equivalent false Convective snowfall true false
csfr SingleVariable kg m**-2 s**-1 false Convective snowfall rate water equivalent true false
cvh SingleVariable (0 - 1) true High vegetation cover missing missing
cvl SingleVariable (0 - 1) true Low vegetation cover missing missing
d2m SingleVariable K true 2 metre dewpoint temperature true false
dctb SingleVariable m false Duct base height true false
deg0l SingleVariable m false Zero degree level true false
dl SingleVariable m true Lake depth true true
dndza SingleVariable m**-1 false Mean vertical gradient of refractivity inside trapping layer true false
dndzn SingleVariable m**-1 false Minimum vertical gradient of refractivity inside trapping layer true false
dwi SingleVariable degrees true 10 metre wind direction true false
dwps SingleVariable Radians true Wave spectral directional width for swell true false
dwww SingleVariable Radians true Wave spectral directional width for wind waves true false
e SingleVariable m of water equivalent false Evaporation true false
es SingleVariable m of water equivalent false Snow evaporation true false
ewss SingleVariable N m**-2 s false Eastward turbulent surface stress true false
fal SingleVariable (0 - 1) true Forecast albedo true false
fdir SingleVariable J m**-2 false Total sky direct solar radiation at surface true false
fg10 SingleVariable m s**-1 false 10 metre wind gust since previous post-processing true false
flsr SingleVariable ~ true Forecast logarithm of surface roughness for heat true false
fsr SingleVariable m true Forecast surface roughness true false
gwd SingleVariable J m**-2 false Gravity wave dissipation true false
hcc SingleVariable (0 - 1) true High cloud cover true false
hmax SingleVariable m true Maximum individual wave height true false
i10fg SingleVariable m s**-1 false Instantaneous 10 metre wind gust true false
ie SingleVariable kg m**-2 s**-1 true Instantaneous moisture flux true false
iews SingleVariable N m**-2 true Instantaneous eastward turbulent surface stress true false
ilspf SingleVariable (0 - 1) false Instantaneous large-scale surface precipitation fraction true false
inss SingleVariable N m**-2 true Instantaneous northward turbulent surface stress true false
ishf SingleVariable W m**-2 true Instantaneous surface sensible heat flux true false
isor SingleVariable ~ true Anisotropy of sub-gridscale orography missing missing
istl1 SingleVariable K true Ice temperature layer 1 true false
istl2 SingleVariable K true Ice temperature layer 2 true false
istl3 SingleVariable K true Ice temperature layer 3 true false
istl4 SingleVariable K true Ice temperature layer 4 true false
kx SingleVariable K false K index2 true false
lai_hv SingleVariable m**2 m**-2 true Leaf area index, high vegetation3 true false
lai_lv SingleVariable m**2 m**-2 true Leaf area index, low vegetation3 true false
lblt SingleVariable K true Lake bottom temperature true false
lcc SingleVariable (0 - 1) true Low cloud cover true false
lgws SingleVariable N m**-2 s false Eastward gravity wave surface stress true false
licd SingleVariable m true Lake ice depth true false
lict SingleVariable K true Lake ice temperature true false
lmld SingleVariable m true Lake mix-layer depth true false
lmlt SingleVariable K true Lake mix-layer temperature true false
lsf SingleVariable m of water equivalent false Large-scale snowfall true false
lshf SingleVariable dimensionless true Lake shape factor true false
lsm SingleVariable (0 - 1) true Land-sea mask true true
lsp SingleVariable m false Large-scale precipitation true false
lspf SingleVariable s false Large-scale precipitation fraction true false
lsrr SingleVariable kg m**-2 s**-1 false Large scale rain rate true false
lssfr SingleVariable kg m**-2 s**-1 false Large scale snowfall rate water equivalent true false
ltlt SingleVariable K true Lake total layer temperature true false
mbld SingleVariable W m**-2 false Mean boundary layer dissipation true false
mcc SingleVariable (0 - 1) true Medium cloud cover true false
mcpr SingleVariable kg m**-2 s**-1 false Mean convective precipitation rate true false
mcsr SingleVariable kg m**-2 s**-1 false Mean convective snowfall rate true false
mdts SingleVariable degrees true Mean direction of total swell true false
mdww SingleVariable degrees true Mean direction of wind waves true false
megwss SingleVariable N m**-2 false Mean eastward gravity wave surface stress true false
mer SingleVariable kg m**-2 s**-1 false Mean evaporation rate true false
metss SingleVariable N m**-2 false Mean eastward turbulent surface stress true false
mgwd SingleVariable W m**-2 false Mean gravity wave dissipation true false
mgws SingleVariable N m**-2 s false Northward gravity wave surface stress true false
mlspf SingleVariable Proportion false Mean large-scale precipitation fraction true false
mlspr SingleVariable kg m**-2 s**-1 false Mean large-scale precipitation rate true false
mlssr SingleVariable kg m**-2 s**-1 false Mean large-scale snowfall rate true false
mn2t SingleVariable K false Minimum temperature at 2 metres since previous post-processing true false
mngwss SingleVariable N m**-2 false Mean northward gravity wave surface stress true false
mntpr SingleVariable kg m**-2 s**-1 false Minimum total precipitation rate since previous post-processing true false
mntss SingleVariable N m**-2 false Mean northward turbulent surface stress true false
mp1 SingleVariable s true Mean wave period based on first moment true false
mp2 SingleVariable s true Mean zero-crossing wave period true false
mper SingleVariable kg m**-2 s**-1 false Mean potential evaporation rate true false
mpts SingleVariable s true Mean period of total swell true false
mpww SingleVariable s true Mean period of wind waves true false
mror SingleVariable kg m**-2 s**-1 false Mean runoff rate true false
msdrswrf SingleVariable W m**-2 false Mean surface direct short-wave radiation flux true false
msdrswrfcs SingleVariable W m**-2 false Mean surface direct short-wave radiation flux, clear sky true false
msdwlwrf SingleVariable W m**-2 false Mean surface downward long-wave radiation flux true false
msdwlwrfcs SingleVariable W m**-2 false Mean surface downward long-wave radiation flux, clear sky true false
msdwswrf SingleVariable W m**-2 false Mean surface downward short-wave radiation flux true false
msdwswrfcs SingleVariable W m**-2 false Mean surface downward short-wave radiation flux, clear sky true false
msdwuvrf SingleVariable W m**-2 false Mean surface downward UV radiation flux true false
mser SingleVariable kg m**-2 s**-1 false Mean snow evaporation rate true false
msl SingleVariable Pa true Mean sea level pressure true false
mslhf SingleVariable W m**-2 false Mean surface latent heat flux true false
msmr SingleVariable kg m**-2 s**-1 false Mean snowmelt rate true false
msnlwrf SingleVariable W m**-2 false Mean surface net long-wave radiation flux true false
msnlwrfcs SingleVariable W m**-2 false Mean surface net long-wave radiation flux, clear sky true false
msnswrf SingleVariable W m**-2 false Mean surface net short-wave radiation flux true false
msnswrfcs SingleVariable W m**-2 false Mean surface net short-wave radiation flux, clear sky true false
msqs SingleVariable dimensionless true Mean square slope of waves true false
msr SingleVariable kg m**-2 s**-1 false Mean snowfall rate true false
msror SingleVariable kg m**-2 s**-1 false Mean surface runoff rate true false
msshf SingleVariable W m**-2 false Mean surface sensible heat flux true false
mssror SingleVariable kg m**-2 s**-1 false Mean sub-surface runoff rate true false
mtdwswrf SingleVariable W m**-2 false Mean top downward short-wave radiation flux true false
mtnlwrf SingleVariable W m**-2 false Mean top net long-wave radiation flux true false
mtnlwrfcs SingleVariable W m**-2 false Mean top net long-wave radiation flux, clear sky true false
mtnswrf SingleVariable W m**-2 false Mean top net short-wave radiation flux true false
mtnswrfcs SingleVariable W m**-2 false Mean top net short-wave radiation flux, clear sky true false
mtpr SingleVariable kg m**-2 s**-1 false Mean total precipitation rate true false
mvimd SingleVariable kg m**-2 s**-1 false Mean vertically integrated moisture divergence true false
mwd SingleVariable degrees true Mean wave direction true false
mwd1 SingleVariable degrees true Mean wave direction of first swell partition true false
mwd2 SingleVariable degrees true Mean wave direction of second swell partition true false
mwd3 SingleVariable degrees true Mean wave direction of third swell partition true false
mwp SingleVariable s true Mean wave period true false
mwp1 SingleVariable s true Mean wave period of first swell partition true false
mwp2 SingleVariable s true Mean wave period of second swell partition true false
mwp3 SingleVariable s true Mean wave period of third swell partition true false
mx2t SingleVariable K false Maximum temperature at 2 metres since previous post-processing true false
mxtpr SingleVariable kg m**-2 s**-1 false Maximum total precipitation rate since previous post-processing true false
nsss SingleVariable N m**-2 s false Northward turbulent surface stress true false
p1ps SingleVariable s true Mean wave period based on first moment for swell true false
p1ww SingleVariable s true Mean wave period based on first moment for wind waves true false
p2ps SingleVariable s true Mean wave period based on second moment for swell true false
p2ww SingleVariable s true Mean wave period based on second moment for wind waves true false
pev SingleVariable m false Potential evaporation true false
phiaw SingleVariable dimensionless true Normalized energy flux into waves true false
phioc SingleVariable dimensionless true Normalized energy flux into ocean true false
pp1d SingleVariable s true Peak wave period true false
ptype SingleVariable code table (4.201) false Precipitation type true false
rhoao SingleVariable kg m**-3 true Air density over the oceans true false
ro SingleVariable m false Runoff true false
rsn SingleVariable kg m**-3 true Snow density true false
sd SingleVariable m of water equivalent true Snow depth true false
sdfor SingleVariable m true Standard deviation of filtered subgrid orography missing missing
sdor SingleVariable ~ true Standard deviation of sub-gridscale orography missing missing
sf SingleVariable m of water equivalent false Snowfall true false
shts SingleVariable m true Significant height of total swell true false
shww SingleVariable m true Significant height of wind waves true false
skt SingleVariable K true Skin temperature true false
slhf SingleVariable J m**-2 false Surface latent heat flux true false
slor SingleVariable ~ true Slope of sub-gridscale orography missing missing
slt SingleVariable ~ true Soil type1 missing missing
smlt SingleVariable m of water equivalent false Snowmelt true false
sp SingleVariable Pa true Surface pressure true false
src SingleVariable m of water equivalent true Skin reservoir content true false
sro SingleVariable m false Surface runoff true false
sshf SingleVariable J m**-2 false Surface sensible heat flux true false
ssr SingleVariable J m**-2 false Surface net solar radiation true false
ssrc SingleVariable J m**-2 false Surface net solar radiation, clear sky true false
ssrd SingleVariable J m**-2 false Surface solar radiation downwards true false
ssrdc SingleVariable J m**-2 false Surface solar radiation downward clear-sky true false
ssro SingleVariable m false Sub-surface runoff true false
sst SingleVariable K true Sea surface temperature true false
stl1 SingleVariable K true Soil temperature level 11 true false
stl2 SingleVariable K true Soil temperature level 21 true false
stl3 SingleVariable K true Soil temperature level 31 true false
stl4 SingleVariable K true Soil temperature level 41 true false
str SingleVariable J m**-2 false Surface net thermal radiation true false
strc SingleVariable J m**-2 false Surface net thermal radiation, clear sky true false
strd SingleVariable J m**-2 false Surface thermal radiation downwards true false
strdc SingleVariable J m**-2 false Surface thermal radiation downward clear-sky true false
swh SingleVariable m true Significant height of combined wind waves and swell true false
swh1 SingleVariable m true Significant wave height of first swell partition true false
swh2 SingleVariable m true Significant wave height of second swell partition true false
swh3 SingleVariable m true Significant wave height of third swell partition true false
swvl1 SingleVariable m**3 m**-3 true Volumetric soil water layer 11 true false
swvl2 SingleVariable m**3 m**-3 true Volumetric soil water layer 21 true false
swvl3 SingleVariable m**3 m**-3 true Volumetric soil water layer 31 true false
swvl4 SingleVariable m**3 m**-3 true Volumetric soil water layer 41 true false
t2m SingleVariable K true 2 metre temperature true false
tauoc SingleVariable dimensionless true Normalized stress into ocean true false
tcc SingleVariable (0 - 1) true Total cloud cover true false
tciw SingleVariable kg m**-2 true Total column cloud ice water true false
tclw SingleVariable kg m**-2 true Total column cloud liquid water true false
tco3 SingleVariable kg m**-2 true Total column ozone true false
tcrw SingleVariable kg m**-2 true Total column rain water true false
tcslw SingleVariable kg m**-2 false Total column supercooled liquid water true false
tcsw SingleVariable kg m**-2 true Total column snow water true false
tcw SingleVariable kg m**-2 true Total column water true false
tcwv SingleVariable kg m**-2 true Total column water vapour true false
tisr SingleVariable J m**-2 false TOA incident solar radiation true false
tmax SingleVariable s true Period corresponding to maximum individual wave height true false
totalx SingleVariable K false Total totals index2 true false
tp SingleVariable m false Total precipitation true false
tplb SingleVariable m false Trapping layer base height true false
tplt SingleVariable m false Trapping layer top height true false
tsn SingleVariable K true Temperature of snow layer true false
tsr SingleVariable J m**-2 false Top net solar radiation true false
tsrc SingleVariable J m**-2 false Top net solar radiation, clear sky true false
ttr SingleVariable J m**-2 false Top net thermal radiation true false
ttrc SingleVariable J m**-2 false Top net thermal radiation, clear sky true false
tvh SingleVariable ~ true Type of high vegetation missing missing
tvl SingleVariable ~ true Type of low vegetation missing missing
u10 SingleVariable m s**-1 true 10 metre U wind component true false
u100 SingleVariable m s**-1 true 100 metre U wind component true false
u10n SingleVariable m s**-1 true Neutral wind at 10 m u-component true false
ust SingleVariable m s**-1 true U-component stokes drift true false
uvb SingleVariable J m**-2 false Downward UV radiation at the surface true false
v10 SingleVariable m s**-1 true 10 metre V wind component true false
v100 SingleVariable m s**-1 true 100 metre V wind component true false
v10n SingleVariable m s**-1 true Neutral wind at 10 m v-component true false
viec SingleVariable W m**-2 true Vertical integral of energy conversion true false
vigd SingleVariable W m**-2 true Vertical integral of divergence of geopotential flux true false
vige SingleVariable W m**-1 true Vertical integral of eastward geopotential flux true false
vign SingleVariable W m**-1 true Vertical integral of northward geopotential flux true false
viiwd SingleVariable kg m**-2 s**-1 true Vertical integral of divergence of cloud frozen water flux true false
viiwe SingleVariable kg m**-1 s**-1 true Vertical integral of eastward cloud frozen water flux true false
viiwn SingleVariable kg m**-1 s**-1 true Vertical integral of northward cloud frozen water flux true false
vike SingleVariable J m**-2 true Vertical integral of kinetic energy true false
viked SingleVariable W m**-2 true Vertical integral of divergence of kinetic energy flux true false
vikee SingleVariable W m**-1 true Vertical integral of eastward kinetic energy flux true false
viken SingleVariable W m**-1 true Vertical integral of northward kinetic energy flux true false
vilwd SingleVariable kg m**-2 s**-1 true Vertical integral of divergence of cloud liquid water flux true false
vilwe SingleVariable kg m**-1 s**-1 true Vertical integral of eastward cloud liquid water flux true false
vilwn SingleVariable kg m**-1 s**-1 true Vertical integral of northward cloud liquid water flux true false
vima SingleVariable kg m**-2 true Vertical integral of mass of atmosphere true false
vimad SingleVariable kg m**-2 s**-1 true Vertical integral of divergence of mass flux true false
vimae SingleVariable kg m**-1 s**-1 true Vertical integral of eastward mass flux true false
viman SingleVariable kg m**-1 s**-1 true Vertical integral of northward mass flux true false
vimat SingleVariable kg m**-2 s**-1 true Vertical integral of mass tendency missing missing
vimd SingleVariable kg m**-2 false Vertically integrated moisture divergence true false
viozd SingleVariable kg m**-2 s**-1 true Vertical integral of divergence of ozone flux true false
vioze SingleVariable kg m**-1 s**-1 true Vertical integral of eastward ozone flux true false
viozn SingleVariable kg m**-1 s**-1 true Vertical integral of northward ozone flux true false
vipie SingleVariable J m**-2 true Vertical integral of potential+internal energy true false
vipile SingleVariable J m**-2 true Vertical integral of potential+internal+latent energy true false
vit SingleVariable K kg m**-2 true Vertical integral of temperature true false
vithe SingleVariable J m**-2 true Vertical integral of thermal energy true false
vithed SingleVariable W m**-2 true Vertical integral of divergence of thermal energy flux true false
vithee SingleVariable W m**-1 true Vertical integral of eastward heat flux true false
vithen SingleVariable W m**-1 true Vertical integral of northward heat flux true false
vitoe SingleVariable J m**-2 true Vertical integral of total energy true false
vitoed SingleVariable W m**-2 true Vertical integral of divergence of total energy flux true false
vitoee SingleVariable W m**-1 true Vertical integral of eastward total energy flux true false
vitoen SingleVariable W m**-1 true Vertical integral of northward total energy flux true false
viwvd SingleVariable kg m**-2 s**-1 true Vertical integral of divergence of moisture flux true false
viwve SingleVariable kg m**-1 s**-1 true Vertical integral of eastward water vapour flux true false
viwvn SingleVariable kg m**-1 s**-1 true Vertical integral of northward water vapour flux true false
vst SingleVariable m s**-1 true V-component stokes drift true false
wdw SingleVariable Radians true Wave spectral directional width true false
wind SingleVariable m s**-1 true 10 metre wind direction true false
wmb SingleVariable m true Model bathymetry true false
wsk SingleVariable dimensionless true Wave spectral kurtosis true false
wsp SingleVariable dimensionless true Wave spectral peakedness true false
wss SingleVariable dimensionless true Wave Spectral Skewness true false
wstar SingleVariable m s**-1 true Free convective velocity over the oceans true false
z SingleVariable m**2 s**-2 true Geopotential true true
zust SingleVariable m s**-1 false Friction velocity true false
------------ ---------------- ----------------------- ------- ----------------------------------------------------------------- --------- ----------------
julia> rmSingle("eke")
ERROR: UndefVarError: `rmSingle` not defined in `Main`
Suggestion: check for spelling errors or missing imports.
julia> isSingle("eke",throw=false) # don't throw error, just show warning
ERROR: UndefVarError: `isSingle` not defined in `Main`
Suggestion: check for spelling errors or missing imports.Custom PressureLevel variables
In ERA5Reanalysis.jl, we have predefined all the pressure-level variables that are available directly from the CDS. As such, all custom PressureLevel variables are defined under the PressureCustom type.
Defining Custom PressureLevel Variables
PressureCustom variables are defined using the PressureVariable() function, as follows:
ERA5Reanalysis.PressureVariable Type
julia
PressureVariable(
ST = String;
ID :: AbstractString,
long :: AbstractString = "",
name :: AbstractString,
units :: AbstractString,
hPa :: Int = 0,
throw :: Bool = true
) -> evar :: PressureCustomCreate a custom Pressure-Level variable that is not in the default list exported by ERA5Reanalysis.jl. These variables are not available in the CDS store, and so they must be separately calculated from other variables and analyzed.
Keyword Arguments
ID: variable ID (in string format) used in the NetCDF filelong: long-name for variable (used in specifying variable for CDS downloads)name: user-defined variable nameunits: user-defined units of the variablehPa: Pressure level specified in hPa. Default is 0, which indicates all levels.throw: ifhPalevel does not exist andthrowis true, throw error, otherwise find nearest pressure level
Removing Custom PressureLevel Variables
To remove a PressureCustom variable, we can use the rmPressure() function:
Missing docstring.
Missing docstring for rmPressure( varID :: AbstractString ). Check Documenter's build log for details.
An Example!
Let us define the custom variable "vt" for Virtual Temperature, which is a proxy to buoyancy in the atmosphere. Virtual Temperature is calculated from both the water vapour mixing ratio and atmospheric temperature and is given by the formula:
Virtual Temperature has the units "K", and for this example let us define the pressure level height we are interested in to be at 1000 hPa. The resultant PressureCustom variable is given by:
julia
julia> using ERA5Reanalysis
julia> PressureVariable(
ID = "vt",
units = "K",
hPa = 1000,
long = "virtual_temperature",
name = "Virtual Temperature"
)
[33m[1m┌ [22m[39m[33m[1mWarning: [22m[39m2026-02-08T04:03:00.037 - ERA5Reanalysis.jl - "vt" is not a valid PressureVariable identifier, use the function PressureCustom() to add this ERA5Variable to the list.
[33m[1m└ [22m[39m[90m@ ERA5Reanalysis ~/work/ERA5Reanalysis.jl/ERA5Reanalysis.jl/src/variable/is.jl:110[39m
The Pressure-Level Custom Variable "vt" has the following properties:
Variable ID (ID/ncID) : vt
Long Name (long) : virtual_temperature
Variable Name (name) : Virtual Temperature (1000 hPa)
Variable Units (units) : K
Pressure Level (hPa) : 1000
julia> tablePressures()
ERROR: ArgumentError: Each vector in `column_labels` must have the same number of elements as the table columns (7).
julia> rmPressure("vt")
ERROR: UndefVarError: `rmPressure` not defined in `Main`
Suggestion: check for spelling errors or missing imports.
julia> isPressure("vt",throw=false) # don't throw error, just show warning
ERROR: UndefVarError: `isPressure` not defined in `Main`
Suggestion: check for spelling errors or missing imports.