Welcome to esgf-pyclient documentation!

ESGF Pyclient is a Python package designed for interacting with the Earth System Grid Federation system. Current there are interfaces to the ESGF Search and Security systems.

ESGF Pyclient is currently in development. Contributions to development are gratefully received. Anyone wishing to contribute or give feedback can do so through the project github site.

Getting Started

The package can be downloaded via pip or easy_install:

$ pip install esgf-pyclient
$ easy_install esgf-pyclient

You can also download the tarball from http://pypi.python.org/pypi/esgf-pyclient and install manually as follows:

$ tar zxf esgf-pyclient-*.tar.gz
$ cd esgf-pyclient-*.tar.gz
$ python setup.py install

Or you can install it using conda:

$ conda install -c conda-forge esgf-pyclient

If you want to follow the latest code and/or make contributions the source code is available on github at https://github.com/ESGF/esgf-pyclient

Once installed you import the package as the name pyesgf. See the recipes for examples.

Indices and tables