| Name | esa-climate-toolbox JSON |
| Version |
1.3
JSON |
| download |
| home_page | None |
| Summary | The ESA CCI Toolbox is designed to provide access to CCI data |
| upload_time | 2024-12-02 21:13:05 |
| maintainer | None |
| docs_url | None |
| author | ESA CCI Toolbox Development Team |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 ESA Climate Change Initiative Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
data science
cci
climate data
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://ci.appveyor.com/project/bcdev/esa-climate-toolbox)
[](https://esa-climate-toolbox.readthedocs.io/en/latest/?badge=latest)
[](https://anaconda.org/conda-forge/esa-climate-toolbox)
[](https://anaconda.org/conda-forge/esa-climate-toolbox)
# ESA CCI Toolbox
The ESA CCI Toolbox is designed to provide access to CCI data from the ESA
Open Data Portal.
Also, it contains functions to operate on this data.
## Installation into a new environment with conda
The ESA CCI Toolbox and all necessary dependencies are available
on [conda-forge](https://conda-forge.org/), and can be installed using the
[conda package manager](https://docs.conda.io/projects/conda/en/latest/).
The conda package manager itself can be obtained in the [miniconda
distribution](https://docs.conda.io/en/latest/miniconda.html).
Once conda is installed, the ESA CCI Toolbox can be installed like this:
```
$ conda create --name ect --channel conda-forge esa-climate-toolbox
$ conda activate ect
```
The name of the environment may be freely chosen.
#### Installation into an existing environment with conda
The ESA CCI Toolbox can also be installed into an existing conda
environment.
To do so, execute this command with the existing environment activated:
```
$ conda install --channel conda-forge esa-climate-toolbox
```
Any necessary dependencies will be installed or updated if they are not already
installed in a compatible version.
#### Installation into an existing environment from the repository
If you want to install the ESA CCI Toolbox directly from the git repository
(for example in order to use an unreleased version or to modify the code),
you can do so as follows:
```
$ git clone https://github.com/esa-cci/esa-climate-toolbox.git
$ cd esa-climate-toolbox
$ conda env create
$ conda activate ect
$ pip install -e .
```
## Testing
You can run the unit tests for the ESA CCI Toolbox by executing
```
$ pytest
```
in the `esa-climate-toolbox` repository.
To create a test coverage report, you can use
```
coverage run --include='esa-climate-toolbox/**' --module pytest
coverage html
```
This will write a coverage report to `htmlcov/index.html`.
## Use
Jupyter notebooks demonstrating the use of the ESA CCI Toolbox can be found
in the `notebooks/` subdirectory of the repository.
## Releasing
To release the `esa-climate-toolbox`, please follow the steps outlined in the
[xcube Developer Guide](https://github.com/dcs4cop/xcube/blob/master/docs/source/devguide.md#release-process).
Raw data
{
"_id": null,
"home_page": null,
"name": "esa-climate-toolbox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "data science, cci, climate data",
"author": "ESA CCI Toolbox Development Team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/4c/8b/98b4e191467abf7f2cc3d6d1ac9b3c885d60a1e24fe782151c3586487e55/esa_climate_toolbox-1.3.tar.gz",
"platform": null,
"description": "[](https://ci.appveyor.com/project/bcdev/esa-climate-toolbox)\n[](https://esa-climate-toolbox.readthedocs.io/en/latest/?badge=latest)\n[](https://anaconda.org/conda-forge/esa-climate-toolbox)\n[](https://anaconda.org/conda-forge/esa-climate-toolbox)\n\n# ESA CCI Toolbox\n\nThe ESA CCI Toolbox is designed to provide access to CCI data from the ESA \nOpen Data Portal. \nAlso, it contains functions to operate on this data.\n\n## Installation into a new environment with conda\n\nThe ESA CCI Toolbox and all necessary dependencies are available\non [conda-forge](https://conda-forge.org/), and can be installed using the\n[conda package manager](https://docs.conda.io/projects/conda/en/latest/).\nThe conda package manager itself can be obtained in the [miniconda\ndistribution](https://docs.conda.io/en/latest/miniconda.html). \nOnce conda is installed, the ESA CCI Toolbox can be installed like this:\n\n```\n$ conda create --name ect --channel conda-forge esa-climate-toolbox\n$ conda activate ect\n```\n\nThe name of the environment may be freely chosen.\n\n#### Installation into an existing environment with conda\n\nThe ESA CCI Toolbox can also be installed into an existing conda \nenvironment.\nTo do so, execute this command with the existing environment activated:\n\n```\n$ conda install --channel conda-forge esa-climate-toolbox\n```\n\nAny necessary dependencies will be installed or updated if they are not already \ninstalled in a compatible version.\n\n#### Installation into an existing environment from the repository\n\nIf you want to install the ESA CCI Toolbox directly from the git repository \n(for example in order to use an unreleased version or to modify the code), \nyou can do so as follows:\n\n```\n$ git clone https://github.com/esa-cci/esa-climate-toolbox.git\n$ cd esa-climate-toolbox\n$ conda env create\n$ conda activate ect\n$ pip install -e .\n```\n\n## Testing\n\nYou can run the unit tests for the ESA CCI Toolbox by executing\n\n```\n$ pytest\n```\n\nin the `esa-climate-toolbox` repository. \n\nTo create a test coverage report, you can use\n\n```\ncoverage run --include='esa-climate-toolbox/**' --module pytest\ncoverage html\n```\n\nThis will write a coverage report to `htmlcov/index.html`.\n\n## Use\n\nJupyter notebooks demonstrating the use of the ESA CCI Toolbox can be found\nin the `notebooks/` subdirectory of the repository.\n\n## Releasing\n\nTo release the `esa-climate-toolbox`, please follow the steps outlined in the \n[xcube Developer Guide](https://github.com/dcs4cop/xcube/blob/master/docs/source/devguide.md#release-process).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 ESA Climate Change Initiative Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "The ESA CCI Toolbox is designed to provide access to CCI data",
"version": "1.3",
"project_urls": {
"Bug Tracker": "https://github.com/esa-cci/esa-climate-toolbox/issues",
"Changelog": "https://github.com/esa-cci/esa-climate-toolbox/CHANGES.md",
"Documentation": "https://esa-climate-toolbox.readthedocs.io",
"Download": "https://pypi.org/project/esa-climate-toolbox/#files",
"Homepage": "https://github.com/esa-cci/esa-climate-toolbox",
"Release notes": "https://github.com/esa-cci/esa-climate-toolbox/releases"
},
"split_keywords": [
"data science",
" cci",
" climate data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3724d4fb460f7a38bd26af64c91118c5174f9efc577047edbd8fc98a18ed8929",
"md5": "fd291884437bfdb7b9868006430b99af",
"sha256": "a54362b60089b1e1ef6b4b149224482a1b5228b11a7663566e2f34f9adc7eaab"
},
"downloads": -1,
"filename": "esa_climate_toolbox-1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fd291884437bfdb7b9868006430b99af",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 389066,
"upload_time": "2024-12-02T21:13:03",
"upload_time_iso_8601": "2024-12-02T21:13:03.799032Z",
"url": "https://files.pythonhosted.org/packages/37/24/d4fb460f7a38bd26af64c91118c5174f9efc577047edbd8fc98a18ed8929/esa_climate_toolbox-1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4c8b98b4e191467abf7f2cc3d6d1ac9b3c885d60a1e24fe782151c3586487e55",
"md5": "1b627fbe57b3c13b6d6b0e5806134576",
"sha256": "14d9eb3a5a865c5286b36b24d4f6c8d7b10cdf8dc74e528087d2e294a1e261c5"
},
"downloads": -1,
"filename": "esa_climate_toolbox-1.3.tar.gz",
"has_sig": false,
"md5_digest": "1b627fbe57b3c13b6d6b0e5806134576",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 13235068,
"upload_time": "2024-12-02T21:13:05",
"upload_time_iso_8601": "2024-12-02T21:13:05.917900Z",
"url": "https://files.pythonhosted.org/packages/4c/8b/98b4e191467abf7f2cc3d6d1ac9b3c885d60a1e24fe782151c3586487e55/esa_climate_toolbox-1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 21:13:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "esa-cci",
"github_project": "esa-climate-toolbox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"appveyor": true,
"lcname": "esa-climate-toolbox"
}
