Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

CloudnetPy

A Python software designed for producing vertical profiles of cloud properties from ground-based remote sensing measurements.
https://github.com/actris-cloudnet/cloudnetpy

Category: Atmosphere
Sub Category: Atmospheric Chemistry and Aerosol

Last synced: about 2 hours ago
JSON representation

Repository metadata

Python package for Cloudnet data processing

README.md

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

Citation (CITATION.cff)

cff-version: 1.2.0
title: >-
  CloudnetPy: A Python package for processing cloud remote
  sensing data
message: >-
  If you use this software, please cite our article in the
  Journal of Open Source Software.
type: software
authors:
  - family-names: Tukiainen
    given-names: Simo
    orcid: "https://orcid.org/0000-0002-0651-4622"
    affiliation: Finnish Meteorological Institute
  - given-names: Tuomas
    family-names: Siipola
    affiliation: Finnish Meteorological Institute
    orcid: "https://orcid.org/0009-0004-7757-0893"
  - family-names: Anniina
    given-names: Korpinen
    affiliation: Finnish Meteorological Institute
  - family-names: O'Connor
    given-names: Ewan
    orcid: "https://orcid.org/0000-0001-9834-5100"
    affiliation: Finnish Meteorological Institute
contact:
  - family-names: Tukiainen
    given-names: Simo
    orcid: "https://orcid.org/0000-0002-0651-4622"
    affiliation: Finnish Meteorological Institute
repository-code: "https://github.com/actris-cloudnet/cloudnetpy"
abstract: >-
  CloudnetPy is Python software designed for producing
  vertical profiles of cloud properties from ground-based
  remote sensing measurements.
keywords:
  - Python
  - cloud radar
  - lidar
  - microwave radiometer
  - remote sensing
license: MIT
doi: 10.5281/zenodo.3666030
preferred-citation:
  type: article
  authors:
    - family-names: Tukiainen
      given-names: Simo
      orcid: "https://orcid.org/0000-0002-0651-4622"
      affiliation: Finnish Meteorological Institute
    - family-names: O'Connor
      given-names: Ewan
      orcid: "https://orcid.org/0000-0001-9834-5100"
      affiliation: Finnish Meteorological Institute
    - family-names: Anniina
      given-names: Korpinen
      affiliation: Finnish Meteorological Institute
  doi: 10.21105/joss.02123
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  issn: 2475-9066
  start: 2123
  end: 2123
  title: "CloudnetPy: A Python package for processing cloud remote sensing data"
  issue: 53
  volume: 5
  year: 2020
  date-published: 2020-09-04
  url: https://joss.theoj.org/papers/10.21105/joss.02123

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 5 days ago

Total Commits: 1,417
Total Committers: 13
Avg Commits per committer: 109.0
Development Distribution Score (DDS): 0.293

Commits in past year: 279
Committers in past year: 3
Avg Commits per committer in past year: 93.0
Development Distribution Score (DDS) in past year: 0.369

Name Email Commits
Simo Tukiainen s****n@f****i 1002
Tuomas Siipola t****a@f****i 372
Anniina Korpinen a****n@f****i 13
Niko Leskinen n****n@f****i 12
Lauri Kangassalo l****o@f****i 6
spirrobe s****e 3
Moritz Lochmann m****n@u****e 2
Willi Schimmel w****l@u****e 2
swr99ejo e****r@f****i 1
martin_rdz 3****z 1
griesche 4****e 1
Joseph Hardin j****e@g****m 1
Andreas Foth 4****e 1

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 48
Total pull requests: 163
Average time to close issues: 3 months
Average time to close pull requests: 11 days
Total issue authors: 12
Total pull request authors: 14
Average comments per issue: 2.25
Average comments per pull request: 0.42
Merged pull request: 146
Bot issues: 0
Bot pull requests: 0

Past year issues: 1
Past year pull requests: 14
Past year average time to close issues: about 13 hours
Past year average time to close pull requests: 2 days
Past year issue authors: 1
Past year pull request authors: 4
Past year average comments per issue: 1.0
Past year average comments per pull request: 0.07
Past year merged pull request: 12
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/actris-cloudnet/cloudnetpy

Top Issue Authors

  • spirrobe (11)
  • ekschuman (9)
  • griesche (5)
  • josephhardinee (4)
  • tukiains (3)
  • WillyWallace (3)
  • KarlJohnsonnn (3)
  • martin-rdz (3)
  • MoLochmann (2)
  • HolgerPollyNet (2)
  • pablosaa (2)
  • syedhamidali (1)

Top Pull Request Authors

  • tukiains (100)
  • siiptuo (21)
  • KorpinenA (7)
  • shenganzhang (6)
  • spirrobe (6)
  • MoLochmann (4)
  • griesche (4)
  • lakka (4)
  • nikoleskinen (3)
  • josephhardinee (2)
  • KarlJohnsonnn (2)
  • martin-rdz (2)
  • Haoyu-Gao (1)
  • WillyWallace (1)

Top Issue Labels

  • enhancement (3)

Top Pull Request Labels

Package metadata

pypi.org: cloudnetpy

Python package for Cloudnet processing

  • Homepage: https://github.com/actris-cloudnet/cloudnetpy
  • Documentation: https://actris-cloudnet.github.io/cloudnetpy/
  • Licenses: MIT License Copyright (c) 2019-2022 Finnish Meteorological Institute Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 1.74.4 (published 2 days ago)
  • Last Synced: 2025-04-26T12:36:49.070Z (1 day ago)
  • Versions: 301
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 9,119 Last month
  • Rankings:
    • Dependent packages count: 4.798%
    • Downloads: 5.481%
    • Forks count: 8.107%
    • Average: 10.333%
    • Stargazers count: 11.752%
    • Dependent repos count: 21.526%
  • Maintainers (3)

Dependencies

.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • softprops/action-gh-release v1 composite
.github/workflows/test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
docs/requirements.txt pypi
  • sphinx ==5.3.0
  • sphinx-rtd-theme ==1.1.1
pyproject.toml pypi
  • cloudnetpy_qc >=1.13.8
  • matplotlib *
  • mwrpy >=0.4.3
  • netCDF4 *
  • requests *
  • rpgpy >=0.14.5
  • scikit-image *
  • scipy *
.github/workflows/docs.yaml actions
  • actions/checkout v4 composite
  • actions/deploy-pages v2 composite
  • actions/setup-python v4 composite
  • actions/upload-pages-artifact v2 composite

Score: 15.490275430636135