| Name | xcube-cci JSON |
| Version |
0.11.2
JSON |
| download |
| home_page | None |
| Summary | An xcube plugin that allows generating data cubes from the ESA CCI Open Data Portal. |
| upload_time | 2024-12-02 21:16:02 |
| maintainer | None |
| docs_url | None |
| author | ESA CCI Toolbox Development Team |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2020 DCS4COP 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/xcube-cci)
# xcube-cci
An [xcube plugin](https://xcube.readthedocs.io/en/latest/plugins.html) that allows
generating data cubes from the ESA CCI Open Data Portal.
### Installing the xcube-cci plugin
#### Installation into a new environment with conda
xcube-cci and all necessary dependencies (including xcube itself) 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, xcube-cci can be installed like this:
```
$ conda create --name xcube-cci-environment --channel conda-forge xcube-cci
$ conda activate xcube-cci-environment
```
The name of the environment may be freely chosen.
#### Installation into an existing environment with conda
xcube-cci can also be installed into an existing conda environment.
With an existing conda environment activated, execute this command:
```
$ conda install --channel conda-forge xcube-cci
```
xcube and any other 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 xcube-cci 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/xcube-cci.git
$ cd xcube-cci
$ conda env create
$ conda activate xcube-cci
$ pip install --no-deps -e .
```
## Testing
You can run the unit tests for xcube-cci by executing
```
$ pytest
```
in the `xcube-cci` repository. Note that, in order to successfully run the
tests using the current repository version of xcube-cci, you may also need to
install the repository version of xcube rather than its latest conda-forge
release.
To create a test coverage report, you can use
```
coverage run --include='xcube_cci/**' --module pytest
coverage html
```
This will write a coverage report to `htmlcov/index.html`.
## Use
Jupyter notebooks demonstrating the use of the xcube-cds plugin can be found
in the `examples/notebooks/` subdirectory of the repository.
## Releasing
To release `xcube-cci`, 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": "xcube-cci",
"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/0e/cb/28c07dfba51c0244ad6b6da4cc70983952d05dbccbb3d88eb9bc7a504f54/xcube_cci-0.11.2.tar.gz",
"platform": null,
"description": "[](https://ci.appveyor.com/project/bcdev/xcube-cci)\n\n# xcube-cci\n\nAn [xcube plugin](https://xcube.readthedocs.io/en/latest/plugins.html) that allows \ngenerating data cubes from the ESA CCI Open Data Portal.\n\n### Installing the xcube-cci plugin\n\n#### Installation into a new environment with conda\n\nxcube-cci and all necessary dependencies (including xcube itself) 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, xcube-cci can be installed like this:\n\n```\n$ conda create --name xcube-cci-environment --channel conda-forge xcube-cci\n$ conda activate xcube-cci-environment\n```\n\nThe name of the environment may be freely chosen.\n\n#### Installation into an existing environment with conda\n\nxcube-cci can also be installed into an existing conda environment.\nWith an existing conda environment activated, execute this command:\n\n```\n$ conda install --channel conda-forge xcube-cci\n```\n\nxcube and any other necessary dependencies will be installed or updated if they are not \nalready installed in a compatible version.\n\n#### Installation into an existing environment from the repository\n\nIf you want to install xcube-cci directly from the git repository (for example\nin order to use an unreleased version or to modify the code), you can do so as follows:\n\n```\n$ git clone https://github.com/esa-cci/xcube-cci.git\n$ cd xcube-cci\n$ conda env create\n$ conda activate xcube-cci\n$ pip install --no-deps -e .\n```\n\n## Testing\n\nYou can run the unit tests for xcube-cci by executing\n\n```\n$ pytest\n```\n\nin the `xcube-cci` repository. Note that, in order to successfully run the\ntests using the current repository version of xcube-cci, you may also need to\ninstall the repository version of xcube rather than its latest conda-forge\nrelease.\n\nTo create a test coverage report, you can use\n\n```\ncoverage run --include='xcube_cci/**' --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 xcube-cds plugin can be found\nin the `examples/notebooks/` subdirectory of the repository.\n\n## Releasing\n\nTo release `xcube-cci`, 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) 2020 DCS4COP 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": "An xcube plugin that allows generating data cubes from the ESA CCI Open Data Portal.",
"version": "0.11.2",
"project_urls": {
"Bug Tracker": "https://github.com/esa-cci/xcube-cci/issues",
"Changelog": "https://github.com/esa-cci/xcube-cci/CHANGES.md",
"Download": "https://pypi.org/project/xcube-cci/#files",
"Homepage": "https://github.com/esa-cci/xcube-cci",
"Release notes": "https://github.com/esa-cci/xcube-cci/releases"
},
"split_keywords": [
"data science",
" cci",
" climate data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2caf16d0b321b3116f202b3bc10f9768749e5cf8260d94741172211725399040",
"md5": "67d57e16bd0a9e8800fe23e295753758",
"sha256": "f2d79d4183440ae6527572c531a0a95675fce30feda3945b4ced6d359b9d77f4"
},
"downloads": -1,
"filename": "xcube_cci-0.11.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "67d57e16bd0a9e8800fe23e295753758",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 160280,
"upload_time": "2024-12-02T21:16:00",
"upload_time_iso_8601": "2024-12-02T21:16:00.623430Z",
"url": "https://files.pythonhosted.org/packages/2c/af/16d0b321b3116f202b3bc10f9768749e5cf8260d94741172211725399040/xcube_cci-0.11.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0ecb28c07dfba51c0244ad6b6da4cc70983952d05dbccbb3d88eb9bc7a504f54",
"md5": "5e3a37a42fc8219369f24a9c77150965",
"sha256": "713dc8ad98158d54d8076784f37ea42590445b71f514ce5fa1d2dcb3b271dcc7"
},
"downloads": -1,
"filename": "xcube_cci-0.11.2.tar.gz",
"has_sig": false,
"md5_digest": "5e3a37a42fc8219369f24a9c77150965",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 217234,
"upload_time": "2024-12-02T21:16:02",
"upload_time_iso_8601": "2024-12-02T21:16:02.512252Z",
"url": "https://files.pythonhosted.org/packages/0e/cb/28c07dfba51c0244ad6b6da4cc70983952d05dbccbb3d88eb9bc7a504f54/xcube_cci-0.11.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 21:16:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "esa-cci",
"github_project": "xcube-cci",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"appveyor": true,
"lcname": "xcube-cci"
}
