cloudnetpy


Namecloudnetpy JSON
Version 1.65.8 PyPI version JSON
download
home_pageNone
SummaryPython package for Cloudnet processing
upload_time2024-09-06 06:38:49
maintainerNone
docs_urlNone
authorSimo Tukiainen
requires_python>=3.10
licenseMIT License Copyright (c) 2019-2022 Finnish Meteorological Institute 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
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # CloudnetPy

[![CloudnetPy CI](https://github.com/actris-cloudnet/cloudnetpy/actions/workflows/test.yml/badge.svg)](https://github.com/actris-cloudnet/cloudnetpy/actions/workflows/test.yml)
[![PyPI version](https://badge.fury.io/py/cloudnetpy.svg)](https://badge.fury.io/py/cloudnetpy)
[![DOI](https://zenodo.org/badge/233602651.svg)](https://zenodo.org/badge/latestdoi/233602651)
[![status](https://joss.theoj.org/papers/959971f196f617dddc0e7d8333ff22b7/status.svg)](https://joss.theoj.org/papers/959971f196f617dddc0e7d8333ff22b7)

CloudnetPy is Python software designed for producing vertical profiles of cloud properties from ground-based
remote sensing measurements. The Cloudnet processing combines data from cloud radar, optical lidar,
microwave radiometer, and numerical weather prediction models.
Measurements and model data are brought into a common grid and
classified as ice, liquid, aerosol, insects, and so on.
Subsequently, geophysical products such as ice water content can be
retrieved in further processing steps. See [Illingworth et al. (2007)](https://doi.org/10.1175/BAMS-88-6-883) for more details about the concept.

CloudnetPy is a rewritten version of the original Cloudnet Matlab code. It features several revised methods, extensive documentation, and more.

- CloudnetPy documentation: <https://actris-cloudnet.github.io/cloudnetpy/>
- Cloudnet data portal: <https://cloudnet.fmi.fi>

![CloudnetPy example output](https://raw.githubusercontent.com/actris-cloudnet/cloudnetpy/main/docs/source/_static/20230831_lindenberg_classification-9b74f4ac-target_classification.png)

## Installation

### From PyPI

```
python3 -m pip install cloudnetpy
```

### From the source

```sh
git clone https://github.com/actris-cloudnet/cloudnetpy
cd cloudnetpy/
python3 -m venv venv
source venv/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install .
```

## Citing

If you wish to acknowledge CloudnetPy in your publication, please cite:

> Tukiainen et al., (2020). CloudnetPy: A Python package for processing cloud remote sensing data. Journal of Open Source Software, 5(53), 2123, https://doi.org/10.21105/joss.02123

## Contributing

We encourage you to contribute to CloudnetPy! Please check out the [contribution guidelines](CONTRIBUTING.md) about how to proceed.

## Development

Follow the installation instructions from the source above but install with the development dependencies and [pre-commit](https://pre-commit.com/) hooks:

```sh
python3 -m pip install -e .[dev,test]
pre-commit install
```

Run unit tests:

```sh
python3 -m pytest --flake-finder --flake-runs=2
```

Run single unit test:

```sh
python3 -m pytest tests/unit/test_hatpro.py
```

Run end-to-end tests:

```sh
python3 tests/e2e_test.py
```

```sh
for f in cloudnetpy/model_evaluation/tests/e2e/*/main.py; do $f; done
```

Force `pre-commit` checks (`ruff`, `mypy`, etc.) for all files:

```sh
pre-commit run --all
```

## License

MIT

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "cloudnetpy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Simo Tukiainen",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/cf/0a/00da7f31793fd06e315a15bcdc69d362ebebc25d589835d2ab418e99f271/cloudnetpy-1.65.8.tar.gz",
    "platform": null,
    "description": "# CloudnetPy\n\n[![CloudnetPy CI](https://github.com/actris-cloudnet/cloudnetpy/actions/workflows/test.yml/badge.svg)](https://github.com/actris-cloudnet/cloudnetpy/actions/workflows/test.yml)\n[![PyPI version](https://badge.fury.io/py/cloudnetpy.svg)](https://badge.fury.io/py/cloudnetpy)\n[![DOI](https://zenodo.org/badge/233602651.svg)](https://zenodo.org/badge/latestdoi/233602651)\n[![status](https://joss.theoj.org/papers/959971f196f617dddc0e7d8333ff22b7/status.svg)](https://joss.theoj.org/papers/959971f196f617dddc0e7d8333ff22b7)\n\nCloudnetPy is Python software designed for producing vertical profiles of cloud properties from ground-based\nremote sensing measurements. The Cloudnet processing combines data from cloud radar, optical lidar,\nmicrowave radiometer, and numerical weather prediction models.\nMeasurements and model data are brought into a common grid and\nclassified as ice, liquid, aerosol, insects, and so on.\nSubsequently, geophysical products such as ice water content can be\nretrieved in further processing steps. See [Illingworth et al. (2007)](https://doi.org/10.1175/BAMS-88-6-883) for more details about the concept.\n\nCloudnetPy is a rewritten version of the original Cloudnet Matlab code. It features several revised methods, extensive documentation, and more.\n\n- CloudnetPy documentation: <https://actris-cloudnet.github.io/cloudnetpy/>\n- Cloudnet data portal: <https://cloudnet.fmi.fi>\n\n![CloudnetPy example output](https://raw.githubusercontent.com/actris-cloudnet/cloudnetpy/main/docs/source/_static/20230831_lindenberg_classification-9b74f4ac-target_classification.png)\n\n## Installation\n\n### From PyPI\n\n```\npython3 -m pip install cloudnetpy\n```\n\n### From the source\n\n```sh\ngit clone https://github.com/actris-cloudnet/cloudnetpy\ncd cloudnetpy/\npython3 -m venv venv\nsource venv/bin/activate\npython3 -m pip install --upgrade pip\npython3 -m pip install .\n```\n\n## Citing\n\nIf you wish to acknowledge CloudnetPy in your publication, please cite:\n\n> Tukiainen et al., (2020). CloudnetPy: A Python package for processing cloud remote sensing data. Journal of Open Source Software, 5(53), 2123, https://doi.org/10.21105/joss.02123\n\n## Contributing\n\nWe encourage you to contribute to CloudnetPy! Please check out the [contribution guidelines](CONTRIBUTING.md) about how to proceed.\n\n## Development\n\nFollow the installation instructions from the source above but install with the development dependencies and [pre-commit](https://pre-commit.com/) hooks:\n\n```sh\npython3 -m pip install -e .[dev,test]\npre-commit install\n```\n\nRun unit tests:\n\n```sh\npython3 -m pytest --flake-finder --flake-runs=2\n```\n\nRun single unit test:\n\n```sh\npython3 -m pytest tests/unit/test_hatpro.py\n```\n\nRun end-to-end tests:\n\n```sh\npython3 tests/e2e_test.py\n```\n\n```sh\nfor f in cloudnetpy/model_evaluation/tests/e2e/*/main.py; do $f; done\n```\n\nForce `pre-commit` checks (`ruff`, `mypy`, etc.) for all files:\n\n```sh\npre-commit run --all\n```\n\n## License\n\nMIT\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2019-2022 Finnish Meteorological Institute  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": "Python package for Cloudnet processing",
    "version": "1.65.8",
    "project_urls": {
        "Changelog": "https://github.com/actris-cloudnet/cloudnetpy/blob/main/CHANGELOG.md",
        "Documentation": "https://actris-cloudnet.github.io/cloudnetpy/",
        "Homepage": "https://github.com/actris-cloudnet/cloudnetpy",
        "Repository": "https://github.com/actris-cloudnet/cloudnetpy"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cca9a9a60cd424cba95d4a474e7a8b67057c39490f90adfe46c8023eab660839",
                "md5": "a4356a04df0f5b6666561b07c25bab91",
                "sha256": "dd082839254fc4574b18e2ccdb4ec47c62bb29089c1cb25b1840dc723051954e"
            },
            "downloads": -1,
            "filename": "cloudnetpy-1.65.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a4356a04df0f5b6666561b07c25bab91",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 16826165,
            "upload_time": "2024-09-06T06:38:45",
            "upload_time_iso_8601": "2024-09-06T06:38:45.353562Z",
            "url": "https://files.pythonhosted.org/packages/cc/a9/a9a60cd424cba95d4a474e7a8b67057c39490f90adfe46c8023eab660839/cloudnetpy-1.65.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cf0a00da7f31793fd06e315a15bcdc69d362ebebc25d589835d2ab418e99f271",
                "md5": "90a1843c6c331b3a40ff06c2d833f7ad",
                "sha256": "c9831cb042de87f45c9af20858229ed4ca35a411a21540a1367e3cffad25f301"
            },
            "downloads": -1,
            "filename": "cloudnetpy-1.65.8.tar.gz",
            "has_sig": false,
            "md5_digest": "90a1843c6c331b3a40ff06c2d833f7ad",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 16779083,
            "upload_time": "2024-09-06T06:38:49",
            "upload_time_iso_8601": "2024-09-06T06:38:49.585934Z",
            "url": "https://files.pythonhosted.org/packages/cf/0a/00da7f31793fd06e315a15bcdc69d362ebebc25d589835d2ab418e99f271/cloudnetpy-1.65.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-06 06:38:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "actris-cloudnet",
    "github_project": "cloudnetpy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cloudnetpy"
}
        
Elapsed time: 0.34741s