Lrose Wiki - User contributions [en]

Main Page

2021-02-17T18:09:27Z

Kyoung: Updated installation instructions

== '''LROSE: The Lidar Radar Open Software Environment''' ==

=== Overview ===

The current LROSE release is called '''“Elle”''' (a pink blend fragrant rose) and encompasses six key toolsets that define a core lidar/radar workflow: ''[http://wiki.lrose.net/index.php?title=Main_Page#Convert Convert], [http://wiki.lrose.net/index.php?title=Main_Page#Display Display], [http://wiki.lrose.net/index.php?title=Main_Page#Quality_Control QC], [http://wiki.lrose.net/index.php?title=Main_Page#Grid Grid], [http://wiki.lrose.net/index.php?title=Main_Page#Echo Echo], and [http://wiki.lrose.net/index.php?title=Main_Page#Wind Winds].'' '''Elle''' focuses on high-quality, well-tested, well-maintained and well-documented key applications as ‘building blocks’, allowing users to assemble trusted, reproducible workflows to accomplish more complex scientific tasks.

Elle can be compiled in C++ for native apps on Linux or Mac. Preliminary support is available for some tools on Windows.

We encourage users to [http://lrose.net/software.html register] in order to receive critical software updates, and sign up for the mailing list to help build the LROSE community.

[http://lrose.net/help.html Help] can be obtained by posting issues directly to the lrose-cyclone Github repository, via our help mailing list, or Discourse user forum.

LROSE is a co-operative project between:

* [http://www.atmos.colostate.edu/ Dept. of Atmospheric Science at Colorado State University (CSU)] and the
* [https://www.eol.ucar.edu/content/lidar-radar-open-software-environment The Earth Observing Lab at the National Center for Atmospheric Research (NCAR)].

LROSE is funded by the [https://www.nsf.gov National Science Foundation].

=== Citations for LROSE tools ===

Please cite the version of LROSE tools you use for publication.

* '''[https://doi.org/10.5281/zenodo.3604387 lrose-cyclone]''': Bell, M. M. and Melli B. (2020). nsf-lrose/lrose-cyclone: lrose-cyclone-20200110. https://doi.org/10.5281/zenodo.3604387
* '''[https://doi.org/10.5281/zenodo.2532758 lrose-blaze]''': Bell, M. M. (2019). nsf‐lrose/lrose‐blaze: lrose‐blaze‐20190105. https://doi.org/10.5281/zenodo.2532758

=== Installation Instructions ===

=====''' Homebrew Installation '''=====
* '''[http://wiki.lrose.net/index.php/Mac-Homebrew-Installation Mac Homebrew installation]''' - For Native applications on the Mac, the recommended method is to use Homebrew. The formula contains all the necessary dependencies and builds instructions.
# Download, install, and run Homebrew
# Download the lrose-core formula lrose-core.rb
# Go to the directory stored lrose-core.rb, and install lrose-core by typing the following command in a terminal:
brew install lrose-core.rb

You are done with installation! Go to the Documentation to learn how to run LROSE-Elle

=====''' Source Installation '''=====
Intended for users who wish to do a manual build or build in a non-standard location.Source compilation on the Mac is best performed using a supplied Python script.
* '''[http://wiki.lrose.net/index.php/Mac-Build Mac Build]'''

* '''[http://wiki.lrose.net/index.php/Linux-Build Linux Build]'''

=====''' Binary Installation '''=====
* '''[http://wiki.lrose.net/index.php/CIDD-Binary-Release CIDD Binary Release]''' - CIDD depends on a 32-bit build, which complicates the build and install for the core. The CIDD display application is not included in the standard lrose-core packages (above).

=== Tutorials ===

* '''quick start'''
** '''[http://wiki.lrose.net/index.php/lrose_quickstart lrose quickstart tutorial]''' - Go over the basics to get up and running quickly with LROSE.

* '''echo tutorials'''
** '''[http://wiki.lrose.net/index.php/elle_basic basic elle echo tutorial]''' - Go through the basic steps necessary to convert a raw radar file to CfRadial, calculate Kdp and three-dimensional rain rate, and estimate the surface rainfall. The purpose of this tutorial is to confirm that the install process was successful and that some programs are working.
** '''[http://wiki.lrose.net/index.php/elle_basic_plus basic+ elle echo tutorial]''' - Similar to the basic elle tutorial with the added tasks of downloading GFS analysis from which to estimate a sounding near the radar and running the RadxBeamBlock application.
** '''[http://wiki.lrose.net/index.php/elle_full full elle echo tutorial]''' - This tutorial assumes the user has radar data downloaded in an [http://wiki.lrose.net/index.php/RadxConvert acceptable radar format] and walks through the most important parameters that need to be edited to run the Quantitative Precipitation Estimation (QPE) workflow.

* '''grid tutorial'''
** '''[http://wiki.lrose.net/index.php/elle_grid elle regrid and convective/stratiform tutorial]''' - Convert raw NEXRAD data to the cfradial format and then interpolate to a cartesian grid and applies a convective stratiform separation algorithm.

* '''wind tutorial'''
** '''[http://wiki.lrose.net/index.php/vortrac_tutorial VORTRAC tutorial]''' - run VORTRAC to retrieve the winds from the single Doppler radar data.

=== Toolsets ===
In the current release, the following tools are available:

==== Convert ====

* '''[http://wiki.lrose.net/index.php/RadxPrint RadxPrint]''' - Query files to determine properties and support by the Radx engine
* '''[http://wiki.lrose.net/index.php/RadxConvert RadxConvert]''' - Convert 24 different lidar and radar formats to CfRadial NetCDF format
* '''RadxBufr''' - Convert Bufr format to CfRadial NetCDF format

==== Display ====

* '''[http://wiki.lrose.net/index.php/HawkEye HawkEye]''' - Real-time and archive display suitable for both scanning and vertically pointing radars.

==== Quality Control ====

* '''RadxDiffFields''' - Compare two fields in different CfRadial files
* '''RadxDiffVol''' - Compare two volumes in different CfRadial files
* '''RadxMergeFields''' - Merge fields from different CfRadial files
* '''RadxFilter''' - Perform simple filtering operations
* '''RadxPersistentClutter''' - Create a mask for persistent ground clutter

==== Grid ====

* '''[http://wiki.lrose.net/index.php/Radx2Grid Radx2Grid]''' - Gridding and interpolation of ground-based radar data

==== Echo ====

* '''[http://wiki.lrose.net/index.php/RadxKdp RadxKdp]''' - KDP and Attenuation calculations
* '''[http://wiki.lrose.net/index.php/RadxPid RadxPid]''' - KDP, Attenuation, and Particle Identification
* '''[http://wiki.lrose.net/index.php/RadxRate RadxRate]''' - KDP, Attenuation, PID, and Rain Rate
* '''[http://wiki.lrose.net/index.php/RadxQpe RadxQpe]''' - Accumulated Quantitative Precipitation Estimation
* '''[http://wiki.lrose.net/index.php/RadxBeamBlock RadxBeamBlock]''' - Beam Blockage Estimation

==== Wind ====

* '''[http://wiki.lrose.net/index.php/RadxEvad RadxEvad]''' - Extended Velocity Azimuth Display single-Doppler retrieval
* '''[http://wiki.lrose.net/index.php/FRACTL FRACTL]''' - Fast Reorder and CEDRIC Technique in LROSE multi-Doppler retrieval
* '''[http://wiki.lrose.net/index.php/SAMURAI SAMURAI]''' - Variational multi-Doppler retrieval and analysis package
* '''[http://wiki.lrose.net/index.php/VORTRAC VORTRAC]''' - Vortex Objective Radar Tracking and Circulation single-Doppler retrieval

== '''LROSE Workshops''' ==

=== LROSE AMS 2020 Mini Workshop ===
*'''[http://wiki.lrose.net/images/a/ae/LROSE_AMS_2020_Mini-Workshop_Agenda.pdf Meeting Notes]'''
*'''[http://wiki.lrose.net/images/8/89/Mmbell_LROSE_AMSannual2020_small.pdf LROSE Mini-Workshop Slides]'''
*'''[http://wiki.lrose.net/images/9/9c/LROSE-CycloneDoppler_small.pdf LROSE Cyclone Multi-Doppler Tutorial Slides]'''
*'''[http://wiki.lrose.net/images/0/09/HawkEye_Tutorial.pdf Brief Hawkeye Tutorial Slides]'''

Main Page

2021-02-05T23:17:52Z

Kyoung:

== '''LROSE: The Lidar Radar Open Software Environment''' ==

=== Overview ===

The current LROSE release is called '''“Elle”''' (a pink blend fragrant rose) and encompasses six key toolsets that define a core lidar/radar workflow: ''[http://wiki.lrose.net/index.php?title=Main_Page#Convert Convert], [http://wiki.lrose.net/index.php?title=Main_Page#Display Display], [http://wiki.lrose.net/index.php?title=Main_Page#Quality_Control QC], [http://wiki.lrose.net/index.php?title=Main_Page#Grid Grid], [http://wiki.lrose.net/index.php?title=Main_Page#Echo Echo], and [http://wiki.lrose.net/index.php?title=Main_Page#Wind Winds].'' '''Elle''' focuses on high-quality, well-tested, well-maintained and well-documented key applications as ‘building blocks’, allowing users to assemble trusted, reproducible workflows to accomplish more complex scientific tasks.

Elle can be compiled in C++ for native apps on Linux or Mac. Preliminary support is available for some tools on Windows.

We encourage users to [http://lrose.net/software.html register] in order to receive critical software updates, and sign up for the mailing list to help build the LROSE community.

[http://lrose.net/help.html Help] can be obtained by posting issues directly to the lrose-cyclone Github repository, via our help mailing list, or Discourse user forum.

LROSE is a co-operative project between:

* [http://www.atmos.colostate.edu/ Dept. of Atmospheric Science at Colorado State University (CSU)] and the
* [https://www.eol.ucar.edu/content/lidar-radar-open-software-environment The Earth Observing Lab at the National Center for Atmospheric Research (NCAR)].

LROSE is funded by the [https://www.nsf.gov National Science Foundation].

=== Citations for LROSE tools ===

Please cite the version of LROSE tools you use for publication.

* '''[https://doi.org/10.5281/zenodo.2532758 lrose-blaze]''': Bell, M. M. (2019). nsf‐lrose/lrose‐blaze: lrose‐blaze‐20190105. https://doi.org/10.5281/zenodo.2532758
* '''[https://doi.org/10.5281/zenodo.3604387 lrose-cyclone]''': Bell, M. M. and Melli B. (2020). nsf-lrose/lrose-cyclone: lrose-cyclone-20200110. https://doi.org/10.5281/zenodo.3604387

=== Installation Instructions ===
===== Homebrew Installation =====
* '''[http://wiki.lrose.net/index.php/Mac-Homebrew-Installation Mac Homebrew installation]''' - For Native applications on the Mac, the recommended method is to use Homebrew. The formula contains all the necessary dependencies and builds instructions.

===== Source Installation =====
Intended for users who wish to do a manual build or build in a non-standard location
* '''[http://wiki.lrose.net/index.php/Mac-Build Mac Build]''' - Source compilation on the Mac is best performed using a supplied Python script.

* '''[http://wiki.lrose.net/index.php/Linux-Build Linux Build]''' - Source compilation on the Linux is best performed using a supplied Python script.

===== Binary Installation =====
* '''[http://wiki.lrose.net/index.php/CIDD-Binary-Release CIDD Binary Release]''' - CIDD depends on a 32-bit build, which complicates the build and install for the core. The CIDD display application is not included in the standard lrose-core packages (above).

=== Tutorials ===

* '''quick start'''
** '''[http://wiki.lrose.net/index.php/lrose_quickstart lrose quickstart tutorial]''' - Go over the basics to get up and running quickly with LROSE.

* '''echo tutorials'''
** '''[http://wiki.lrose.net/index.php/elle_basic basic elle echo tutorial]''' - Go through the basic steps necessary to convert a raw radar file to CfRadial, calculate Kdp and three-dimensional rain rate, and estimate the surface rainfall. The purpose of this tutorial is to confirm that the install process was successful and that some programs are working.
** '''[http://wiki.lrose.net/index.php/elle_basic_plus basic+ elle echo tutorial]''' - Similar to the basic elle tutorial with the added tasks of downloading GFS analysis from which to estimate a sounding near the radar and running the RadxBeamBlock application.
** '''[http://wiki.lrose.net/index.php/elle_full full elle echo tutorial]''' - This tutorial assumes the user has radar data downloaded in an [http://wiki.lrose.net/index.php/RadxConvert acceptable radar format] and walks through the most important parameters that need to be edited to run the Quantitative Precipitation Estimation (QPE) workflow.

* '''grid tutorial'''
** '''[http://wiki.lrose.net/index.php/elle_grid elle regrid and convective/stratiform tutorial]''' - Convert raw NEXRAD data to the cfradial format and then interpolate to a cartesian grid and applies a convective stratiform separation algorithm.

* '''wind tutorial'''
** '''[http://wiki.lrose.net/index.php/vortrac_tutorial VORTRAC tutorial]''' - run VORTRAC to retrieve the winds from the single Doppler radar data.

=== Toolsets ===
In the current release, the following tools are available:

==== Convert ====

* '''[http://wiki.lrose.net/index.php/RadxPrint RadxPrint]''' - Query files to determine properties and support by the Radx engine
* '''[http://wiki.lrose.net/index.php/RadxConvert RadxConvert]''' - Convert 24 different lidar and radar formats to CfRadial NetCDF format
* '''RadxBufr''' - Convert Bufr format to CfRadial NetCDF format

==== Display ====

* '''[http://wiki.lrose.net/index.php/HawkEye HawkEye]''' - Real-time and archive display suitable for both scanning and vertically pointing radars.

==== Quality Control ====

* '''RadxDiffFields''' - Compare two fields in different CfRadial files
* '''RadxDiffVol''' - Compare two volumes in different CfRadial files
* '''RadxMergeFields''' - Merge fields from different CfRadial files
* '''RadxFilter''' - Perform simple filtering operations
* '''RadxPersistentClutter''' - Create a mask for persistent ground clutter

==== Grid ====

* '''[http://wiki.lrose.net/index.php/Radx2Grid Radx2Grid]''' - Gridding and interpolation of ground-based radar data

==== Echo ====

* '''[http://wiki.lrose.net/index.php/RadxKdp RadxKdp]''' - KDP and Attenuation calculations
* '''[http://wiki.lrose.net/index.php/RadxPid RadxPid]''' - KDP, Attenuation, and Particle Identification
* '''[http://wiki.lrose.net/index.php/RadxRate RadxRate]''' - KDP, Attenuation, PID, and Rain Rate
* '''[http://wiki.lrose.net/index.php/RadxQpe RadxQpe]''' - Accumulated Quantitative Precipitation Estimation
* '''[http://wiki.lrose.net/index.php/RadxBeamBlock RadxBeamBlock]''' - Beam Blockage Estimation

==== Wind ====

* '''[http://wiki.lrose.net/index.php/RadxEvad RadxEvad]''' - Extended Velocity Azimuth Display single-Doppler retrieval
* '''[http://wiki.lrose.net/index.php/FRACTL FRACTL]''' - Fast Reorder and CEDRIC Technique in LROSE multi-Doppler retrieval
* '''[http://wiki.lrose.net/index.php/SAMURAI SAMURAI]''' - Variational multi-Doppler retrieval and analysis package
* '''[http://wiki.lrose.net/index.php/VORTRAC VORTRAC]''' - Vortex Objective Radar Tracking and Circulation single-Doppler retrieval

== '''LROSE Workshops''' ==

=== LROSE AMS 2020 Mini Workshop ===
*'''[http://wiki.lrose.net/images/a/ae/LROSE_AMS_2020_Mini-Workshop_Agenda.pdf Meeting Notes]'''
*'''[http://wiki.lrose.net/images/8/89/Mmbell_LROSE_AMSannual2020_small.pdf LROSE Mini-Workshop Slides]'''
*'''[http://wiki.lrose.net/images/9/9c/LROSE-CycloneDoppler_small.pdf LROSE Cyclone Multi-Doppler Tutorial Slides]'''
*'''[http://wiki.lrose.net/images/0/09/HawkEye_Tutorial.pdf Brief Hawkeye Tutorial Slides]'''