Skip to main content

intake-esgf

Badges

Continuous Integration Documentation Status Code Coverage Status PyPI Conda Zenodo

Announcement

There are important ESGF changes to note as you use intake-esgf:

  1. CMIP7 data is now available and therefore has become the default project. If you have old scripts that you wish to still be operational, you will need to add project="CMIP6" to your search.
  2. ESGF has decomissioned the old index technology (Solr). However, some Solr indices may still be running and intake-esgf will still be able to interact with them, but they are not configured by default. By default, we enable:
    • ESGF2-US-1.5-Catalog, a globus-based index with information about previous projects apart from CMIP7. This includes most anything from a previous US-based Solr index.
    • Two STAC-based indices (discovery.east.esgf.io and discovery.west.esgf.io). Long-term these indices will be identical and you will only want one of them enabled. While publishing (CMIP7 and some older projects) is ramping up, you may find they differ slightly and so we leave them both enabled for now.
  3. While republishing of CMIP6 data to the new STAC indices is underway, we have found a publishing bug which has lead to many dataset records appearing to have a member_id with a sub_experiment_id prepended when it does not belong. Something like s2000-r1i1p1f1 when it should be just r1i1p1f1. If you encounter this problem in your searches for CMIP6 data, we recomment disabling the STAC indices while we sort out the problem:
intake_esgf.conf.set(indices={'discovery.east.esgf.io':False,'discovery.west.esgf.io': False})

Overview

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.

Installation

You may install intake-esgf using pip:

python -m pip install intake-esgf

or conda-forge:

conda install -c conda-forge intake-esgf

Once installed, you can verify installation with a 5 minute automated tutorial with:

python -m intake_esgf

Metadata

Release files for intake-esgf 2026.11.28

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for intake-esgf 2026.11.28
File Size Uploaded Provenance Actions
intake_esgf-2026.11.28.tar.gz 729.2 kB Without provenance Details for intake_esgf-2026.11.28.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for intake-esgf 2026.11.28
File Interpreter ABI Platform Actions
intake_esgf-2026.11.28-py3-none-any.whl Python 3 none any Details for intake_esgf-2026.11.28-py3-none-any.whl

Total release size: 802.8 kB

Release files / intake_esgf-2026.11.28.tar.gz

Download URL intake_esgf-2026.11.28.tar.gz
Size 729.2 kB
Tags Source
SHA-256 checksum
How to use checksums
8df2cc4771cfb61a128550eb7bfcb0a790b96c6861355f154352f1b13b4ecaf8
BLAKE2b-256 checksum
How to use checksums
49b4cf18213c0d2133a7765d89058c6c658ac04dcf75ee4fa5ee47ba6380cdec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / intake_esgf-2026.11.28-py3-none-any.whl

Download URL intake_esgf-2026.11.28-py3-none-any.whl
Size 73.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3eca2a75a55c6018101e25b7c6d88ebd1df419a0f2527eb552bed9f99a11b5b7
BLAKE2b-256 checksum
How to use checksums
0b1046ac60b5eeb0b4367534aa52e89bd8086ae1087ffaf952ee86b26c07cbc9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for intake-esgf 2026.11.28

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page