Skip to content

Commit

Permalink
Refactor: updating documentation (#117)
Browse files Browse the repository at this point in the history
* Refactor: updating reading (RPG Radar)

* Refactor: updating readme

* Refactor: update reademe

* Refactor: radar wind retrieval doc

* Refactor: Radar usage section

* Refactor: adding ppi figure

* Update: radar wind scaning doc

* update: extending doc

* update: RPG note

* Update: sections to be extended

* Feat: Adding a RPG processing example

* Feat: adding a notebook example for the radar part

* Refactor: extending the RPG radar usage

* Refactor: introduction change

* Refactor: small text fix
  • Loading branch information
jdiasn authored Jul 3, 2024
1 parent 71202e9 commit a7c21f6
Show file tree
Hide file tree
Showing 6 changed files with 1,380 additions and 25 deletions.
47 changes: 26 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,31 +21,16 @@ lidarwind introduction
.. image:: https://codecov.io/gh/jdiasn/lidarwind/branch/main/graph/badge.svg?token=CEZM17YY3I
:target: https://codecov.io/gh/jdiasn/lidarwind

lidarwind 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.

lidarwind 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.
.. note::
Now lidarwind supports data from RPG cloud radars. If you are interested, have a look at Radar usage section.

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.

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.

-------------
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 the lidar wind derives the wind speed and direction from WindCube's observations.

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.

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.

--------
Citation
--------
Expand All @@ -59,9 +44,29 @@ Neto, J. D. and Castelão, G. P., (2023). lidarwind: A Python package for retrie
@article{Neto2023,
doi = {10.21105/joss.04852},
url = {https://doi.org/10.21105/joss.04852},
year = {2023}, publisher = {The Open Journal},
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.
2 changes: 1 addition & 1 deletion docs/examples/dbs_scans_rendered.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -823,7 +823,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.13"
"version": "3.10.14"
}
},
"nbformat": 4,
Expand Down
Loading

0 comments on commit a7c21f6

Please sign in to comment.