Skip to main content

CCRES code to convert data

Project description

CCRES Disdrometer processing

pypi documentation status license

Ruff github actions codecov Issue Badge Pull requests

CCRES disdrometer processing

This code provides tools to process disdrometer data from ACTRIS-CCRES/ACTRIS-cloudnet to monitor the calibration of doppler cloud radars (13, 35, 94 Ghz).

Installation

pip install numpy wheels
pip install ccres_disdrometer_processing

[!WARNING] The code is not compatible with python 3.12 because of pytmatrix.

Usage

This code is only compatible with data of Doppler Cloud Radar (DCR), Disdrometer (DD) and weather station using cloudnet netCDF format.

Configuration file

A configuration file is needed to use the code. The configuration use toml format and several examples are available in this project in the conf_stations folder.

Here is an example of a configuration file:

title = "Configuration for the computation of the dcrcc monitoring (preprocessing and processing)"

[location]
SITE = "Jülich"
STATION = "JOYCE" # useful for plots

[methods]
FALL_SPEED_METHOD = "GunAndKinzer"
AXIS_RATIO_METHOD = "BeardChuang_PolynomialFit"
COMPUTE_MIE_METHOD = "pytmatrix"
REFRACTION_INDEX = [2.99645,1.54866] # complex index
RADAR_FREQUENCIES = [10.0e9, 24.0e9, 35.0e9, 94.0e9] # Hz
MAX_ALTITUDE_RADAR_DATA = 2500

[instrument_parameters]
DD_SAMPLING_AREA = 0.0054 # m^2 ; Parsivel2 sampling surface
DCR_DZ_RANGE = 150 # m ; height at which to compute Delta Z ; fill with the real value
RAIN_GAUGE_SAMPLING = 0 # mm ; default value ; no weather available at Juelich but this value is used by the code only if weather is available
DD_ORIENTATION = 0 # degree, from North ; fill with the real value

[plot_parameters]
DCR_PLOTTED_RANGES = [150, 200, 300] # fill with the good values

[thresholds]
MAX_RR = 3  # mm/h
MIN_RAINFALL_AMOUNT = 3 # mm/episode
MAX_MEAN_WS = 7 # m/s ; default value ; no weather available at Juelich but this value is used by the code only if weather is available
MAX_WS = 10 # m/s ; default value ; no weather available at Juelich but this value is used by the code only if weather is available
MIN_TEMP = 2 # °C ; default value ; no weather available at Juelich but this value is used by the code only if weather is available
MIN_HUR = 0 # min relative humidity : avoid cases with evaporation ; default value ; no weather available at Juelich but this value is used by the code only if weather is available
MAX_HUR = 100 # max relative humidity : avoid fog, ... ; default value ; no weather available at Juelich but this value is used by the code only if weather is available
DD_ANGLE = 45 # degree ; keep wind data at DD_ORIENTATION[pi] +- DD_ANGLE
MAX_INTERVAL = 60 # mn ; max interval between two tipping of the pluviometer, to "close" an event
MIN_DURATION = 180 # mn ; min duration of an event
PR_SAMPLING = 15  # mn ; ex CHUNK_THICKNESS ; period of averaging for AMS pr ; default value ; no weather available at Juelich but this value is used by the code only if weather is available
DD_RG_MAX_PR_ACC_RATIO = 0.3 # ex ACCUMULATION_RELATIVE_ERROR ; max relative error in rain accumulation measurement, DD vs Rain gauge ; default value ; no weather available at Juelich but this value is used by the code only if weather is available
DD_FALLSPEED_RATIO = 0.3 # ex FALLSPEED_RELATIVE_ERROR ; relative difference between "theoretical" and DD fall speed

[nc_meta]
title = ""
summary = ""
id = ""
naming_authority = ""
comment = ""
creator_name = "ACTRIS-CCRES"
creator_email = "ccres_contact@listes.ipsl.fr"
creator_url = "https://ccres.aeris-data.fr"
creator_type = "institution"
creator_institution = ""
institution = ""
project = ""
publisher_name = ""
publisher_email = ""
publisher_url = ""
publisher_type = ""
publisher_institution = ""
contributor_name = ""
contributor_role = ""
cdm_data_type = ""
metadata_link = ""

Preprocessing

This steps is used to preprocess the DCR and DD data.

ccres_disdrometer_processing preprocess \
        --disdro-file path/to/disdro.nc \
        --radar-file path/to/radar.nc \
        --ws-file path/to/weather_station.nc \
        --config-file path/to/config.toml \
        path/to/preprocess_file.nc

Using the created netCDF, you can create vizualisation of the data.

ccres_disdrometer_processing preprocess-ql \
        --config-file path/to/config.toml \
        path/to/preprocess_file.nc \
        path/to/weather_overview_ql.png \
        path/to/zh_overview_ql.png

Processing

The processing step allow to identify rain events compatible with the checking of DCR calibration. To get the best results, this step needs the preprocess files of the day before and the day after the day to process.

ccres_disdrometer_processing process \
        --config-file path/to/config.toml \
        --yesterday path/to/yesterday_preprocess_file.nc \
        --today path/to/today_preprocess_file.nc \
        --tomorrow path/to/tomorrow_preprocess_file.nc \
        path/to/process_file.nc

Using the created netCDF, you can create vizualisation of the data. As we don't know how many rain events are detected you need to provide prefix name of the output quicklook files.

ccres_disdrometer_processing process-ql \
        --config-file path/to/config.toml \
        --preprocess-yesterday path/to/yesterday_preprocess_file.nc \
        --preprocess-today path/to/today_preprocess_file.nc \
        --preprocess-tomorrow path/to/tomorrow_preprocess_file.nc \
        --prefix-output-ql-summary path/to/summary_ql \
        --prefix-output-ql-detailled path/to/detailled_ql \
        path/to/process_file.nc

If at list one event is found in the process file, the script will created the files:

  • path/to/summary_ql_00.png
  • path/to/detailled_ql_00.png

License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ccres_disdrometer_processing-0.3.1.tar.gz (526.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ccres_disdrometer_processing-0.3.1-py3-none-any.whl (112.0 kB view details)

Uploaded Python 3

File details

Details for the file ccres_disdrometer_processing-0.3.1.tar.gz.

File metadata

File hashes

Hashes for ccres_disdrometer_processing-0.3.1.tar.gz
Algorithm Hash digest
SHA256 5a3b96ea898c8ea019dce1d6b8c0afcca6d15b77b25ae1e34c4d36bd83a787ae
MD5 ff1b8fe1cfd64f73fe4e9020a509fd1b
BLAKE2b-256 a1c2f5f47b84518cc7acff23284d6707f388ba454138b12eeb549eac80d9736c

See more details on using hashes here.

File details

Details for the file ccres_disdrometer_processing-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ccres_disdrometer_processing-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a1fe1b3b275e78cd0f15e46e38c128403ad73fabf7b5f8c7525f2d458b3e167b
MD5 6ab81281c28f44672ee11f413c33ca6c
BLAKE2b-256 814b5f31491665dcb24f6309113984dd7d6d083bcd0d28874cf66716172a9d7a

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