cmiputil

README

What is this ?

This is a collection of small python modules for CMIP6/ESGF data users.

These modules has been developed to support researchers who use CMIP6 data via ESGF, under the ongoing project called TOUGOU Program. So this is NOT an official CMIP/ESGF product.

Currently there are a few modules listed below:

  • esgfsearch: Search and access datasets using ESGF RESTful API and THREDDS.

  • drs: Handle DRS-complient directory name and file name.

  • convoc: Handle CMIP6 CVs.

  • timer: Measure execution time.

  • braceexpand: Bash-style brace expansion for Python

braceexpand.py

This package includes and uses braceexpand.py obtained from https://github.com/trendels/braceexpand, under MIT license.

See README.braceexpand for details, LICENSE.braceexpand for it’s license.

You may want

If you want to search and download datasets, you should use synda, which is highly comprehensive useful and reliable.

Requirement

This package has been developed under this environment only:

  • python 3.7.3

  • siphon 0.8.0

  • netCDF4 1.5.1.2

  • urllib3 1.24.1

For tests and examples:

  • xarray 0.11.3

For creating documents:

  • sphinx 2.1.2

  • sphinx-readable-theme 1.3.0

  • sphinxcontrib-fulltoc 1.2.0

  • sphinxcontrib-autoprogram 0.1.5

Install

You can get from https://github.com/RIST-tinoue/cmiputil

$ git clone https://github.com/RIST-tinoue/cmiputil
$ cd cmiputil
$ python ./setup.py develop   # <- strongly recommended for a while.

Usage

$ python3
>>> from cmiputil import esgfsearch
>>> help(esgfsearch)
>>> from cmiputil import drs
>>> help(drs)
>>> from cmiputil import convoc
>>> help(convoc)

See also each pydoc, tests, and sample applications.

Document

See HTML Documentation.

Author

Takahiro Inoue

Copyright © 2019, RIST

Indices and tables