Vortex-cen Resources

Specific CEN data resources.

flow.py

Abstract base classes for all SURFEX/Crocus IO flow resources.

Inheritance diagram of vortex_cen.data.flow
class vortex_cen.data.flow.SurfaceIO(*args, **kw)[source]

Bases: GeoFlowResource

Abstract base classe for all surface IO flow resources used in snowpack simulations. SurfaceIO resources are NetCDF files covering a time period defined by the datebegin and dateend footprints. Note that the date and cutoff footprints comonly used in NWP applications are optional and used only in an operational context.

clscontents

The class instantiated to read the container’s content

cutoff

The cutoff type of the generating process.

date

The generating process run date.

datebegin

First date of the forcing file

dateend

Last date of the forcing file

generic_pathinfo()

Returns anonymous dict with suitable informations from vortex point of view. Doomed to be overwritten.

geometry

The resource’s massif geometry.

model

The model name (from a source code perspective).

namebuilding_info()

Returns anonymous dict with suitable informations from vortex point of view. In real world, probably doomed to return an empty dict.

nativefmt

The resource’s storage format.

property realkind

Actual footprint kind, by default the clskind.

class vortex_cen.data.flow.SurfaceIOVortex1(*args, **kw)[source]

Bases: SurfaceIO

This class is here for retro-compatibilty with resources produced before the migration to vortex2

surfex.py

SURFEX/Crocus output resources.

Inheritance diagram of Prep
Inheritance diagram of Pro
Inheritance diagram of PrepVortex1
Inheritance diagram of ProVortex1
class vortex_cen.data.surfex.Pro(*args, **kw)[source]

Bases: SurfaceIO

Class for the SURFEX/Crocus output files.

class vortex_cen.data.surfex.Prep(*args, **kw)[source]

Bases: InitialCondition

Class for the SURFEX-Crocus initialisation of the snowpack state.

class vortex_cen.data.surfex.ProVortex1(*args, **kw)[source]

Bases: SurfaceIOVortex1

Class for the SURFEX/Crocus output files.

class vortex_cen.data.surfex.PrepVortex1(*args, **kw)[source]

Bases: InitialCondition

Class for the SURFEX-Crocus initialisation of the snowpack state.

consts.py

Specific CEN “genv” resources.

Inheritance diagram of vortex_cen.data.consts
class vortex_cen.data.consts.SAFRANList(*args, **kw)[source]

Bases: GenvModelGeoResource

Not documented yet.

class vortex_cen.data.consts.Params(*args, **kw)[source]

Bases: GenvModelGeoResource

Not documented yet.

class vortex_cen.data.consts.climTG(*args, **kw)[source]

Bases: GenvModelGeoResource

Ground temperature climatological resource.

class vortex_cen.data.consts.GridTarget(*args, **kw)[source]

Bases: GenvModelGeoResource

Resource describing a grid for interpolation of data based on massifs geometry

class vortex_cen.data.consts.Prosnow_SetUp_Global(*args, **kw)[source]

Bases: GenvModelResource

Prosnow general setup file.

This class was implemented by C. Carmagnola in April 2019 (PROSNOW project).

class vortex_cen.data.consts.Prosnow_SetUp_Resort(*args, **kw)[source]

Bases: GenvModelResource

Prosnow ski-resort setup file.

This class was implemented by C. Carmagnola in April 2019 (PROSNOW project).

meteo.py

Resources related to SURFEX/Crocus meteorological FORCINGs

Inheritance diagram of vortex_cen.data.meteo
class vortex_cen.data.meteo.SurfaceForcing(*args, **kw)[source]

Bases: SurfaceIO

Class for all kind of meteorological forcing files. Files containing only some meteorological forcing variables can be identsince forcing different kind, which may be usefull for the developpement of EDELWEISS while forcing variables come from different sources (SAFRAN, PE-AROME, ANTILOPE,…)

class vortex_cen.data.meteo.SurfaceForcingVortex1(*args, **kw)[source]

Bases: SurfaceIOVortex1

This class is here for retro-compatibilty with resources produced before the migration to vortex2

obs.py

Snow observation resources

Inheritance diagram of vortex_cen.data.obs
class vortex_cen.data.obs.SnowObs(*args, **kw)[source]

Bases: GeoFlowResource

Abstract class for snow observations in netcdf format (unknown time management)

class vortex_cen.data.obs.SnowObsPeriod(*args, **kw)[source]

Bases: SnowObs

Snow observations covering a time period in netcdf format

class vortex_cen.data.obs.SnowObsOneDate(*args, **kw)[source]

Bases: SnowObs

Snow observations covering at a given date in netcdf format

class vortex_cen.data.obs.SurfaceObservations(*args, **kw)[source]

Bases: SurfaceIO

Class for all kind of meteorological observation files.

assim.py

SODA output resources

Inheritance diagram of vortex_cen.data.assim
class vortex_cen.data.assim.PfSample(*args, **kw)[source]

Bases: GeoFlowResource

Class for SODA particle filter outputs (text files at each assim step)

safran.py

SAFRAN-specific flow resources.

Inheritance diagram of vortex_cen.data.safran
class vortex_cen.data.safran.SafranGuess(*args, **kw)[source]

Bases: GeoFlowResource

Class for the guess file (P ou E file) that is used by SAFRAN.

class vortex_cen.data.safran.SafranObsRaw(*args, **kw)[source]

Bases: ObsRaw

Not documented yet.

class vortex_cen.data.safran.SafranPackedFiles(*args, **kw)[source]

Bases: CenPackedFiles

Class for SAFRAN archives.

class vortex_cen.data.safran.SafranPackedFilesVortex1(*args, **kw)[source]

Bases: GeoFlowResource

Class for SAFRAN archives.

packedfiles.py

Packed resources (tar files) including several small files.

Inheritance diagram of vortex_cen.data.packedfiles
class vortex_cen.data.packedfiles.CenPackedFiles(*args, **kw)[source]

Bases: GeoFlowResource

Abstract class for CEN archives to reduce the number of small files.

class vortex_cen.data.packedfiles.SurfexPackedFiles(*args, **kw)[source]

Bases: CenPackedFiles

Class for Surfex packed files.

postprocess.py

SURFEX/Crocus post-processing resources.

Inheritance diagram of vortex_cen.data.postprocess
class vortex_cen.data.postprocess.Postproc(*args, **kw)[source]

Bases: SurfaceIO

Class for post-processed SURFEX/Crocus output files.

class vortex_cen.data.postprocess.ScoresSnow(*args, **kw)[source]

Bases: SurfaceIO

Class for scores of snow simulations.

class vortex_cen.data.postprocess.PostprocVortex1(*args, **kw)[source]

Bases: SurfaceIOVortex1

Class for post-processed SURFEX/Crocus output files.

class vortex_cen.data.postprocess.ScoresSnowVortex1(*args, **kw)[source]

Bases: SurfaceIOVortex1

Class for scores of snow simulations.

executables.py

Specific CEN executables.

Inheritance diagram of vortex_cen.data.executables
class vortex_cen.data.executables.Safran(*args, **kw)[source]

Bases: SurfaceModel

Base class for the Safran model executables.

class vortex_cen.data.executables.SafranGribFiltering(*args, **kw)[source]

Bases: Script

Base class for the creation of P files used by SAFRAN.