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

From PyPI

python3 -m pip install cloudnetpy

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 .

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 --flake-finder --flake-runs=2

Run single unit test:

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cloudnetpy-1.66.8.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.8.tar.gz
Algorithm Hash digest
SHA256 92fd9958045833c06c5931bc73b1608331fbf26527a946befdde8c97460cdd76
MD5 170d67a95d9779ec630822ddd00e30b2
BLAKE2b-256 d9fcbc3c04383eb043ca2f37965b3372c5b33d9cc35e142f629f506d16254f89

See more details on using hashes here.

Provenance

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

Publisher: publish.yml on actris-cloudnet/cloudnetpy

Attestations:

File details

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

File metadata

  • Download URL: cloudnetpy-1.66.8-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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 b218d8484d3c7795e783c05978a627c4828926e0c1f126a8f0d2e3d05148d23c
MD5 19e4683ce7c67d509590cd4007fd3ac0
BLAKE2b-256 0a54d3ddfb3359cf16f6840e3311b7235c97ded566aa63c0f42ae8230368d1de

See more details on using hashes here.

Provenance

The following attestation bundles were made for cloudnetpy-1.66.8-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