VORTRAC - Revision history

Tingyucha at 22:44, 1 March 2021

2021-03-01T22:44:14Z

Tingyucha: /* Overview */

2021-02-01T20:42:12Z

Overview

Tingyucha: /* Overview */

2021-02-01T20:41:47Z

Overview

Tingyucha: /* Configuration */

2021-02-01T20:32:28Z

Configuration

Tingyucha at 20:31, 1 February 2021

2021-02-01T20:31:45Z

Tingyucha at 20:13, 1 February 2021

2021-02-01T20:13:12Z

Tingyucha: /* References */

2021-01-21T03:20:02Z

References

Jcdehart at 20:52, 3 August 2020

2020-08-03T20:52:16Z

Tingyucha: /* Running VORTRAC */

2019-07-25T16:44:13Z

Running VORTRAC

Tingyucha: /* Running VORTRAC */

2019-07-25T16:43:22Z

Running VORTRAC

@@ Line 1: / Line 1: @@
 === '''Prerequesites''' ===
@@ Line 7: / Line 12: @@
 * Create several folders in the same directory as the XML file. The details can be found '''[http://wiki.lrose.net/index.php/VORTRAC#Running_VORTRAC here]'''
 ''For the details on the GBVTD and GVTD algorithms, please refer to the [http://wiki.lrose.net/index.php/VORTRAC#References references].''

@@ Line 11: / Line 11: @@
 The Vortex Objective Radar Tracking and Circulation software is a collection of radar algorithms designed to provide real-time or post-analysis information about hurricane location and structure from a single Doppler radar using the GBVTD or GVTD algorithms. These algorithms are written in C++ and combined with a graphical user interface (GUI) that allows the user to control the software operation and display critical storm parameters for use in an operational environment. The primary display shows a timeline of estimated central surface pressure and the radius of maximum wind (RMW) that updates as new radar volumes are processed. Additional information about the radar data and program operation is also displayed to the user, including a constant altitude plan-position indicator (CAPPI), maximum velocity, storm signal, status light, operation log, and progress bar. This development was funded under a grant from the NOAA Joint Hurricane Testbed program from 2005 – 2007.
-''For the details on the GBVTD and GVTD algorithms, please refer to [http://wiki.lrose.net/index.php/VORTRAC#References the references].''
+''For the details on the GBVTD and GVTD algorithms, please refer to the [http://wiki.lrose.net/index.php/VORTRAC#References references].''
 === '''Copyright, License, and Patent''' ===

@@ Line 9: / Line 9: @@
 === '''Overview''' ===
-The Vortex Objective Radar Tracking and Circulation software is a collection of radar algorithms designed to provide real-time or post-analysis information about hurricane location and structure from a single Doppler radar. These algorithms are written in C++ and combined with a graphical user interface (GUI) that allows the user to control the software operation and display critical storm parameters for use in an operational environment. The primary display shows a timeline of estimated central surface pressure and the radius of maximum wind (RMW) that updates as new radar volumes are processed. Additional information about the radar data and program operation is also displayed to the user, including a constant altitude plan-position indicator (CAPPI), maximum velocity, storm signal, status light, operation log, and progress bar. This development was funded under a grant from the NOAA Joint Hurricane Testbed program from 2005 – 2007.
+The Vortex Objective Radar Tracking and Circulation software is a collection of radar algorithms designed to provide real-time or post-analysis information about hurricane location and structure from a single Doppler radar using the GBVTD or GVTD algorithms. These algorithms are written in C++ and combined with a graphical user interface (GUI) that allows the user to control the software operation and display critical storm parameters for use in an operational environment. The primary display shows a timeline of estimated central surface pressure and the radius of maximum wind (RMW) that updates as new radar volumes are processed. Additional information about the radar data and program operation is also displayed to the user, including a constant altitude plan-position indicator (CAPPI), maximum velocity, storm signal, status light, operation log, and progress bar. This development was funded under a grant from the NOAA Joint Hurricane Testbed program from 2005 – 2007.
 === '''Copyright, License, and Patent''' ===

@@ Line 82: / Line 82: @@
 From here, you can read in the netCDF file using Julia, Python, or other programming languages for further analysis.
-=== '''Configuration '''===
+= '''Configuration '''=
 Edit the configuration in the XML file. Each section in the XML file is explained by the following:

@@ Line 1: / Line 1: @@
 === '''Overview''' ===
@@ Line 74: / Line 82: @@
 From here, you can read in the netCDF file using Julia, Python, or other programming languages for further analysis.
-= Configuration =
+=== '''Configuration '''===
 Edit the configuration in the XML file. Each section in the XML file is explained by the following:

@@ Line 1: / Line 1: @@
-= Overview =
+=== '''Overview''' ===
 The Vortex Objective Radar Tracking and Circulation software is a collection of radar algorithms designed to provide real-time or post-analysis information about hurricane location and structure from a single Doppler radar. These algorithms are written in C++ and combined with a graphical user interface (GUI) that allows the user to control the software operation and display critical storm parameters for use in an operational environment. The primary display shows a timeline of estimated central surface pressure and the radius of maximum wind (RMW) that updates as new radar volumes are processed. Additional information about the radar data and program operation is also displayed to the user, including a constant altitude plan-position indicator (CAPPI), maximum velocity, storm signal, status light, operation log, and progress bar. This development was funded under a grant from the NOAA Joint Hurricane Testbed program from 2005 – 2007.
-== Copyright, License, and Patent ==
+=== '''Copyright, License, and Patent''' ===
 The VORTRAC code is governed under two copyrights and licenses, and contains a patented algorithm.
 The majority of the code is licensed under the Apache License Version 2.0, with the exception of the code in the NRL subdirectory. The code in the NRL subdirectory has contributions from Paul Harasti at the Naval Research Laboratory and is governed by a separate license. The Generalized Velocity Track Display (GVTD) algorithm was patented in 2010 as “Method for generating a representation of an atmospheric vortex kinematic structure” – '''[http://patft.uspto.gov/netacgi/nph-Parser?Sect1=PTO1&Sect2=HITOFF&d=PALL&p=1&u=%2Fnetahtml%2FPTO%2Fsrchnum.htm&r=1&f=G&l=50&s1=7,728,760.PN.&OS=PN/7,728,760&RS=PN/7,728,760 US Patent No. 7728760 B2]'''
-=== Main code copyright and license ===
+=== '''Main code copyright and license''' ===
 Copyright 2005 - 2018, Colorado State University and University Corporation for Atmospheric Research
@@ Line 15: / Line 15: @@
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-== References ==
+=== '''References''' ===
 * Cha, T.-Y., and Bell, M. M., 2020: Comparison of Single Doppler and Multiple Doppler Wind Retrievals in Hurricane Matthew (2016), Atmos. Meas. Tech. Discuss. [preprint], https://doi.org/10.5194/amt-2020-240, in review, 2020.
 * Harasti, P.R., 2014: An Expanded VVP Technique to Resolve Primary and Environmental Circulations in Hurricanes. J. Atmos. Oceanic Technol., 31, 249–271.
@@ Line 25: / Line 25: @@
 * Lee, W.-C., B. J.-D. Jou, P.-L. Chang, and S.-M. Deng, 1999: Tropical cyclone kinematic structure retrieved from single-Doppler radar observations. Part I: Interpretation of Doppler velocity patterns and the GBVTD technique. Mon. Wea. Rev., 127 (10), 2419–2439, doi: 10.1175/1520- 0493(1999)127<2419:TCKSRF>2.0.CO;2.
-= Running VORTRAC =
+=== '''Running VORTRAC''' ===
 # Create several folders in the same directory as the xml file:

@@ Line 54: / Line 54: @@
 <li>To initiate a new run, execute VORTRAC using the following command:</li></ol>
-: <code lang="bash">lrose -- vortrac</code>
+: <code lang="bash">/path/to/lrose/install/bin/vortrac</code>
 Click “File”, and open the configured xml file. Then, the user can initiate the analysis with the “Run” button on the bottom right.
@@ Line 71: / Line 71: @@
 <li>Convert the retrieved coefficients into a netCDF file with the coefficintlist and log files by using the following command:</li></ol>
-: <code lang="bash">lrose -- vo2nc -c {TC_name}_{Radar_name}_{Year_of_the_TC}_coefficientlist.csv -l VORTRAC_status_{The_time_of_analysis}.log -o output.nc</code>
+: <code lang="bash">/path/to/lrose/install/bin/vo2nc -c {TC_name}_{Radar_name}_{Year_of_the_TC}_coefficientlist.csv -l VORTRAC_status_{The_time_of_analysis}.log -o output.nc</code>
 From here, you can read in the netCDF file using Julia, Python, or other programming languages for further analysis.

@@ Line 47: / Line 47: @@
 *:The xml example file can be found here: '''[https://github.com/tingyucha/NEXRAD_level2_data_process/blob/master/myconfig.xml myconfig.xml]'''</li>
 <li>To initiate a new run, execute VORTRAC using the following command:</li></ol>
@@ Line 52: / Line 57: @@
 Click “File”, and open the configured xml file. Then, the user can initiate the analysis with the “Run” button on the bottom right.
 <ol start="5" style="list-style-type: decimal;">

← Older revision		Revision as of 16:43, 25 July 2019
Line 52:		Line 52:

	Click “File”, and open the configured xml file. Then, the user can initiate the analysis with the “Run” button on the bottom right.		Click “File”, and open the configured xml file. Then, the user can initiate the analysis with the “Run” button on the bottom right.
		+
		+	<blockquote style="color: grey; border: solid thin gray;">
		+	'''Important Note:''' Current vortrac_radarList.xml file only has the United States NEXRAD radar information. If the user would like to use other radar outside of the United States, you will have to manually insert the radar configuration in the vortrac_radarList.xml file under the <code lang="bash">Resources</code> directory.
		+	</blockquote>

	<ol start="5" style="list-style-type: decimal;">		<ol start="5" style="list-style-type: decimal;">