API reference

This page provides an auto-generated summary of the pyremo API.

Top-level functions

`remo_domain`(domain_id, **kwargs)	Creates an xarray dataset containg the domain grid definitions.
`domain_info`(domain_id)	Returns a dictionary containg the domain grid definitions.
`open_remo_dataset`(filename[, options, ...])	Read a REMO dataset.
`update_meta_info`(ds[, id])	Updates meta info of a dataset.
`parse_dates`(ds[, use_cftime, calendar])	Update the time axis of a REMO dataset.
`parse_absolute_time`(time[, use_cftime, calendar])	Update a time axis containg fractional absolute dates.
`preprocess`(ds[, use_cftime])	preprocessing for opening with xr.open_mfdataset
`magic_number`([n, m, o])	returns a magic number for REMO grid boxes.
`magic_numbers`([size])	returns a list magic numbers
`file_pattern`(type[, expid, date, code, ...])	Create a REMO output file pattern

`codes.get_dict`(id)	Returns a dictionary with variable info.
`codes.search`(**kwargs)	Returns a tables with variabl meta data.

`physics.pressure`(ps, ak, bk[, ptop, z_coord])	computes pressure at model levels.
`physics.liquid_water_content`(t, relhum, p[, ...])	computes liquid water content from temperature, pressure and relative humidity.
`physics.specific_humidity`(t, relhum, p[, ...])	computes specific humidity from temperature, pressure and relative humidity.
`physics.relative_humidity`(t, qd, p[, qw, ...])	computes relative humidity from temperature, pressure and specific humidty (qd)
`physics.precipitation_flux`(aprl, aprc)	Precipitation flux `pr` [mm]
`physics.water_vapour`(t)	Partial pressure of water vapour e [Pa].
`physics.specific_humidity_from_dewpoint`(dew, ps)	Specific humidity `huss` [kg/kg].
`physics.relative_humidity_from_dewpoint`(dew, t2m)	Relative humidity `hurs` [%].
`physics.surface_runoff_flux`(runoff, drain)	Surface runoff `mrros` [mm].
`physics.surface_downwelling_shortwave_flux_in_air`(...)	Surface downwelling shortwave flux in air `rsds` [W m-2].
`physics.surface_downwelling_longwave_flux_in_air`(...)	Surface downwelling longwave flux in air `rlds` [W m-2].
`physics.toa_incoming_shortwave_flux`(srad0, ...)	TOA incoming shortwave flux `rsdt` [W m-2].
`physics.water_evapotranspiration_flux`(evap)	Water evapotranspiration flux `evspsbl` [mm].

Pressure interpolation of data on 3D model levels.

`preproc.ERA5Preprocessor`(expid, surflib[, ...])	Preprocessor for ERA5 reanalysis data.
`preproc.CFPreprocessor`(expid, surflib[, ...])	Preprocessor for CF-compliant GCM input datasets.
`preproc.RemoPreprocessor`(expid, surflib[, ...])	Preprocessor for REMO model output used as nesting input.

`preproc.get_gcm_dataset`(ds[, ref_ds, tos, ...])	Creates a global dataset ready for preprocessing.
`preproc.get_gcm_gfile`([scratch])	Create a GFile object for GCM data.
`preproc.remap`(ds, domain_info, vc, surflib)	Remap CF-compliant GCM/analysis data to a REMO target domain.
`preproc.remap_remo`(ds, domain_info, vc, surflib)	Remap nested REMO (external model) output to a higher-resolution REMO domain.
`preproc.remap_era_soil`(ds, domain_info, surflib)	Create an initial soil dataset from ERA/analysis inputs on a REMO domain.
`preproc.ERA5`([params, cat, gridfile, ...])	Class for cmorizing original ERA5 GRIB data.
`preproc.ERA5.gfile`(date[, path, expid, ...])	Create an ERA5 gfile NetCDF containing required variables.

`tutorial.open_dataset`([name, cache, ...])	Open a dataset from the online repository (requires internet).
`tutorial.load_dataset`(args, *kwargs)	Open, load into memory, and close a dataset from the online repository (requires internet).