intake-esgf

Programmatic access to the ESGF holdings

https://github.com/esgf2-us/intake-esgf

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Programmatic access to the ESGF holdings

Basic Info
Statistics
  • Stars: 24
  • Watchers: 1
  • Forks: 9
  • Open Issues: 20
  • Releases: 13
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation Codeowners

README.md

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:

bash python -m pip install intake-esgf

or conda-forge:

bash 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.

Owner

  • Name: Earth System Grid Federation 2 - US
  • Login: esgf2-us
  • Kind: organization
  • Location: United States

The next generation global network of Earth system model (ESM) data

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this tool, please cite using the information below!"
authors:
  # add additional entries for each author -- see https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
  - family-names: Collier
    given-names: Nathan
    orcid: https://orcid.org/0000-0002-7367-3981 # optional
    website: https://github.com/nocollier
    affiliation: Oak Ridge National Laboratory # optional
  - family-names: Grover
    given-names: Maxwell
    orcid: https://orcid.org/0000-0002-0370-8974
    website: https://github.com/mgrover1
    affiliation: Argonne National Laboratory
  - family-names: Stachelek
    given-names: Jemma
    orcid: https://orcid.org/0000-0002-5924-2464
    website: https://github.com/jsta
    affiliation: Los Alamos National Laboratory
  - family-names: Huard
    given-names: David
    orcid: "https://orcid.org/0000-0003-0311-5498"
    website: https://github.com/huard
    affiliation: Ouranos
  - family-names: Andela
    given-names: Bouwe
    orcid: https://orcid.org/0000-0001-9005-8940
    website: https://github.com/bouweandela
    affiliation: Netherlands eScience Center

title: "intake-esgf"
abstract: "Programmatic access to the Earth System Grid Federation (ESGF) holdings"

GitHub Events

Total
  • Create event: 32
  • Issues event: 34
  • Release event: 6
  • Watch event: 11
  • Delete event: 26
  • Issue comment event: 84
  • Push event: 65
  • Pull request review comment event: 1
  • Pull request review event: 22
  • Pull request event: 65
  • Fork event: 3
Last Year
  • Create event: 32
  • Issues event: 34
  • Release event: 6
  • Watch event: 11
  • Delete event: 26
  • Issue comment event: 84
  • Push event: 65
  • Pull request review comment event: 1
  • Pull request review event: 22
  • Pull request event: 65
  • Fork event: 3

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 15
  • Total pull requests: 32
  • Average time to close issues: 2 months
  • Average time to close pull requests: 1 day
  • Total issue authors: 8
  • Total pull request authors: 4
  • Average comments per issue: 0.53
  • Average comments per pull request: 0.66
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 14
  • Pull requests: 32
  • Average time to close issues: 7 days
  • Average time to close pull requests: 1 day
  • Issue authors: 8
  • Pull request authors: 4
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.66
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • nocollier (23)
  • bouweandela (6)
  • lee1043 (2)
  • jsta (2)
  • kuchaale (1)
  • huard (1)
  • senclimate (1)
  • benkirk (1)
  • alexkjames (1)
  • Klemet (1)
  • jpnavarro (1)
Pull Request Authors
  • nocollier (49)
  • mgrover1 (9)
  • bouweandela (6)
  • jbusecke (1)
  • jsta (1)
  • benkirk (1)
  • huard (1)
  • alexkjames (1)
  • lee1043 (1)
  • neumanbrett (1)
Top Labels
Issue Labels
bug (3) enhancement (3) discussion (2)
Pull Request Labels
enhancement (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,757 last-month
  • Total docker downloads: 48
  • Total dependent packages: 1
  • Total dependent repositories: 0
  • Total versions: 13
  • Total maintainers: 2
pypi.org: intake-esgf

Programmatic access to the ESGF holdings

  • Documentation: https://intake-esgf.readthedocs.io/
  • License: Copyright 2024 onwards Earth System Grid Federation 2 - US Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Latest release: 2025.7.16
    published 7 months ago
  • Versions: 13
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 1,757 Last month
  • Docker Downloads: 48
Rankings
Dependent packages count: 10.0%
Average: 37.9%
Dependent repos count: 65.8%
Maintainers (2)
Last synced: 6 months ago