Science Score: 77.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 10 DOI reference(s) in README -
✓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
-
○Scientific vocabulary similarity
Low similarity (15.3%) to scientific vocabulary
Last synced: 6 months ago
·
JSON representation
·
Repository
Wind retrievals for the WindCube lidar
Basic Info
Statistics
- Stars: 19
- Watchers: 2
- Forks: 6
- Open Issues: 0
- Releases: 6
Created almost 5 years ago
· Last pushed over 1 year ago
Metadata Files
Readme
Changelog
Contributing
License
Citation
Authors
README.rst
======================
lidarwind introduction
======================
.. image:: https://joss.theoj.org/papers/28430a0c6a79e6d1ff33579ff13458f7/status.svg
:target: https://doi.org/10.21105/joss.04852
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7026548.svg
:target: https://doi.org/10.5281/zenodo.7026548
.. image:: https://readthedocs.org/projects/lidarwind/badge/?version=latest
:target: https://lidarwind.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/jdiasn/lidarwind/main?labpath=docs%2Fexamples
.. image:: https://img.shields.io/pypi/v/lidarwind.svg
:target: https://pypi.python.org/pypi/lidarwind/
.. image:: https://codecov.io/gh/jdiasn/lidarwind/branch/main/graph/badge.svg?token=CEZM17YY3I
:target: https://codecov.io/gh/jdiasn/lidarwind
.. note::
Now lidarwind supports data from RPG cloud radars. If you are interested, have a look at Radar usage section.
lidarwind is an open-source Python project that retrieves wind speed and direction profiles from Doppler velocity observations recorded by Doppler-capable instruments. Initially, this package was developed to work with observations from the WindCube-200s lidar, but with this new release, lidarwind starts to support data from RPG Cloud Radars. Currently, It can retrieve wind profiles from the PPI, 6-beam and DBS scanning strategies and calculate the Reynolds stress tensor matrix elements from the 6-beam observation. The package can be further extended to process data from other Doppler lidar and radar and from other scanning strategies.
lidarwind results from an effort to create a flexible and easy-to-use package to process observations recorded by the WindCube Doppler lidar. The package development started in 2021 when I had to retrieve wind profiles from the 6-beam observations.
--------
Citation
--------
If you use lidarwind, or replicate part of it, in your work/package, please consider including the reference:
Neto, J. D. and Castelão, G. P., (2023). lidarwind: A Python package for retrieving wind profiles from Doppler lidar observations. Journal of Open Source Software, 8(82), 4852, https://doi.org/10.21105/joss.04852
::
@article{Neto2023,
doi = {10.21105/joss.04852},
url = {https://doi.org/10.21105/joss.04852},
year = {2023}, publisher = {Journal of Open Source Software},
volume = {8}, number = {82}, pages = {4852},
author = {José Dias Neto and Guilherme P. Castelao},
title = {lidarwind: A Python package for retrieving wind profiles from Doppler lidar observations},
journal = {Journal of Open Source Software}
}
-------------
Documentation
-------------
The lidarwind's documentation is available at https://lidarwind.readthedocs.io. There you can find the steps needed for installing the package. You can also find a short description of how lidarwind derives the wind speed and direction from observations.
Notebooks
=========
An introductory set of rendered notebooks are available at https://nbviewer.org/github/jdiasn/lidarwind/tree/main/docs/examples/ or at https://github.com/jdiasn/lidarwind/tree/main/docs/examples. If you want to try the package without installing it locally, click on the binder badge above. You will be redirected to a virtual environment where you can also access the same notebooks and test the package.
.. 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.
Owner
- Name: Dias Neto
- Login: jdiasn
- Kind: user
- Location: The Netherlands
- Company: Delft University of Technology
- Repositories: 3
- Profile: https://github.com/jdiasn
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/lidarwind license: BSD-3-Clause
GitHub Events
Total
- Watch event: 5
- Fork event: 1
- Create event: 1
Last Year
- Watch event: 5
- Fork event: 1
- Create event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Dias Neto | j****n@g****m | 160 |
| Guilherme Castelão | g****e@c****t | 12 |
| Jose Dias Neto | j****e@s****l | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 13
- Total pull requests: 98
- Average time to close issues: 4 months
- Average time to close pull requests: 3 days
- Total issue authors: 5
- Total pull request authors: 3
- Average comments per issue: 2.0
- Average comments per pull request: 0.99
- Merged pull requests: 95
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 0
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: 8 days
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 2.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jdiasn (4)
- tgoelles (4)
- StevenKnoopKNMI (3)
- acocac (2)
- bgailleton (1)
Pull Request Authors
- jdiasn (87)
- castelao (12)
- dependabot[bot] (4)
Top Labels
Issue Labels
Pull Request Labels
dependencies (4)
Packages
- Total packages: 1
-
Total downloads:
- pypi 23 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 6
- Total maintainers: 1
pypi.org: lidarwind
LIDAR procedures
- Documentation: https://lidarwind.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: 1.0.1
published over 1 year ago
Rankings
Dependent packages count: 10.1%
Dependent repos count: 21.5%
Average: 23.5%
Downloads: 38.8%
Maintainers (1)
Last synced:
6 months ago
Dependencies
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
.github/workflows/ci.yml
actions
- actions/cache v3 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- codecov/codecov-action v3 composite
.github/workflows/tox.yml
actions
- actions/cache v3 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- codecov/codecov-action v3 composite
pyproject.toml
pypi
- click >=8.1.2
- gdown ~=4.5.1
- matplotlib >=3.4.3
- netCDF4 >= 1.5
- numpy >=1.22
- pandas >=1.3.3
- xarray >=0.20
- xarray-datatree ==0.0.9
- xrft >=0.3.0
setup.py
pypi
docs/environment.yml
pypi
- gdown *
- lidarwind *
- pooch *
- xrft *
docs/requirements.pip
pypi
- gdown *
- matplotlib *
- nbsphinx *
- numpy *
- pandas *
- pooch *
- sphinx *
- sphinx-gallery *
- sphinx_rtd_theme *
- xarray *
- xarray-datatree *
- xrft *
environment.yml
pypi
- gdown ==4.5.1
- lidarwind ==0.2.4
- pooch ==1.6.0