radclss 2026.2.6__tar.gz

radclss-2026.2.6/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Atmospheric Radiation Measurement user facility
+
+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.

radclss-2026.2.6/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: radclss
+Version: 2026.2.6
+Summary: Extracted Radar Columns and In Situ Sensors
+Author: rjackson, jrobrien91
+License: MIT
+Project-URL: Homepage, https://www.github.com/ARM-Development/radclss
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: arm_pyart
+Requires-Dist: numpy
+Requires-Dist: xarray
+Requires-Dist: pandas
+Requires-Dist: xradar
+Requires-Dist: act-atmos
+Requires-Dist: matplotlib
+Requires-Dist: dask
+Dynamic: license-file
+
+# ARM Repository Template
+Basic repository template with required security workflows

radclss-2026.2.6/README.md

@@ -0,0 +1,2 @@
+# ARM Repository Template
+Basic repository template with required security workflows

radclss-2026.2.6/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "radclss"
+version = "2026.2.6"
+description = "Extracted Radar Columns and In Situ Sensors"
+readme = "README.md"
+requires-python = ">=3.9"
+authors = [{ name = "rjackson" }, {name = "jrobrien91"}]
+license = { text = "MIT" }
+dependencies = [
+    "arm_pyart",
+    "numpy",
+    "xarray",
+    "pandas",
+    "xradar",
+    "act-atmos",
+    "matplotlib",
+    "dask",
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+packages = ["radclss"]
+
+[project.urls]
+Homepage = "https://www.github.com/ARM-Development/radclss"

radclss-2026.2.6/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

radclss-2026.2.6/src/radclss/__init__.py

@@ -0,0 +1,11 @@
+"""
+====================================================
+RadCLss: Extracted Radar Columns and In-Situ Sensors
+====================================================
+"""
+
+from . import config  # noqa
+from . import core  # noqa
+from . import util  # noqa
+from . import vis  # noqa
+from . import io  # noqa

radclss-2026.2.6/src/radclss/config/__init__.py

@@ -0,0 +1,18 @@
+from .default_config import DEFAULT_DISCARD_VAR, set_discarded_variables  # noqa
+from .output_config import (
+    set_output_site,  # noqa
+    set_output_facility,  # noqa
+    set_output_platform,  # noqa
+    set_output_level,  # noqa
+)  # noqa
+from .output_config import (
+    set_output_gate_time_attrs,  # noqa
+    set_output_time_offset_attrs,  # noqa
+    get_output_config,  # noqa
+)  # noqa
+from .output_config import (
+    set_output_alt_attrs,  # noqa
+    set_output_lat_attrs,  # noqa
+    set_output_lon_attrs,  # noqa
+    set_output_station_attrs,  # noqa
+)  # noqa

radclss-2026.2.6/src/radclss/config/default_config.py

@@ -0,0 +1,248 @@
+"""
+Default configuration file for RadCLss
+
+This file contains default parameters and variables used throughout RadCLss.
+
+"""
+
+# Define variables to drop from RadCLss from the respective datastreams
+DEFAULT_DISCARD_VAR = {
+    "radar": [
+        "classification_mask",
+        "uncorrected_copol_correlation_coeff",
+        "uncorrected_differential_phase",
+        "uncorrected_differential_reflectivity",
+        "uncorrected_differential_reflectivity_lag_1",
+        "uncorrected_mean_doppler_velocity_h",
+        "uncorrected_mean_doppler_velocity_v",
+        "uncorrected_reflectivity_h",
+        "uncorrected_reflectivity_v",
+        "uncorrected_spectral_width_h",
+        "uncorrected_spectral_width_v",
+        "clutter_masked_velocity",
+        "gate_id",
+        "ground_clutter",
+        "partial_beam_blockage",
+        "cumulative_beam_blockage",
+        "unfolded_differential_phase",
+        "path_integrated_attenuation",
+        "path_integrated_differential_attenuation",
+        "unthresholded_power_copolar_v",
+        "unthresholded_power_copolar_h",
+        "specific_differential_phase",
+        "specific_differential_attenuation",
+        "reflectivity_v",
+        "reflectivity",
+        "mean_doppler_velocity_v",
+        "mean_doppler_velocity",
+        "differential_reflectivity_lag_1",
+        "differential_reflectivity",
+        "differential_phase",
+        "normalized_coherent_power",
+        "normalized_coherent_power_v",
+        "signal_to_noise_ratio_copolar_h",
+        "signal_to_noise_ratio_copolar_v",
+        "specific_attenuation",
+        "spectral_width",
+        "spectral_width_v",
+        "sounding_temperature",
+        "signal_to_noise_ratio",
+        "velocity_texture",
+        "simulated_velocity",
+        "height_over_iso0",
+    ],
+    "met": [
+        "base_time",
+        "time_offset",
+        "time_bounds",
+        "logger_volt",
+        "logger_temp",
+        "qc_logger_temp",
+        "lat",
+        "lon",
+        "alt",
+        "qc_temp_mean",
+        "qc_rh_mean",
+        "qc_vapor_pressure_mean",
+        "qc_wspd_arith_mean",
+        "qc_wspd_vec_mean",
+        "qc_wdir_vec_mean",
+        "qc_pwd_mean_vis_1min",
+        "qc_pwd_mean_vis_10min",
+        "qc_pwd_pw_code_inst",
+        "qc_pwd_pw_code_15min",
+        "qc_pwd_pw_code_1hr",
+        "qc_pwd_precip_rate_mean_1min",
+        "qc_pwd_cumul_rain",
+        "qc_pwd_cumul_snow",
+        "qc_org_precip_rate_mean",
+        "qc_tbrg_precip_total",
+        "qc_tbrg_precip_total_corr",
+        "qc_logger_volt",
+        "qc_logger_temp",
+        "qc_atmos_pressure",
+        "pwd_pw_code_inst",
+        "pwd_pw_code_15min",
+        "pwd_pw_code_1hr",
+        "temp_std",
+        "rh_std",
+        "vapor_pressure_std",
+        "wdir_vec_std",
+        "tbrg_precip_total",
+        "org_precip_rate_mean",
+        "pwd_mean_vis_1min",
+        "pwd_mean_vis_10min",
+        "pwd_precip_rate_mean_1min",
+        "pwd_cumul_rain",
+        "pwd_cumul_snow",
+        "pwd_err_code",
+    ],
+    "sonde": [
+        "base_time",
+        "time_offset",
+        "lat",
+        "lon",
+        "qc_pres",
+        "qc_tdry",
+        "qc_dp",
+        "qc_wspd",
+        "qc_deg",
+        "qc_rh",
+        "qc_u_wind",
+        "qc_v_wind",
+        "qc_asc",
+        "wstat",
+        "asc",
+    ],
+    "pluvio": [
+        "base_time",
+        "time_offset",
+        "load_cell_temp",
+        "heater_status",
+        "elec_unit_temp",
+        "supply_volts",
+        "orifice_temp",
+        "volt_min",
+        "ptemp",
+        "lat",
+        "lon",
+        "alt",
+        "maintenance_flag",
+        "reset_flag",
+        "qc_rh_mean",
+        "pluvio_status",
+        "bucket_rt",
+        "accum_total_nrt",
+    ],
+    "ldquants": [
+        "specific_differential_attenuation_xband20c",
+        "specific_differential_attenuation_kaband20c",
+        "specific_differential_attenuation_sband20c",
+        "bringi_conv_stra_flag",
+        "exppsd_slope",
+        "norm_num_concen",
+        "num_concen",
+        "gammapsd_shape",
+        "gammapsd_slope",
+        "mean_doppler_vel_wband20c",
+        "mean_doppler_vel_kaband20c",
+        "mean_doppler_vel_xband20c",
+        "mean_doppler_vel_sband20c",
+        "specific_attenuation_kaband20c",
+        "specific_attenuation_xband20c",
+        "specific_attenuation_sband20c",
+        "specific_differential_phase_kaband20c",
+        "specific_differential_phase_xband20c",
+        "specific_differential_phase_sband20c",
+        "differential_reflectivity_kaband20c",
+        "differential_reflectivity_xband20c",
+        "differential_reflectivity_sband20c",
+        "reflectivity_factor_wband20c",
+        "reflectivity_factor_kaband20c",
+        "reflectivity_factor_xband20c",
+        "reflectivity_factor_sband20c",
+        "bringi_conv_stra_flag",
+        "time_offset",
+        "base_time",
+        "lat",
+        "lon",
+        "alt",
+    ],
+    "vdisquants": [
+        "specific_differential_attenuation_xband20c",
+        "specific_differential_attenuation_kaband20c",
+        "specific_differential_attenuation_sband20c",
+        "bringi_conv_stra_flag",
+        "exppsd_slope",
+        "norm_num_concen",
+        "num_concen",
+        "gammapsd_shape",
+        "gammapsd_slope",
+        "mean_doppler_vel_wband20c",
+        "mean_doppler_vel_kaband20c",
+        "mean_doppler_vel_xband20c",
+        "mean_doppler_vel_sband20c",
+        "specific_attenuation_kaband20c",
+        "specific_attenuation_xband20c",
+        "specific_attenuation_sband20c",
+        "specific_differential_phase_kaband20c",
+        "specific_differential_phase_xband20c",
+        "specific_differential_phase_sband20c",
+        "differential_reflectivity_kaband20c",
+        "differential_reflectivity_xband20c",
+        "differential_reflectivity_sband20c",
+        "reflectivity_factor_wband20c",
+        "reflectivity_factor_kaband20c",
+        "reflectivity_factor_xband20c",
+        "reflectivity_factor_sband20c",
+        "bringi_conv_stra_flag",
+        "time_offset",
+        "base_time",
+        "lat",
+        "lon",
+        "alt",
+    ],
+    "wxt": [
+        "base_time",
+        "time_offset",
+        "time_bounds",
+        "qc_temp_mean",
+        "temp_std",
+        "rh_mean",
+        "qc_rh_mean",
+        "rh_std",
+        "atmos_pressure",
+        "qc_atmos_pressure",
+        "wspd_arith_mean",
+        "qc_wspd_arith_mean",
+        "wspd_vec_mean",
+        "qc_wspd_vec_mean",
+        "wdir_vec_mean",
+        "qc_wdir_vec_mean",
+        "wdir_vec_std",
+        "qc_wxt_precip_rate_mean",
+        "qc_wxt_cumul_precip",
+        "logger_volt",
+        "qc_logger_volt",
+        "logger_temp",
+        "qc_logger_temp",
+        "lat",
+        "lon",
+        "alt",
+    ],
+}
+
+
+def set_discarded_variables(instrument, var_list):
+    """
+    Set the variables to be discarded from a given instrument datastream.
+
+    Parameters
+    ----------
+    instrument : str
+        The instrument name (e.g., 'radar', 'met', 'sonde', etc.).
+    var_list : list
+        List of variable names to discard.
+    """
+    global DEFAULT_DISCARD_VAR
+    DEFAULT_DISCARD_VAR[instrument] = var_list

radclss-2026.2.6/src/radclss/config/output_config.py

@@ -0,0 +1,185 @@
+OUTPUT_SITE = "BNF"
+OUTPUT_FACILITY = "S2"
+OUTPUT_PLATFORM = "csapr2radclss"
+OUTPUT_LEVEL = "c2"
+OUTPUT_GATE_TIME_ATTRS = {
+    "long_name": (
+        "Time in Seconds that Cooresponds to the Start"
+        + " of each Individual Radar Volume Scan before"
+        + " Concatenation"
+    ),
+    "description": "Time in Seconds that Cooresponds to the Minimum Height Gate",
+}
+OUTPUT_TIME_OFFSET_ATTRS = dict(
+    long_name=("Time in Seconds Since Midnight"),
+    description=(
+        "Time in Seconds Since Midnight that Cooresponds"
+        + "to the Center of Each Height Gate"
+        + "Above the Target Location "
+    ),
+)
+OUTPUT_STATION_ATTRS = dict(
+    long_name="Bankhead National Forest AMF-3 In-Situ Ground Observation Station Identifers"
+)
+OUTPUT_LAT_ATTRS = dict(
+    long_name="Latitude of BNF AMF-3 Ground Observation Site", units="Degrees North"
+)
+OUTPUT_LON_ATTRS = dict(
+    long_name="Longitude of BNF AMF-3 Ground Observation Site", units="Degrees East"
+)
+OUTPUT_ALT_ATTRS = dict(
+    long_name="Altitude above mean sea level for each station", units="m"
+)
+
+
+def set_output_site(site):
+    """
+    Set the output site for RadCLss files.
+
+    Parameters
+    ----------
+    site : str
+        The output site name.
+    """
+    global OUTPUT_SITE
+    OUTPUT_SITE = site
+
+
+def set_output_facility(facility):
+    """
+    Set the output facility for RadCLss files.
+
+    Parameters
+    ----------
+    facility : str
+        The output facility name.
+    """
+    global OUTPUT_FACILITY
+    OUTPUT_FACILITY = facility
+
+
+def set_output_platform(platform):
+    """
+    Set the output platform for RadCLss files.
+
+    Parameters
+    ----------
+    platform : str
+        The output platform name.
+    """
+    global OUTPUT_PLATFORM
+    OUTPUT_PLATFORM = platform
+
+
+def set_output_level(level):
+    """
+    Set the output level for RadCLss files.
+
+    Parameters
+    ----------
+    level : str
+        The output level name.
+    """
+    global OUTPUT_LEVEL
+    OUTPUT_LEVEL = level
+
+
+def set_output_gate_time_attrs(attrs):
+    """
+    Set the attributes for the gate_time variable.
+
+    Parameters
+    ----------
+    attrs : dict
+        Dictionary of attributes for gate_time.
+    """
+    global OUTPUT_GATE_TIME_ATTRS
+    OUTPUT_GATE_TIME_ATTRS = attrs
+
+
+def set_output_time_offset_attrs(attrs):
+    """
+    Set the attributes for the time_offset variable.
+
+    Parameters
+    ----------
+    attrs : dict
+        Dictionary of attributes for time_offset.
+    """
+    global OUTPUT_TIME_OFFSET_ATTRS
+    OUTPUT_TIME_OFFSET_ATTRS = attrs
+
+
+def set_output_station_attrs(attrs):
+    """
+    Set the attributes for the station variable.
+
+    Parameters
+    ----------
+    attrs : dict
+        Dictionary of attributes for station.
+    """
+    global OUTPUT_STATION_ATTRS
+    OUTPUT_STATION_ATTRS = attrs
+
+
+def set_output_lat_attrs(attrs):
+    """
+    Set the attributes for the lat variable.
+
+    Parameters
+    ----------
+    attrs : dict
+        Dictionary of attributes for lat.
+    """
+    global OUTPUT_LAT_ATTRS
+    OUTPUT_LAT_ATTRS = attrs
+
+
+def set_output_lon_attrs(attrs):
+    """
+    Set the attributes for the lon variable.
+
+    Parameters
+    ----------
+    attrs : dict
+        Dictionary of attributes for lon.
+    """
+    global OUTPUT_LON_ATTRS
+    OUTPUT_LON_ATTRS = attrs
+
+
+def set_output_alt_attrs(attrs):
+    """
+    Set the attributes for the alt variable.
+
+    Parameters
+    ----------
+    attrs : dict
+        Dictionary of attributes for alt.
+    """
+    global OUTPUT_ALT_ATTRS
+    OUTPUT_ALT_ATTRS = attrs
+
+
+def get_output_config():
+    """
+    Get the current output configuration as a dictionary.
+
+    Returns
+    -------
+    dict
+        Dictionary containing the current output configuration.
+    """
+    return {
+        "site": OUTPUT_SITE,
+        "facility": OUTPUT_FACILITY,
+        "platform": OUTPUT_PLATFORM,
+        "level": OUTPUT_LEVEL,
+        "gate_time_attrs": OUTPUT_GATE_TIME_ATTRS,
+        "time_offset_attrs": OUTPUT_TIME_OFFSET_ATTRS,
+        "station_attrs": OUTPUT_STATION_ATTRS,
+        "lat_attrs": OUTPUT_LAT_ATTRS,
+        "lon_attrs": OUTPUT_LON_ATTRS,
+        "alt_attrs": OUTPUT_ALT_ATTRS,
+    }

radclss-2026.2.6/src/radclss/core/__init__.py

@@ -0,0 +1,17 @@
+"""
+=============================
+ radclss.core package
+=============================
+
+This package contains the core functions for RadCLss.
+
+... autosummary::
+    :toctree: generated/
+
+    radclss_core
+
+"""
+
+from .radclss_core import radclss  # noqa: F401
+
+__all__ = ["radclss"]