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.58.1.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.58.1-py3-none-any.whl (16.8 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cloudnetpy-1.58.1.tar.gz
Algorithm Hash digest
SHA256 c908e164b72ed76684b719f02ae5aba2f6466c366e389faf143fa913640e69ea
MD5 0711a127ff0aee9a39fe962ce7b976f7
BLAKE2b-256 432ea9354f24d3103f034539834915f4226bfa875b666fa8171ff0cdc86e0fbb

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cloudnetpy-1.58.1-py3-none-any.whl
Algorithm Hash digest
SHA256 747b5e7177439b525ad31f002809a87bd3eadf057783f8dad335bce7599792bf
MD5 0373b7cd91d630911ef9a92ff5416616
BLAKE2b-256 2d7b287f1164df468e2f8ff320bc9361ca707ee7bfe44b00bcdbc584e6731b5d

See more details on using hashes here.

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