Data

Tools

Indexes

Applications

Experiments

Open Source Science

lidarwind

lidarwind: A Python package for retrieving wind profiles from Doppler lidar observations - Published in JOSS (2023)

https://github.com/jdiasn/lidarsuit

Science Score: 100.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
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • ✓
    Committers with academic emails
    1 of 3 committers (33.3%) from academic institutions
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Earth and Environmental Sciences Physical Sciences - 87% confidence
Last synced: 4 months ago · JSON representation ·

Repository

Archived. Please check https://github.com/jdiasn/lidarwind

Basic Info
  • Host: GitHub
  • Owner: jdiasn
  • License: other
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 12.8 MB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created almost 3 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Changelog Contributing License Citation Authors

README.rst 

=============
!!ATTENTION!!
=============

**Archived:** This repository was archived and is not maintained anymore. The lidarSuit project was renamed to lidarwind, please check https://github.com/jdiasn/lidarwind

======================
lidarSuit introduction
======================

.. image:: https://joss.theoj.org/papers/28430a0c6a79e6d1ff33579ff13458f7/status.svg
   :target: https://raw.githubusercontent.com/openjournals/joss-papers/joss.04715/joss.04715/10.21105.joss.04715.pdf

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7026548.svg
   :target: https://doi.org/10.5281/zenodo.7026548

.. image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/jdiasn/lidarSuit/main?labpath=notebooks

.. image:: https://readthedocs.org/projects/lidarsuit/badge/?version=latest
    :target: https://lidarsuit.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/lidarSuit.svg
   :target: https://pypi.python.org/pypi/lidarSuit/

.. image:: https://codecov.io/gh/jdiasn/lidarSuit/branch/main/graph/badge.svg?token=CEZM17YY3I
   :target: https://codecov.io/gh/jdiasn/lidarSuit

lidarSuit is an open-source Python project to retrieve wind speed and direction profiles from Doppler lidar observations from the WindCube-200s, and it was developed to be easy to use. It can retrieve wind profiles from the 6-beam and DBS scanning strategies and allow users to set the signal-to-noise ratio threshold to reduce the noise. It also calculates the Reynolds stress tensor matrix elements from the 6-beam observations.

lidarSuit is a result of an effort to create an environment where it would be flexible and easy to process the observations from the WindCube Doppler lidar. Its development started in 2021 when I had to retrieve wind profiles from the 6-beam observations.

This current version focuses on the WindCube's observations, and the wind retrievals are dedicated to the 6-beam and DBS observations. However, it can be expanded to other Doppler lidar observations and scanning strategies.


-------------
Documentation
-------------

The lidarSuit's documentation is available at https://lidarsuit.readthedocs.io, and an introductory set of rendered notebooks are available at https://nbviewer.org/github/jdiasn/lidarSuit/tree/main/docs/examples/.



.. warning::

    Beware that between versions 0.1.6 and 0.2.0, the package underwent significant refactoring. Now the classes' names
    follow the Pascal case, while module names, functions and attributes follow the snake case. Codes developed using the previous
    version will need revision.



----------
Suggestion
----------

If you want to try using this package without instaling first, you can do it by clicking on the binder badge.

Owner

  • Name: Dias Neto
  • Login: jdiasn
  • Kind: user
  • Location: The Netherlands
  • Company: Delft University of Technology

JOSS Publication

lidarwind: A Python package for retrieving wind profiles from Doppler lidar observations
Published
February 16, 2023
DOI
Volume 8, Issue 82, Page 4852
Authors
José Dias Neto ORCID
Delft University of Technology
Guilherme P. Castelao ORCID
Scripps Institution of Oceanography
Editor
Jayaram Hariharan ORCID
Tags
meteorology Doppler wind lidar lidar remote sensing wind profile retrievals
View PDF Review Thread Software Archive

Citation (CITATION.cff) 

cff-version: 1.1.0
message: If you use this software, please cite it using these metadata.
title: 'A python package for retrieving wind profiles from Doppler lidar observations'
authors:
- given-names: José
  family-names: Dias Neto
  affiliation: Delft University of Technology - The Netherlands
  orcid: https://orcid.org/0000-0002-8488-8486
- given-names: Guilherme
  family-names: Castelao
  affiliation: Scripps Institution of Oceanography - UC San Diego
  orcid: https://orcid.org/0000-0002-6765-0708
version: 0.1.4
doi: 10.5281/zenodo.7026548
repository-code: https://github.com/jdiasn/lidarSuit
license: BSD-3-Clause

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 134
  • Total Committers: 3
  • Avg Commits per committer: 44.667
  • Development Distribution Score (DDS): 0.067
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Dias Neto j****n@g****m 125
Guilherme Castelão g****e@c****t 8
Jose Dias Neto j****e@s****l 1
Committer Domains (Top 20 + Academic)
shell-2.grs.vrlab.tudelft.nl: 1 castelao.net: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 11 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
pypi.org: lidarsuit

LIDAR procedures

  • Documentation: https://lidarsuit.readthedocs.io/
  • License: BSD License Copyright (c) 2022, Jose Dias Neto All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Latest release: 0.1.6
    published about 3 years ago
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 11 Last month
Rankings
Dependent packages count: 6.6%
Average: 18.6%
Dependent repos count: 30.6%
Maintainers (1)
jdiasneto
Last synced: 4 months ago

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
docs/environment.yml pypi
  • gdown *
  • lidarSuit *
  • xrft *
environment.yml pypi
  • gdown ==4.5.1
  • lidarSuit ==0.1.6
pyproject.toml pypi
  • click >=8.1.2
  • gdown ~=4.5.1
  • matplotlib >=3.4.3
  • netCDF4 >= 1.5
  • numpy >=1.20.3
  • pandas >=1.3.3
  • xarray >=0.19.0
  • xarray-datatree ==0.0.9
  • xrft >=0.3.0
requirements_dev.txt pypi
  • Click ==7.1.2 development
  • Sphinx ==1.8.5 development
  • black ==21.7b0 development
  • bump2version ==0.5.11 development
  • coverage ==4.5.4 development
  • flake8 ==3.7.8 development
  • pip ==21.1 development
  • pytest ==6.2.4 development
  • tox ==3.14.0 development
  • twine ==1.14.0 development
  • watchdog ==0.9.0 development
  • wheel ==0.33.6 development