Skip to main content

Python package for Cloudnet processing

Project description

CloudnetPy

CloudnetPy CI PyPI version DOI status

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) 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 example output

Installation

Option 1: From PyPI

python3 -m pip install cloudnetpy

Option 2: From the source

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

To verify the installation:

cloudnetpy --help

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 about how to proceed.

Development

Follow the installation instructions from the source above but install with the development dependencies and pre-commit hooks:

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

Run unit tests:

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

Run end-to-end tests:

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:

pre-commit run --all

License

MIT

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloudnetpy-1.92.3.tar.gz (16.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cloudnetpy-1.92.3-py3-none-any.whl (16.9 MB view details)

Uploaded Python 3

File details

Details for the file cloudnetpy-1.92.3.tar.gz.

File metadata

  • Download URL: cloudnetpy-1.92.3.tar.gz
  • Upload date:
  • Size: 16.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cloudnetpy-1.92.3.tar.gz
Algorithm Hash digest
SHA256 c8761303c3f60774818fda666a0c5b8814b084030e06256fb1e1a1b6e1668e1c
MD5 57937913bf706eb2adf8d298bd4f597f
BLAKE2b-256 e556f6dadd8e3e5037b560ac6deb0beaa716d6abf36ba2e0cbf8dff38413c161

See more details on using hashes here.

Provenance

The following attestation bundles were made for cloudnetpy-1.92.3.tar.gz:

Publisher: publish.yml on actris-cloudnet/cloudnetpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cloudnetpy-1.92.3-py3-none-any.whl.

File metadata

  • Download URL: cloudnetpy-1.92.3-py3-none-any.whl
  • Upload date:
  • Size: 16.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cloudnetpy-1.92.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d152ff9f4dbe2b1df87c6313024a7c435d807db8a1d8abfb46fc1acc52466fbd
MD5 9014fcc2baba44c31dbd5f68322c088c
BLAKE2b-256 252f6941b103d90811e7a6ad298e177c1194e8cca136fc9fc640ebc1c325c396

See more details on using hashes here.

Provenance

The following attestation bundles were made for cloudnetpy-1.92.3-py3-none-any.whl:

Publisher: publish.yml on actris-cloudnet/cloudnetpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page