CloudnetPy
CloudnetPy: A Python package for processing cloud remote sensing data - Published in JOSS (2020)
Science Score: 100.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org, zenodo.org -
✓Committers with academic emails
2 of 13 committers (15.4%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Python package for Cloudnet data processing
Basic Info
Statistics
- Stars: 47
- Watchers: 8
- Forks: 29
- Open Issues: 1
- Releases: 319
Metadata Files
README.md
CloudnetPy
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 documentation: https://actris-cloudnet.github.io/cloudnetpy/
- Cloudnet data portal: https://cloudnet.fmi.fi

Installation
Option 1: From PyPI
python3 -m pip install cloudnetpy
Option 2: From the source
sh
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:
sh
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:
sh
python3 -m pip install -e .[dev,test]
pre-commit install
Run unit tests:
sh
python3 -m pytest
python3 -m pytest tests/unit/test_hatpro.py
Run end-to-end tests:
sh
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:
sh
pre-commit run --all
License
MIT
Owner
- Name: ACTRIS Cloudnet
- Login: actris-cloudnet
- Kind: organization
- Email: actris-cloudnet@fmi.fi
- Location: Helsinki, Finland
- Website: https://cloudnet.fmi.fi/
- Twitter: ACTRIS_Cloudnet
- Repositories: 12
- Profile: https://github.com/actris-cloudnet
ACTRIS Cloud Remote Sensing Unit (CLU)
JOSS Publication
CloudnetPy: A Python package for processing cloud remote sensing data
Authors
Finnish Meteorological Institute, Helsinki, Finland
Finnish Meteorological Institute, Helsinki, Finland
Tags
cloud radar lidar microwave radiometer remote sensingCitation (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
GitHub Events
Total
- Create event: 85
- Issues event: 1
- Release event: 62
- Watch event: 13
- Delete event: 21
- Issue comment event: 1
- Push event: 254
- Pull request review event: 1
- Pull request review comment event: 2
- Pull request event: 16
- Fork event: 3
Last Year
- Create event: 85
- Issues event: 1
- Release event: 62
- Watch event: 13
- Delete event: 21
- Issue comment event: 1
- Push event: 254
- Pull request review event: 2
- Pull request review comment event: 2
- Pull request event: 16
- Fork event: 3
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Simo Tukiainen | s****n@f****i | 1,026 |
| Tuomas Siipola | t****a@f****i | 399 |
| 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 (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 22
- Total pull requests: 114
- Average time to close issues: 3 months
- Average time to close pull requests: 11 days
- Total issue authors: 11
- Total pull request authors: 14
- Average comments per issue: 2.09
- Average comments per pull request: 0.31
- Merged pull requests: 100
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 25
- Average time to close issues: N/A
- Average time to close pull requests: 9 days
- Issue authors: 1
- Pull request authors: 4
- Average comments per issue: 0.0
- Average comments per pull request: 0.04
- Merged pull requests: 17
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- spirrobe (5)
- WillyWallace (3)
- griesche (3)
- ekschuman (3)
- josephhardinee (2)
- syedhamidali (1)
- tukiains (1)
- HolgerPollyNet (1)
- KarlJohnsonnn (1)
- pablosaa (1)
- martin-rdz (1)
Pull Request Authors
- tukiains (71)
- siiptuo (18)
- nikoleskinen (5)
- KorpinenA (3)
- shenganzhang (2)
- spirrobe (2)
- griesche (2)
- lakka (2)
- KarlJohnsonnn (2)
- MoLochmann (2)
- Haoyu-Gao (2)
- WillyWallace (1)
- josephhardinee (1)
- martin-rdz (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 3,017 last-month
-
Total dependent packages: 1
(may contain duplicates) -
Total dependent repositories: 1
(may contain duplicates) - Total versions: 655
- Total maintainers: 3
proxy.golang.org: github.com/actris-cloudnet/cloudnetpy
- Documentation: https://pkg.go.dev/github.com/actris-cloudnet/cloudnetpy#section-documentation
- License: mit
-
Latest release: v1.80.8
published 6 months ago
Rankings
pypi.org: cloudnetpy
Python package for Cloudnet processing
- Homepage: https://github.com/actris-cloudnet/cloudnetpy
- Documentation: https://actris-cloudnet.github.io/cloudnetpy/
- License: 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.80.8
published 6 months ago
Rankings
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- softprops/action-gh-release v1 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- sphinx ==5.3.0
- sphinx-rtd-theme ==1.1.1
- cloudnetpy_qc >=1.13.8
- matplotlib *
- mwrpy >=0.4.3
- netCDF4 *
- requests *
- rpgpy >=0.14.5
- scikit-image *
- scipy *
- actions/checkout v4 composite
- actions/deploy-pages v2 composite
- actions/setup-python v4 composite
- actions/upload-pages-artifact v2 composite
