ESGF is in the process of decomissioning the old index technology (Solr). While this process takes place, you may find some services may be broken or disappear completely. The information in the US-based Solr indices has been moved into a Globus (ElasticSearch) index which is this package's default index. As the federation prepares for CMIP7, we will enable a new/additional index architecure based on the Spatio Temporal Asset Catalog (STAC) specification.
intake-esgf gives you programmatic access to ESGF holdings. We aim to hide some of the complexity of obtaining ESGF data and get it to the user as fast as we can.
- Indices are queried in parallel and report when they fail to return a response. The results are aggregated and presented to the user as a pandas DataFrame.
- The locations of the data are hidden from the user. Internally we track which locations provide the user the fastest transfers and automatically favor them for you.
- Files are downloaded in parallel into a local cache which mirrors the remote storage directory structure. They are returned to the user as a dictionary of xarray Datasets. Your search script then becomes the way you download data as well as how you load it into memory for your analysis.
- Prior to downloading data, we first check that it is not already available locally. This could be because you had previously downloaded it, but also because you are working on a server that has direct access.
- Cell measure information is harvested from your search results and automatically included in the returned datasets.
- The old (Solr) and new (STAC) index types are supported simultaneously.
For a full listing of features with code examples, please consult the documentation.
You may install intake-esgf using pip:
python -m pip install intake-esgfor conda-forge:
conda install -c conda-forge intake-esgfOnce installed, you can verify installation with a 5 minute automated tutorial with:
python -m intake_esgf