# ecgtools
| CI | [![GitHub Workflow Status][github-ci-badge]][github-ci-link] [![Code Coverage Status][codecov-badge]][codecov-link] [![pre-commit.ci status][pre-commit.ci-badge]][pre-commit.ci-link] |
| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| **Docs** | [![Documentation Status][rtd-badge]][rtd-link] |
| **Package** | [![Conda][conda-badge]][conda-link] [![PyPI][pypi-badge]][pypi-link] |
| **License** | [![License][license-badge]][repo-link] |
## Motivation
The critical requirement for using [`intake-esm`](https://github.com/intake/intake-esm) is having a data catalog. This package enables you to build data catalogs to be read in by [`intake-esm`](https://github.com/intake/intake-esm), which enables a user to easily search, discover, and access datasets they are interested in using.
See [documentation](https://ecgtools.readthedocs.io) for more information.
## Installation
ecgtools can be installed from PyPI with pip:
```bash
python -m pip install ecgtools
```
It is also available from conda-forge for conda installations:
```bash
conda install -c conda-forge ecgtools
```
[github-ci-badge]: https://github.com/ncar-xdev/ecgtools/actions/workflows/ci.yaml/badge.svg
[github-ci-link]: https://github.com/ncar-xdev/ecgtools/actions/workflows/ci.yaml
[codecov-badge]: https://img.shields.io/codecov/c/github/ncar-xdev/ecgtools.svg?logo=codecov
[codecov-link]: https://codecov.io/gh/ncar-xdev/ecgtools
[rtd-badge]: https://img.shields.io/readthedocs/ecgtools/latest.svg
[rtd-link]: https://ecgtools.readthedocs.io/en/latest/?badge=latest
[pypi-badge]: https://img.shields.io/pypi/v/ecgtools?logo=pypi
[pypi-link]: https://pypi.org/project/ecgtools
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/ecgtools?logo=anaconda
[conda-link]: https://anaconda.org/conda-forge/ecgtools
[license-badge]: https://img.shields.io/github/license/ncar-xdev/ecgtools
[repo-link]: https://github.com/ncar-xdev/ecgtools
[pre-commit.ci-badge]: https://results.pre-commit.ci/badge/github/ncar-xdev/ecgtools/main.svg
[pre-commit.ci-link]: https://results.pre-commit.ci/latest/github/ncar-xdev/ecgtools/main
Raw data
{
"_id": null,
"home_page": "https://github.com/ncar-xdev/ecgtools",
"name": "ecgtools",
"maintainer": "NCAR XDev Team",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "xdev@ucar.edu",
"keywords": "ecgtools",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/8d/95/9c38f77e824cd503eed597ea5e9d6de361b33f0737d20e1264dd98fcc16b/ecgtools-2024.7.31.tar.gz",
"platform": null,
"description": "# ecgtools\n\n| CI | [![GitHub Workflow Status][github-ci-badge]][github-ci-link] [![Code Coverage Status][codecov-badge]][codecov-link] [![pre-commit.ci status][pre-commit.ci-badge]][pre-commit.ci-link] |\n| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |\n| **Docs** | [![Documentation Status][rtd-badge]][rtd-link] |\n| **Package** | [![Conda][conda-badge]][conda-link] [![PyPI][pypi-badge]][pypi-link] |\n| **License** | [![License][license-badge]][repo-link] |\n\n## Motivation\n\nThe critical requirement for using [`intake-esm`](https://github.com/intake/intake-esm) is having a data catalog. This package enables you to build data catalogs to be read in by [`intake-esm`](https://github.com/intake/intake-esm), which enables a user to easily search, discover, and access datasets they are interested in using.\n\nSee [documentation](https://ecgtools.readthedocs.io) for more information.\n\n## Installation\n\necgtools can be installed from PyPI with pip:\n\n```bash\npython -m pip install ecgtools\n```\n\nIt is also available from conda-forge for conda installations:\n\n```bash\nconda install -c conda-forge ecgtools\n```\n\n[github-ci-badge]: https://github.com/ncar-xdev/ecgtools/actions/workflows/ci.yaml/badge.svg\n[github-ci-link]: https://github.com/ncar-xdev/ecgtools/actions/workflows/ci.yaml\n[codecov-badge]: https://img.shields.io/codecov/c/github/ncar-xdev/ecgtools.svg?logo=codecov\n[codecov-link]: https://codecov.io/gh/ncar-xdev/ecgtools\n[rtd-badge]: https://img.shields.io/readthedocs/ecgtools/latest.svg\n[rtd-link]: https://ecgtools.readthedocs.io/en/latest/?badge=latest\n[pypi-badge]: https://img.shields.io/pypi/v/ecgtools?logo=pypi\n[pypi-link]: https://pypi.org/project/ecgtools\n[conda-badge]: https://img.shields.io/conda/vn/conda-forge/ecgtools?logo=anaconda\n[conda-link]: https://anaconda.org/conda-forge/ecgtools\n[license-badge]: https://img.shields.io/github/license/ncar-xdev/ecgtools\n[repo-link]: https://github.com/ncar-xdev/ecgtools\n[pre-commit.ci-badge]: https://results.pre-commit.ci/badge/github/ncar-xdev/ecgtools/main.svg\n[pre-commit.ci-link]: https://results.pre-commit.ci/latest/github/ncar-xdev/ecgtools/main\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "ESM Catalog Generation Utilities",
"version": "2024.7.31",
"project_urls": {
"Documentation": "https://ecgtools.readthedocs.io/",
"Homepage": "https://github.com/ncar-xdev/ecgtools",
"Source": "https://github.com/ncar-xdev/ecgtools",
"Tracker": "https://github.com/ncar-xdev/ecgtools/issues"
},
"split_keywords": [
"ecgtools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6031e51f20c85d78511e828ccebfa97287cdc8e9f291611bc6f526ef3ccf9a39",
"md5": "cdcdc1400a4f57402f907fce767af4d1",
"sha256": "dd36ffaaeb0ab5a93afa9b7c84ef7a46af7d2183d1f38ccd68fc8545a4d96469"
},
"downloads": -1,
"filename": "ecgtools-2024.7.31-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cdcdc1400a4f57402f907fce767af4d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 16487,
"upload_time": "2024-07-31T11:42:52",
"upload_time_iso_8601": "2024-07-31T11:42:52.760866Z",
"url": "https://files.pythonhosted.org/packages/60/31/e51f20c85d78511e828ccebfa97287cdc8e9f291611bc6f526ef3ccf9a39/ecgtools-2024.7.31-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8d959c38f77e824cd503eed597ea5e9d6de361b33f0737d20e1264dd98fcc16b",
"md5": "1e92e64baba423927ae4bbde7f60405b",
"sha256": "3111972388ac2f04f84de1e1a5b40596d131d1ea2dd675a1cce50433b8bb5c3e"
},
"downloads": -1,
"filename": "ecgtools-2024.7.31.tar.gz",
"has_sig": false,
"md5_digest": "1e92e64baba423927ae4bbde7f60405b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16556103,
"upload_time": "2024-07-31T11:42:54",
"upload_time_iso_8601": "2024-07-31T11:42:54.691566Z",
"url": "https://files.pythonhosted.org/packages/8d/95/9c38f77e824cd503eed597ea5e9d6de361b33f0737d20e1264dd98fcc16b/ecgtools-2024.7.31.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-31 11:42:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ncar-xdev",
"github_project": "ecgtools",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "cf_xarray",
"specs": []
},
{
"name": "joblib",
"specs": []
},
{
"name": "netCDF4",
"specs": []
},
{
"name": "xarray",
"specs": []
},
{
"name": "pyyaml",
"specs": []
},
{
"name": "pydantic",
"specs": [
[
">=",
"2.0"
]
]
},
{
"name": "pandas",
"specs": []
},
{
"name": "fsspec",
"specs": []
},
{
"name": "intake-esm",
"specs": [
[
">=",
"2023.7.7"
]
]
}
],
"lcname": "ecgtools"
}