Skip to main content

Programmatic access to the ESGF holdings

Project description

intake-esgf

Badges

Continuous Integration Documentation Status Code Coverage Status PyPI Conda Zenodo

Announcement

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.

Overview

intake-esgf is an intake-esm inspired package under development in ESGF2. The main difference is that in place of querying a static index which is completely loaded at runtime, intake-esgf catalogs initialize empty and are populated by searching, querying ESGF index nodes.

Installation

You may install intake-esgf using pip:

python -m pip install intake-esgf

or conda-forge:

conda install -c conda-forge intake-esgf

Features

For a full listing of features with code examples, please consult the documentation. In brief, intake-esgf aims to hide some of the complexity of obtaining ESGF data and get the user the data 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

intake_esgf-2026.4.28.tar.gz (102.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

intake_esgf-2026.4.28-py3-none-any.whl (66.9 kB view details)

Uploaded Python 3

File details

Details for the file intake_esgf-2026.4.28.tar.gz.

File metadata

  • Download URL: intake_esgf-2026.4.28.tar.gz
  • Upload date:
  • Size: 102.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for intake_esgf-2026.4.28.tar.gz
Algorithm Hash digest
SHA256 0d33cefaa675a4e702b0dc443d0f7cd4191b16784d153df30a7a210529ea6e97
MD5 0e6f9e5db61c3ac0b6dc758767e13581
BLAKE2b-256 62a650e809c2f907ec7a53763e3458fdb7b0cabe617b4d724e1e75e833ab4612

See more details on using hashes here.

File details

Details for the file intake_esgf-2026.4.28-py3-none-any.whl.

File metadata

  • Download URL: intake_esgf-2026.4.28-py3-none-any.whl
  • Upload date:
  • Size: 66.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for intake_esgf-2026.4.28-py3-none-any.whl
Algorithm Hash digest
SHA256 36dbb071d67ecd51ec5a3a16861810bf301a06cf09858c423a0a4d89946dbec4
MD5 3349d48dbea85c7fab4ce1e43de5bb69
BLAKE2b-256 0b52a678d3d349fc346c44462dbc3600f238ee225e6b648ff4898a10645cdfd9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page