Quick Guide

roocs-utils

Pypi Travis Documentation

A package containing common components for the roocs project

Features

    1. Data Inventories

1. Data Inventories

The module roocs_utils.inventory provides tools for writing inventories of the known data holdings in a YAML format, e.g.:

$ python roocs_utils/inventory/inventory.py -pr c3s-cmip5
[INFO] Reading /group_workspaces/jasmin2/cp4cds1/vol1/data/c3s-cmip5/output1/MOHC/HadGEM2-ES/rcp45/mon/atmos/Amon/r1i1p1/tas/v20111                                                                  128/tas_Amon_HadGEM2-ES_rcp45_r1i1p1_212412-214911.nc
[INFO] Reading /group_workspaces/jasmin2/cp4cds1/vol1/data/c3s-cmip5/output1/MOHC/HadGEM2-ES/rcp45/mon/atmos/Amon/r1i1p1/ts/v201111                                                                  28/ts_Amon_HadGEM2-ES_rcp45_r1i1p1_209912-212411.nc
[INFO] Wrote: c3s-cmip5_MOHC_HadGEM2-ES.yml

One file is created for each model/institute pairing. These can be merged to one file using roocs_utils/inventory/merge_yaml.py

Writes:

- base_dir: /group_workspaces/jasmin2/cp4cds1/vol1/data/
  project: c3s-cmip5

- path: c3s-cmip5/output1/MOHC/HadGEM2-ES/rcp45/mon/atmos/Amon/r1i1p1/tas/v20111128
  dsid: c3s-cmip5.output1.MOHC.HadGEM2-ES.rcp45.mon.atmos.Amon.r1i1p1.tas.v20111128
  var_id: tas
  array_dims: time lat lon
  array_shape: 3529 145 192
  time: 2005-12-16T00:00:00 2299-12-16T00:00:00
  facets:
    activity: c3s-cmip5
    ensemble_member: r1i1p1
    experiment: rcp45
    frequency: mon
    institute: MOHC
    mip_table: Amon
    model: HadGEM2-ES
    product: output1
    realm: atmos
    variable: tas
    version: v20111128

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.