Skip to main content

Python package for Cloudnet processing

Project description

CloudnetPy

CloudnetPy CI Documentation Status PyPI version DOI status

CloudnetPy is a Python software for producing vertical profiles of cloud properties from ground-based remote sensing measurements. The Cloudnet processing combines cloud radar, optical lidar, microwave radiometer and model data. Measurements and model data are brought into common grid and classified as ice, liquid, aerosol, insects, and so on. Then, geophysical products such as ice water content can be retrieved in the 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. CloudnetPy 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 (pylint, 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.55.19.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.55.19-py3-none-any.whl (16.8 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cloudnetpy-1.55.19.tar.gz
Algorithm Hash digest
SHA256 3ba1ea092ffa009473d9aa77f074434bf85dc75b9054cea4fec6b4753a5687fe
MD5 20e0b8510f32b93784e3c48128ae7b97
BLAKE2b-256 481c49a2ce272f2999ca5b626273f39ebb7c05fae1682632bd045247f2f269bf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudnetpy-1.55.19-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.6

File hashes

Hashes for cloudnetpy-1.55.19-py3-none-any.whl
Algorithm Hash digest
SHA256 4664f09969ab821a72f93835679b8dfe509c7f74668028aab8ef4a0d4867438d
MD5 193e0838764079540a8e56a72dd58507
BLAKE2b-256 4e4a79e1df3119a67196ad3b19615a680068579a183cbdfa32113833d88a33d8

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