diff --git a/AUTHORS.md b/AUTHORS.md index 0924c3b..7a2b43c 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -11,3 +11,5 @@ * Edouard Goudenhoofdt * Hamid Ali Syed * Alfonso Ladino +* Bobby Jackson +* Daniel Wolfensberger diff --git a/CITATION.cff b/CITATION.cff index 261b1c6..4b0545e 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -3,7 +3,7 @@ cff-version: 1.0.3 message: If you use this software, please cite it using these metadata. # FIXME title as repository name might not be the best name, please make human readable -title: 'openradar/xradar: xradar v0.4.0' +title: 'openradar/xradar: xradar v0.6.0' doi: 10.5281/zenodo.7091737 # FIXME splitting of full names is error prone, please check if given/family name are correct authors: @@ -27,7 +27,16 @@ authors: family-names: Ladino affiliation: University of Illinois at Urbana Champaign orcid: https://orcid.org/0000-0001-8081-7827 -version: 0.4.0 -date-released: 2023-09-27 +- given-names: Robert + family-names: Jackson + affiliation: Argonne National Laboratory + orcid: https://orcid.org/0000-0003-2518-1234 +- given-names: Daniel + family-names: Wolfensberger + affiliation: Federal Office of Meteorology and Climatology MeteoSwiss + orcid: https://orcid.org/0009-0006-1419-0556 + +version: 0.6.0 +date-released: 2024-08-05 repository-code: https://github.com/openradar/xradar license: MIT diff --git a/docs/history.md b/docs/history.md index 5d1535a..b2c6425 100644 --- a/docs/history.md +++ b/docs/history.md @@ -1,6 +1,6 @@ # History -## Development Version (unreleased) +## 0.6.0 (2024-08-05) * ADD: DataMet reader ({pull}`175`) by [@wolfidan](https://github.com/wolfidan). * FIX: Nexrad level2 time offset of 1 day, skip reading missing elevations, introduce new radial_status of 5 diff --git a/xradar/io/backends/__init__.py b/xradar/io/backends/__init__.py index 2f8af31..6ce42e3 100644 --- a/xradar/io/backends/__init__.py +++ b/xradar/io/backends/__init__.py @@ -15,6 +15,7 @@ .. automodule:: xradar.io.backends.furuno .. automodule:: xradar.io.backends.rainbow .. automodule:: xradar.io.backends.iris +.. automodule:: xradar.io.backends.hpl .. automodule:: xradar.io.backends.nexrad_level2 .. automodule:: xradar.io.backends.datamet diff --git a/xradar/io/backends/hpl.py b/xradar/io/backends/hpl.py index fac35d0..b4b068d 100644 --- a/xradar/io/backends/hpl.py +++ b/xradar/io/backends/hpl.py @@ -1,28 +1,42 @@ -""" -Conversion tool for StreamLine .hpl files into netCDF (.nc) files: - - - hpl2dict(): import .hpl files and save as dictionary - - hpl_to_netcdf(): save .hpl files into level0 (l0) .nc files - - to_netcdf_l1(): correct raw data (l0) and create level1 (l1) netCDF files +#!/usr/bin/env python +# Copyright (c) 2024, openradar developers. +# Distributed under the MIT License. See LICENSE for more info. """ -import io +StreamLine HPL +============== -import numpy as np -import pandas as pd -import xarray as xr +This sub-module contains the StreamLine HPL xarray backend for reading StreamLine-based lidar +data into Xarray structures. -""" Import of StreamLine .hpl (txt) files and save locally in directory. Therefore the data is converted into matrices with dimension "number of range gates" x "time stamp/rays". In newer versions of the StreamLine software, the spectral width can be stored as additional parameter in the .hpl files. + +.. autosummary:: + :nosignatures: + :toctree: generated/ + + {} + """ +__all__ = [ + "HPLBackendEntrypoint", + "open_hpl_datatree", +] + +__doc__ = __doc__.format("\n ".join(__all__)) + +import io from collections import OrderedDict from datetime import datetime, timedelta +import numpy as np +import pandas as pd +import xarray as xr from datatree import DataTree from xarray.backends.common import AbstractDataStore, BackendArray, BackendEntrypoint from xarray.backends.file_manager import CachingFileManager @@ -40,13 +54,6 @@ ) from .common import _assign_root, _attach_sweep_groups -__all__ = [ - "HPLBackendEntrypoint", - "open_hpl_datatree", -] - -__doc__ = __doc__.format("\n ".join(__all__)) - variable_attr_dict = {} variable_attr_dict["intensity"] = { "long_name": "Backscatter intensity",