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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cloudnetpy-1.66.4.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.4.tar.gz
Algorithm Hash digest
SHA256 baff5358bb3611f214276504f2c153f207a666b9cce8385e886af19993886a8a
MD5 da9854d914b5ada50ba6bad61e9d3601
BLAKE2b-256 163205a63a0a3a3c0a48a5d8981e862b9bd8b33a3e57ae1230cd4d63deabe8af

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudnetpy-1.66.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4552c5319835d0c49e0ed4779365874d86b29b69a3f4b7603e97d95d340b87cf
MD5 ec872e5b0166630789fb48e999ca2348
BLAKE2b-256 c985ead4a4473bd76cb9a2a261c0f68858c72eae55daf8a4ffca3fc2d28ef77e

See more details on using hashes here.

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