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.66.15.tar.gz (16.8 MB view details)

Uploaded Source

Built Distribution

cloudnetpy-1.66.15-py3-none-any.whl (16.8 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cloudnetpy-1.66.15.tar.gz
Algorithm Hash digest
SHA256 ac68ee8a4ed0f551f8bc9898447f998517f09e5814608c0d89898f072552c802
MD5 902e1d0b4be67540b3a751955e1c142a
BLAKE2b-256 144c4e1bf89a6791465419ebf52f43a354c4e2557734edb1f54ed311fe9b3079

See more details on using hashes here.

Provenance

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

Publisher: publish.yml on actris-cloudnet/cloudnetpy

Attestations:

File details

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

File metadata

  • Download URL: cloudnetpy-1.66.15-py3-none-any.whl
  • Upload date:
  • Size: 16.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for cloudnetpy-1.66.15-py3-none-any.whl
Algorithm Hash digest
SHA256 36e43a9a56179b27d8cee10e834aa6999b1f68fc25977c5a7c4f381b133f8c76
MD5 641bb1e7af092445157e317cee88ea1e
BLAKE2b-256 33fb4c89848c131badafe33d23642ed99e2c130236447a09e2abbe15fb9f0072

See more details on using hashes here.

Provenance

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

Publisher: publish.yml on actris-cloudnet/cloudnetpy

Attestations:

Supported by

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