Metadata-Version: 2.4
Name: cloudnetpy
Version: 1.97.6
Summary: Python package for Cloudnet processing
Author: Simo Tukiainen
License-Expression: MIT
Project-URL: Homepage, https://github.com/actris-cloudnet/cloudnetpy
Project-URL: Documentation, https://actris-cloudnet.github.io/cloudnetpy/
Project-URL: Repository, https://github.com/actris-cloudnet/cloudnetpy
Project-URL: Changelog, https://github.com/actris-cloudnet/cloudnetpy/blob/main/CHANGELOG.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: atmoslib>=2.4.2
Requires-Dist: ceilopyter>=0.2.3
Requires-Dist: cloudnet-api-client
Requires-Dist: doppy>=0.5.0
Requires-Dist: matplotlib
Requires-Dist: mwrpy>=1.7.0
Requires-Dist: netCDF4
Requires-Dist: requests
Requires-Dist: rpgpy>=0.14.5
Requires-Dist: scipy
Provides-Extra: test
Requires-Dist: cloudnetpy_qc; extra == "test"
Requires-Dist: mypy; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-flakefinder; extra == "test"
Requires-Dist: ruff; extra == "test"
Requires-Dist: types-requests; extra == "test"
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: release-version; extra == "dev"
Provides-Extra: extras
Requires-Dist: voodoonet>=0.1.7; extra == "extras"
Dynamic: license-file

# 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://img.shields.io/pypi/v/cloudnetpy.svg)](https://pypi.org/project/cloudnetpy/)
[![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.3666030-blue)](https://doi.org/10.5281/zenodo.3666030)
[![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

### Option 1: From PyPI

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

### Option 2: 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 .
```

### Verification

Verify the installation by running `cloudnetpy --help`.

## Command-line usage

CloudnetPy ships with a `cloudnetpy` console script that fetches data from the
[Cloudnet data portal](https://cloudnet.fmi.fi), runs the requested processing
steps, and writes netCDF files (and optionally plots) to disk:

```sh
cloudnetpy --site munich --date 2023-07-29 --products radar --show
cloudnetpy --site kenttarova --date 2025-07-29 --products classification --show
cloudnetpy -s kenttarova -d 2025-05-28 -p l3-cf -m harmonie-fmi-6-11 --show
```

See the [command-line usage documentation](https://actris-cloudnet.github.io/cloudnetpy/cli.html)
for instrument selection, different products, plotting, ARM sites, and all options.

## 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
python3 -m pytest tests/unit/test_hatpro.py
```

Run end-to-end tests:

```sh
python3 tests/e2e_test.py
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
