Developer’s Guide

CloudnetPy is hosted by Finnish Meteorological Institute (FMI) and is used to process cloud remote sensing data in the ACTRIS research infrastructure. We are happy to welcome the cloud remote sensing community to provide improvements in the methods and their implementations, writing tests and fixing bugs.

How to contribute

Instructions can be found from CloudnetPy’s Github page.

Testing

To run the CloudnetPy test suite, first clone the whole repository from GitHub:

$ git clone https://github.com/actris-cloudnet/cloudnetpy

Testing environment

Create a virtual environment and install:

$ cd cloudnetpy
$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ pip3 install --upgrade pip
(venv) $ pip3 install .[test,dev,extras]

Unit tests

(venv) $ pytest

End-to-end test

(venv) $ python3 tests/e2e_test.py

Note

CloudnetPy performs relatively complicated scientific processing, converting noisy measurement data into higher level products. Most of the Cloudnetpy’s low-level functions are unit tested, but it is difficult to write unambiguous tests for the high-level API functions. However, the quality of the processed files can be at least roughly checked using CloudnetPy’s quality control functions.