Lrose quickstart - Revision history

Jcdehart: /* Install */

2025-07-07T23:03:25Z

Install

Jcdehart: /* Install */

2025-07-07T23:02:39Z

Install

Jcdehart: /* Create a parameter file */

2025-03-12T21:17:40Z

Create a parameter file

Jcdehart: /* Create a parameter file */

2025-03-12T21:17:23Z

Create a parameter file

Jcdehart: /* Create a parameter file */

2025-03-12T21:16:27Z

Create a parameter file

Jcdehart: /* Quick Start Complete! */

2025-03-12T21:12:32Z

Quick Start Complete!

Jcdehart at 21:12, 12 March 2025

2025-03-12T21:12:04Z

Jcdehart at 20:57, 12 March 2025

2025-03-12T20:57:23Z

Jcdehart: /* Quick Start Complete! */

2021-01-28T17:40:56Z

Quick Start Complete!

Jcdehart: /* Display the data in HawkEye */

2021-01-28T17:39:11Z

Display the data in HawkEye

@@ Line 17: / Line 17: @@
 ==== '''Install''' ====
-Installation instructions for brew, Linux packages, and source can be found on the [GitHub release page](https://github.com/NCAR/lrose-core/releases) for each release of LROSE.
+Installation instructions for brew, Linux packages, and source can be found on the [https://github.com/NCAR/lrose-core/releases GitHub release page] for each release of LROSE.
 ==== '''Get some data''' ====

@@ Line 17: / Line 17: @@
 ==== '''Install''' ====
-Follow the [http://lrose.net/software.html install instructions].
+Installation instructions for brew, Linux packages, and source can be found on the [GitHub release page](https://github.com/NCAR/lrose-core/releases) for each release of LROSE.
 ==== '''Get some data''' ====

@@ Line 53: / Line 53: @@
 For example, a user might choose to change the "transform_fields_for_interpolation" parameter to TRUE, and in this example change the "input_name" and "output_name" parameters inside the "transform_fields" parameter to REF, to transform the reflectivity field to linear units before interpolation. Once the parameter file is saved, the parameter file is used by the program using the -params flag. A parameter file can be used in conjunction with command line flags, though command line flags supersede whatever is in the parameter file:
-  Radx2Grid -params > ./Radx2Grid.params -f $PWD/output/20161006/* -outdir $PWD/grid
+  Radx2Grid -params > ./Radx2Grid.params -f $PWD/output/20161006/* -outdir $PWD/grid_linear
 ==== '''Quick Start Complete!''' ====

← Older revision		Revision as of 21:17, 12 March 2025
Line 52:		Line 52:


−	For example, a user might choose to change the "transform_fields_for_interpolation" parameter to TRUE, and in this example change the input_name and output_name parameters to REF, to transform the reflectivity field to linear units before interpolation. Once the parameter file is saved, the parameter file is used by the program using the -params flag. A parameter file can be used in conjunction with command line flags, though command line flags supersede whatever is in the parameter file:	+	For example, a user might choose to change the "transform_fields_for_interpolation" parameter to TRUE, and in this example change the "input_name" and "output_name" parameters inside the "transform_fields" parameter to REF, to transform the reflectivity field to linear units before interpolation. Once the parameter file is saved, the parameter file is used by the program using the -params flag. A parameter file can be used in conjunction with command line flags, though command line flags supersede whatever is in the parameter file:
	Radx2Grid -params > ./Radx2Grid.params -f $PWD/output/20161006/* -outdir $PWD/grid		Radx2Grid -params > ./Radx2Grid.params -f $PWD/output/20161006/* -outdir $PWD/grid

@@ Line 51: / Line 51: @@
   Radx2Grid -print_params > ./Radx2Grid.params
 Once the parameter file is saved, the parameter file is used by the program using the -params flag. A parameter file can be used in conjunction with command line flags, though command line flags supersede whatever is in the parameter file:
   Radx2Grid -params > ./Radx2Grid.params -f $PWD/output/20161006/* -outdir $PWD/grid

@@ Line 55: / Line 55: @@
 ==== '''Quick Start Complete!''' ====
-If you have successfully run the previous steps then you should now have a Cartesian gridded NetCDF file to use for further analysis called ncf_20161006_191339.nc in the grid’ subdirectory. From here, you can read in the CfRadial or gridded netCDF file using Julia, Python, or other programming language for further analysis. Continue with the documentation to find out more about LROSE and the many options and parameters available in the LROSE-elle software suite.
+If you have successfully run the previous steps then you should now have a Cartesian gridded NetCDF file to use for further analysis called ncf_20161006_191339.nc in the grid’ subdirectory. From here, you can read in the CfRadial or gridded netCDF file using Julia, Python, or other programming language for further analysis.
 [[File:Qs_ncview_lg_ref.png|275px]][[File:Qs_ncview_ref.png|300px]][[File:Qs_ncview_lg_vel.png|275px]][[File:Qs_ncview_vel.png|300px]]

@@ Line 13: / Line 13: @@
 <ol start="4" style="list-style-type: decimal;">
 <li>Perform coordinate transformations from the polar grid to a Cartesian grid using Radx2Grid.</li></ol>
 ==== '''Install''' ====
@@ Line 26: / Line 28: @@
 LROSE can handle 24 radar and lidar formats (and counting). To see if your data works with LROSE, first use RadxPrint to print the metadata.
-The following instructions assume you are using the LROSE binaries. If you are using your own data, replace the name of the file.
+The following instructions assume you are using the LROSE binaries. If you are using your own data, replace the name of the file. The -f flag tells LROSE to use the FILELIST mode, where the path to the file is provided (the wildcard symbol * can be used to link to multiple files).
   RadxPrint -f $PWD/Level2_KAMX_20161006_1906.ar2v
 If the program returns ‘File format not recognized’ then it is not a file format that LROSE currently supports. Otherwise, you should see text output with all the metadata from your file.
 ==== '''Convert the data to CfRadial''' ====
-The LROSE workflow relies on the CfRadial format for all subsequent display and analysis. Use RadxConvert to convert your file(s) to CfRadial. It will work on any file that is recognized by RadxPrint from the first step through the Radx engine backend.
+The LROSE workflow relies on the CfRadial format for all subsequent display and analysis. Use RadxConvert to convert your file(s) to CfRadial. It will work on any file that is recognized by RadxPrint from the first step through the Radx engine backend. Here, the -outdir flag tells RadxConvert the output directory, or where the output files should be written.
   RadxConvert -f $PWD/Level2_KAMX_20161006_1906.ar2v -outdir $PWD/output
@@ Line 44: / Line 46: @@
 A common first step for working with NEXRAD data is to interpolate the data from its native radial coordinate to a regular grid. Radx2Grid can grid ground-based and some airborne lidar and radar data in spherical and Cartesian space. While there are many options for Radx2Grid, a basic gridding technique can be accomplished simply:
   Radx2Grid -f $PWD/output/20161006/* -outdir $PWD/grid
 ==== '''Quick Start Complete!''' ====

@@ Line 27: / Line 27: @@
 The following instructions assume you are using the LROSE binaries. If you are using your own data, replace the name of the file.
-  /path/to/RadxPrint -f $PWD/Level2_KAMX_20161006_1906.ar2v
+  RadxPrint -f $PWD/Level2_KAMX_20161006_1906.ar2v
 If the program returns ‘File format not recognized’ then it is not a file format that LROSE currently supports. Otherwise, you should see text output with all the metadata from your file.
 ==== '''Convert the data to CfRadial''' ====
 The LROSE workflow relies on the CfRadial format for all subsequent display and analysis. Use RadxConvert to convert your file(s) to CfRadial. It will work on any file that is recognized by RadxPrint from the first step through the Radx engine backend.
-  /path/to/RadxConvert -f $PWD/Level2_KAMX_20161006_1906.ar2v -outdir $PWD/output
+  RadxConvert -f $PWD/Level2_KAMX_20161006_1906.ar2v -outdir $PWD/output
 ==== '''Display the data in HawkEye''' ====
 HawkEye is a next generation data display that will eventually include editing capabilities. Use HawkEye to view the CfRadial files generated by RadxConvert on Linux and Mac (dmg) operating systems, respectively:
-  /path/to/HawkEye -f $PWD/output/20161006/*
+  HawkEye -f $PWD/output/20161006/*
   /Applications/HawkEye.app/Contents/MacOS/HawkEye -f $PWD/output/20161006/*
@@ Line 43: / Line 43: @@
 ==== '''Grid the data into Cartesian space''' ====
 A common first step for working with NEXRAD data is to interpolate the data from its native radial coordinate to a regular grid. Radx2Grid can grid ground-based and some airborne lidar and radar data in spherical and Cartesian space. While there are many options for Radx2Grid, a basic gridding technique can be accomplished simply:
-  /path/to/Radx2Grid -f $PWD/output/20161006/* -outdir $PWD/grid
+  Radx2Grid -f $PWD/output/20161006/* -outdir $PWD/grid
 ==== '''Quick Start Complete!''' ====

@@ Line 47: / Line 47: @@
 ==== '''Quick Start Complete!''' ====
 If you have successfully run the previous steps then you should now have a Cartesian gridded NetCDF file to use for further analysis called ncf_20161006_191339.nc in the grid’ subdirectory. From here, you can read in the CfRadial or gridded netCDF file using Julia, Python, or other programming language for further analysis. Continue with the documentation to find out more about LROSE and the many options and parameters available in the LROSE-elle software suite.
 <!-- ==== '''Jupyter Notebook Starter Kit''' ====
 All of the following steps are available in Jupyter Notebook tutorials in Julia and Python. You can [https://github.com/nsf-lrose/lrose-blaze/tree/master/docs/starter_kit clone] the notebook or [https://github.com/nsf-lrose/lrose-blaze/releases/download/lrose-blaze-alpha/lrose-blaze-starter-kit.tgz download] the whole starter kit with input and expected output files. -->

@@ Line 39: / Line 39: @@
   /Applications/HawkEye.app/Contents/MacOS/HawkEye -f $PWD/output/20161006/*
-[[File:Qs_hawkeye_ref|550px]][[File:Qs_hawkeye_vel|550px]]
+[[File:Qs_hawkeye_ref.png|550px]][[File:Qs_hawkeye_vel.png|550px]]
 ==== '''Grid the data into Cartesian space''' ====