| Name | intake-esgf JSON |
| Version |
2024.10.25
JSON |
| download |
| home_page | None |
| Summary | An intake-esm inspired catalog for ESGF |
| upload_time | 2024-10-25 21:00:54 |
| maintainer | None |
| docs_url | None |
| author | Nathan Collier |
| requires_python | None |
| license | BSD-3-Clause |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[<img width=250px src=./doc/_static/logo.png>](https://climatemodeling.science.energy.gov/presentations/esgf2-building-next-generation-earth-system-grid-federation)
# intake-esgf
## Badges
[![Continuous Integration][ci-badge]][ci-link]
[![Documentation Status][rtd-badge]][rtd-link]
[![Code Coverage Status][codecov-badge]][codecov-link]
[![PyPI][pypi-badge]][pypi-link]
[![Conda][conda-badge]][conda-link]
[![Zenodo][zenodo-badge]][zenodo-link]
## Overview
`intake-esgf` is an [intake-esm](https://github.com/intake/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](https://pypi.org/project/pip/):
```bash
python -m pip install intake-esgf
```
or [conda-forge](https://conda-forge.org/):
```bash
conda install -c conda-forge intake-esgf
```
## Features
For a full listing of features with code examples, please consult the [documentation](https://intake-esgf.readthedocs.io/en/latest/?badge=latest). 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](https://pandas.pydata.org/) 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](https://xarray.dev/) 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.
[ci-badge]: https://github.com/esgf2-us/intake-esgf/actions/workflows/ci.yml/badge.svg?branch=main
[ci-link]: https://github.com/esgf2-us/intake-esgf/actions/workflows/ci.yml
[rtd-badge]: https://readthedocs.org/projects/intake-esgf/badge/?version=latest
[rtd-link]: https://intake-esgf.readthedocs.io/en/latest/?badge=latest
[codecov-badge]: https://img.shields.io/codecov/c/github/esgf2-us/intake-esgf.svg?logo=codecov
[codecov-link]: https://codecov.io/gh/esgf2-us/intake-esgf
[pypi-badge]: https://img.shields.io/pypi/v/intake-esgf?logo=pypi
[pypi-link]: https://pypi.org/project/intake-esgf
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/intake-esgf?logo=anaconda
[conda-link]: https://anaconda.org/conda-forge/intake-esgf
[zenodo-badge]: https://zenodo.org/badge/691233416.svg
[zenodo-link]: https://zenodo.org/doi/10.5281/zenodo.11104809
Raw data
{
"_id": null,
"home_page": null,
"name": "intake-esgf",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Nathan Collier",
"author_email": "nathaniel.collier@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/81/ca/cb52598d06ed79b10f5b7fece0b94b26bfa2571dc4302216f0f67a6d9c84/intake_esgf-2024.10.25.tar.gz",
"platform": null,
"description": "[<img width=250px src=./doc/_static/logo.png>](https://climatemodeling.science.energy.gov/presentations/esgf2-building-next-generation-earth-system-grid-federation)\n\n# intake-esgf\n\n## Badges\n\n[![Continuous Integration][ci-badge]][ci-link]\n[![Documentation Status][rtd-badge]][rtd-link]\n[![Code Coverage Status][codecov-badge]][codecov-link]\n[![PyPI][pypi-badge]][pypi-link]\n[![Conda][conda-badge]][conda-link]\n[![Zenodo][zenodo-badge]][zenodo-link]\n\n\n## Overview\n\n`intake-esgf` is an [intake-esm](https://github.com/intake/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.\n\n## Installation\n\nYou may install `intake-esgf` using [pip](https://pypi.org/project/pip/):\n\n```bash\npython -m pip install intake-esgf\n```\n\nor [conda-forge](https://conda-forge.org/):\n\n```bash\nconda install -c conda-forge intake-esgf\n```\n## Features\n\nFor a full listing of features with code examples, please consult the [documentation](https://intake-esgf.readthedocs.io/en/latest/?badge=latest). 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.\n\n* 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](https://pandas.pydata.org/) DataFrame.\n* 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.\n* 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](https://xarray.dev/) Datasets. Your search script then becomes the way you download data as well as how you load it into memory for your analysis.\n* 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.\n* Cell measure information is harvested from your search results and automatically included in the returned datasets.\n\n\n[ci-badge]: https://github.com/esgf2-us/intake-esgf/actions/workflows/ci.yml/badge.svg?branch=main\n[ci-link]: https://github.com/esgf2-us/intake-esgf/actions/workflows/ci.yml\n[rtd-badge]: https://readthedocs.org/projects/intake-esgf/badge/?version=latest\n[rtd-link]: https://intake-esgf.readthedocs.io/en/latest/?badge=latest\n[codecov-badge]: https://img.shields.io/codecov/c/github/esgf2-us/intake-esgf.svg?logo=codecov\n[codecov-link]: https://codecov.io/gh/esgf2-us/intake-esgf\n[pypi-badge]: https://img.shields.io/pypi/v/intake-esgf?logo=pypi\n[pypi-link]: https://pypi.org/project/intake-esgf\n[conda-badge]: https://img.shields.io/conda/vn/conda-forge/intake-esgf?logo=anaconda\n[conda-link]: https://anaconda.org/conda-forge/intake-esgf\n[zenodo-badge]: https://zenodo.org/badge/691233416.svg\n[zenodo-link]: https://zenodo.org/doi/10.5281/zenodo.11104809\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "An intake-esm inspired catalog for ESGF",
"version": "2024.10.25",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ca5d9cc729cc186917a4a25dd8deff79a6f1a20ba2d37d8751d46dba7bb32071",
"md5": "5a402c061cd5d9674f11e6b1ac03a0bd",
"sha256": "eb384b39b265a830927a52879a7cbcfb439b3345058f61d9f6047a328146340d"
},
"downloads": -1,
"filename": "intake_esgf-2024.10.25-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a402c061cd5d9674f11e6b1ac03a0bd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 35618,
"upload_time": "2024-10-25T21:00:52",
"upload_time_iso_8601": "2024-10-25T21:00:52.572387Z",
"url": "https://files.pythonhosted.org/packages/ca/5d/9cc729cc186917a4a25dd8deff79a6f1a20ba2d37d8751d46dba7bb32071/intake_esgf-2024.10.25-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "81cacb52598d06ed79b10f5b7fece0b94b26bfa2571dc4302216f0f67a6d9c84",
"md5": "935b97ab2447fc6051c4a0dd5b2ab37e",
"sha256": "94df9198b8a841e28d6d2efedb8823a777d3dd8bf3032dfa6837e1688c8e6928"
},
"downloads": -1,
"filename": "intake_esgf-2024.10.25.tar.gz",
"has_sig": false,
"md5_digest": "935b97ab2447fc6051c4a0dd5b2ab37e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 438281,
"upload_time": "2024-10-25T21:00:54",
"upload_time_iso_8601": "2024-10-25T21:00:54.263082Z",
"url": "https://files.pythonhosted.org/packages/81/ca/cb52598d06ed79b10f5b7fece0b94b26bfa2571dc4302216f0f67a6d9c84/intake_esgf-2024.10.25.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 21:00:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "intake-esgf"
}
