cloudnetpy

Python package for Cloudnet data processing

https://gitlab.com/gfatugr/cloudnetpy

Science Score: 41.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
  • .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.9%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Python package for Cloudnet data processing

Basic Info
  • Host: gitlab.com
  • Owner: gfatugr
  • Default Branch: master
Statistics
  • Stars: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created almost 4 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

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 documentation: https://cloudnetpy.readthedocs.io/en/latest/
  • Cloudnet data portal: https://cloudnet.fmi.fi

CloudnetPy example output

Installation

From PyPI

python3 -m pip install cloudnetpy

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 .

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 instead of pip install . install with the test-dependencies and pre-commit hooks: sh python3 -m pip install -e .[test,dev] pre-commit install

Run unit tests: sh pytest

Run end-to-end tests: sh python3 tests/e2e_test.py

Force pre-commit checks of all files: sh pre-commit run --all

License

MIT

Owner

  • Name: gfat ugr
  • Login: gfatugr
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you wish to acknowledge CloudnetPy in your publication, please cite it as below."
title: CloudnetPy
authors:
- family-names: "Tukiainen"
  given-names: "Simo"
- family-names: "O'Connor"
  given-names: "Ewan"
- family-names: "Anniina"
  given-names: "Korpinen"
url: "https://github.com/actris-cloudnet/cloudnetpy"
preferred-citation:
  type: article
  authors:
  - family-names: "Tukiainen"
    given-names: "Simo"
  - family-names: "O'Connor"
    given-names: "Ewan"
  - family-names: "Anniina"
    given-names: "Korpinen"
  doi: "10.21105/joss.02123"
  journal: "Journal of Open Source Software"
  start: 2123
  end: 2123
  title: "CloudnetPy: A Python package for processing cloud remote sensing data"
  issue: 53
  volume: 5
  year: 2020

Dependencies

docs/requirements.txt pypi
  • docutils <0.18
  • pytest ==4.1.1
  • sphinx *
  • sphinx_rtd_theme *
setup.py pypi
  • cloudnetpy_qc >=0.2.0
  • matplotlib *
  • netCDF4 *
  • pytz *
  • requests *
  • scikit-image *
  • scipy *