Package index

O3as package with utilities to handle ozone data skimming.

o3skim.process(dataset, actions)[source]

Function in charge of processing the list of o3skim operations to the ozone variables dataset. The available list of operations to perform are:

lon_mean

Longitudinal mean accross the dataset.

lat_mean

Latitudinal mean accross the dataset.

Note that multiple operations can be concatenated. For example using the list [‘lon_mean’, ‘lat_mean’] as actions parameter input would perform a longitudinal mean followed afterwards by a latitudinal mean before returning the result.

Parameters
  • dataset (xarray.Dataset) – Original o3 dataset where to perform operations.

  • actions (list) – List of operation names to perform.

Returns

Dataset after processing listed operations.

Return type

xarray.Dataset

o3skim.save(dataset, target, split_by=None)[source]

Function in charge of saving the input dataset into the file system using an specified time range. The available type of output file formats are:

None

Output file format is {target}.nc

year

Output file format is {target}_{y}-{y+01}.nc

decade

Output file format is {target}_{y}-{y+10}.nc

Parameters
  • dataset (xarray.DataSet) – DataSet to save in the target.

  • target (str) – Location where to save followed by the name prefix.

  • split_by (str, optional) – Type of saving format to apply.

o3skim loads

Module in charge of model data loading.

o3skim.loads.ccmi(variable, paths)[source]

Loads and returns a CCMI-1 DataArray model and the dataset attributes.

Parameters
  • variable (str) – Variable to load from the dataset.

  • paths (str or [str]) – Paths expression to the dataset netCDF files.

Returns

Standardized DataArray.

Return type

(xarray.DataArray, dict)

o3skim.loads.ecmwf(variable, paths)[source]

Loads and returns a ECMWF DataArray model and the dataset attributes.

Parameters
  • variable (str) – Variable to load from the dataset.

  • paths (str or [str]) – Paths expression to the dataset netCDF files.

Returns

Standardized DataArray.

Return type

(xarray.DataArray, dict)

o3skim.loads.esacci(variable, time_position, paths)[source]

Loads and returns a ESACCI DataArray model and the dataset attributes. Note the name structure is composed by sections: For example: ESACCI-OZONE-L3S-TC-MERGED-DLR_1M-20010302-fv0100. Therefore is needed to indicate the position in the string for the dataset time (7 or -2 for the case above).

Parameters
  • variable (str) – Variable to load from the dataset.

  • time_position (int) – Name position for the dataset time.

  • paths (str or [str]) – Paths expression to the dataset netCDF files.

Returns

Standardized DataArray.

Return type

(xarray.DataArray, dict)

o3skim.loads.sbuv(textfile, delimiter)[source]

Loads and returns a SBUV DataArray model and the dataset attributes. Note SBUV models do not have longitude coordinate.

Parameters
  • textfile (str) – Location to the textfile with model information.

  • delimiter (str or [str]) – Delimiter character for row values on the table.

Returns

Standardized DataArray.

Return type

(xarray.DataArray, {})

o3skim normalization

Module in charge of dataset normalization when loading models.

o3skim.normalization.run(datarray, variable, **coords)[source]

Standardizes a DataArray.

Returns

Standardized DataArray.

Return type

xarray.DataArray

o3skim operations

Module in charge of implementing the o3skim operations.

o3skim.operations.run(name, dataset)[source]

Main entry point for operation call on o3skimming functions:

lon_mean

Longitudinal mean across the dataset.

lat_mean

Latitudinal mean across the dataset.

year_mean

Time coordinate averaged by year.

Parameters
  • name (str) – Operation name to perform.

  • dataset (xarray.Dataset) – Original o3 dataset where to perform operations.

Returns

Dataset after processing the specified operation.

Return type

xarray.Dataset