METplus Users Guide

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 89

DownloadMETplus Users Guide
Open PDF In BrowserView PDF
METplus Version 2.0

Automation for the Model Evaluation Tools

Developmental Testbed Center
Boulder, Colorado

Daniel Adriaansen 1 , Minna Win-Gildenmeister 1,4 , James Frimel 2,4 ,
Julie Prestopnik 1,4 , Mallory Row 3 , John Halley Gotway 1,4 ,
George McCabe 1,4 , Tara Jensen 1,4 , Jonathan Vigh 1,4 ,
Christina Kalb 1 , and Hank Fisher 1
1

National Center for Atmospheric Research ,
Research Applications Laboratory

2

Cooperative Institute for Research in the Atmosphere at

National Oceanic and Atmospheric Administration (NOAA)
Earth System Research Laboratory
3

I.M. Systems Group at

NOAA Environmental Modeling Center
4

Developmental Testbed Center

September 2018

Contents
1 Overview of METplus

10

1.1

Purpose and organization of the User's Guide . . . . . . . . . . . . . . . . . . . . . . . . . . .

10

1.2

The Developmental Testbed Center (DTC)

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

10

1.3

METplus goals and design philosophy

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

11

1.4

METplus components

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

11

1.5

Future development plans

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

11

1.6

Code support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

12

2 Software Installation/Getting Started

13

2.1

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

13

2.2

Supported architectures

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

13

2.3

Programming/scripting languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

13

2.4

Pre-requisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

13

2.5

METplus directory structure

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

14

2.6

Getting the METplus source code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15

2.6.1

. . . . . . . . . . . . . . . . . . . . . . . .

15

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15

2.6.2

Get the source code via your Web Browser
2.6.1.1

Source code only:

2.6.1.2

Source code, additional documentation, and sample data

Get the source code via Command line

. . . . . . . . . . .

18

. . . . . . . . . . . . . . . . . . . . . . . . . .

21

2.7

Set up your environment

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21

2.8

Set up METplus Conguration les . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

22

2.9

Running METplus

23

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1

2

CONTENTS

3 METplus System Conguration

24

3.1

Cong Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

24

3.2

Cong File Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

25

3.3

Cong Quick Start Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

25

3.4

A-Z Cong Glossary

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27

3.4.1

A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27

3.4.2

B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

28

3.4.3

C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

29

3.4.4

D. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

32

3.4.5

E . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33

3.4.6

F . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

34

3.4.7

G

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

43

3.4.8

H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

44

3.4.9

I

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

45

3.4.10 J . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

3.4.11 K . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

3.4.12 L . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

3.4.13 M

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

3.4.14 N . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

3.4.15 O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

3.4.16 P . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

59

3.4.17 Q . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

3.4.18 R . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

3.4.19 S . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

64

3.4.20 T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

3

CONTENTS

3.4.21 U . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

3.4.22 V . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

3.4.23 W

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

81

3.4.24 X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

3.4.25 Y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

3.4.26 Z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

83

Foreword: A note to METplus users
This User's Guide is provided as an aid to users of the Model Evaluation Tools (MET) and it's companion
package METplus. MET is a set of verication tools developed and supported to community via the Developmental Testbed Center (DTC) for use by the numerical weather prediction community. METplus is
intended to be a suite of Python wrappers and ancillary scripts to enhance the user's ability to quickly set-up
and run MET. Over the next few years, METplus will become the authoritative repository for verication
of the Unied Forecast System.

It is important to note here that METplus is an evolving software package. Previous releases of METplus have
occurred since 2017. This documentation describes the 2.0 release in September 2018. Intermediate releases
may include bug xes. METplus is also be able to accept new modules contributed by the community. If
you have code you would like to contribute, we will gladly consider your contribution. While we are setting
up our community contribution protocol, please send email to: met_help@ucar.edu and inform us of your
desired contribution. We will then determine the maturity of new verication method and coordinate the
inclusion of the new module in a future version.

This User's Guide was prepared by the developers of the METplus, including Dan Adriaansen, Minna WinGildenmeister, Julie Prestopnik, Jim Frimel, Mallory Row, John Halley Gotway, George McCabe, Paul
Prestopnik, Christana Kalb, Hank Fisher, Jonathan Vigh, Lisa Goodrich, Tara Jensen, Tatiana Burek,and
Bonny Strong.

New for METplus v2.0
METplus v2.0 includes some new wrappers:

ˆ

pb2nc_wrapper


ˆ

Python wrapper to the MET tool pb2nc

point_stat_wrapper



Python wrapper to the MET tool point_stat

Enhancements, refactorization, and bug xes have been addressed in the following wrappers:
4

CONTENTS

ˆ

tc_stat_wrapper


ˆ

5

can now be run stand-alone

tc_pairs_wrapper



can now read ATCF input le formats



support for numerous input le naming conventions



support for input data organized into one directory or subdirectories with date information in the
name

ˆ

cyclone_plotter_wrapper



replaced the dependency on Basemap toolkits (which are unstable on some platforms) with Cartopy for map rendering

ˆ

tcmpr_plotter_wrapper



now supports whitespace in plot title, sub-title, and legend

TERMS OF USE
IMPORTANT!
USE OF THIS SOFTWARE IS SUBJECT TO THE FOLLOWING TERMS AND CONDITIONS:

1.

License.

Subject to these terms and conditions, University Corporation for Atmospheric Research

(UCAR) grants you a non-exclusive, royalty-free license to use, create derivative works, publish, distribute,
disseminate, transfer, modify, revise and copy the Model Evaluation Tools (MET) software, in both object
and source code (the Software).

You shall not sell, license or transfer for a fee the Software, or any work that in any manner contains the
Software.

2. Disclaimer of Warranty on Software.

Use of the Software is at your sole risk. The Software is pro-

vided "AS IS" and without warranty of any kind and UCAR EXPRESSLY DISCLAIMS ALL WARRANTIES AND/OR CONDITIONS OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING, BUT
NOT LIMITED TO, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT
OF A THIRD PARTY'S INTELLECTUAL PROPERTY, MERCHANTABILITY OR SATISFACTORY QUALITY AND FITNESS FOR A PARTICULAR PURPOSE. THE PARTIES EXPRESSLY
DISCLAIM THAT THE UNIFORM COMPUTER INFORMATION TRANSACTIONS ACT (UCITA)
APPLIES TO OR GOVERNS THIS AGREEMENT. No oral or written information or advice given
by UCAR or a UCAR authorized representative shall create a warranty or in any way increase the
scope of this warranty. Should the Software prove defective, you (and neither UCAR nor any UCAR
representative) assume the cost of all necessary correction.

3. Limitation of Liability.

UNDER NO CIRCUMSTANCES, INCLUDING NEGLIGENCE, SHALL

UCAR BE LIABLE FOR ANY DIRECT, INCIDENTAL, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES INCLUDING LOST REVENUE, PROFIT OR DATA, WHETHER IN AN ACTION
IN CONTRACT OR TORT ARISING OUT OF OR RELATING TO THE USE OF OR INABILITY
TO USE THE SOFTWARE, EVEN IF UCAR HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

6

7

CONTENTS

4. Compliance with Law.

All Software and any technical data delivered under this Agreement are subject

to U.S. export control laws and may be subject to export or import regulations in other countries. You
agree to comply strictly with all applicable laws and regulations in connection with use and distribution
of the Software, including export control laws, and you acknowledge that you have responsibility to
obtain any required license to export, re-export, or import as may be required.

5. No Endorsement/No Support.

The names UCAR/NCAR, National Center for Atmospheric Research

and the University Corporation for Atmospheric Research may not be used in any advertising or
publicity to endorse or promote any products or commercial entity unless specic written permission is
obtained from UCAR. The Software is provided without any support or maintenance, and without any
obligation to provide you with modications, improvements, enhancements, or updates of the Software.

6. Controlling Law and Severability.

This Agreement shall be governed by the laws of the United States

and the State of Colorado. If for any reason a court of competent jurisdiction nds any provision, or
portion thereof, to be unenforceable, the remainder of this Agreement shall continue in full force and
eect. This Agreement shall not be governed by the United Nations Convention on Contracts for the
International Sale of Goods, the application of which is hereby expressly excluded.

7. Termination.

Your rights under this Agreement will terminate automatically without notice from UCAR

if you fail to comply with any term(s) of this Agreement. You may terminate this Agreement at any
time by destroying the Software and any related documentation and any complete or partial copies
thereof.

Upon termination, all rights granted under this Agreement shall terminate.

The following

provisions shall survive termination: Sections 2, 3, 6 and 9.

8. Complete Agreement.

This Agreement constitutes the entire agreement between the parties with

respect to the use of the Software and supersedes all prior or contemporaneous understandings regarding
such subject matter. No amendment to or modication of this Agreement will be binding unless in
writing and signed by UCAR.

9.

Notices and Additional Terms.

Copyright in Software is held by UCAR. You must include, with each

copy of the Software and associated documentation, a copy of this Agreement and the following notice:

The source of this material is the Research Applications Laboratory at the National Center for Atmospheric Research, a program of the University Corporation for Atmospheric Research (UCAR) pursuant to
a Cooperative Agreement with the National Science Foundation;

©2007-2017

University Corporation for

Atmospheric Research. All Rights Reserved."

The following notice shall be displayed on any scholarly works associated with, related
to or derived from the Software:
"Model Evaluation Tools (MET) and METplus were developed at the National Center for
Atmospheric Research (NCAR) through grants from the National Science Foundation (NSF), the
National Oceanic and Atmospheric Administration (NOAA), and the United States Air Force
(USAF). NCAR is sponsored by the United States National Science Foundation."

CONTENTS

8

By using or downloading the Software, you agree to be bound by the terms and conditions of
this Agreement.
The citation for this User's Guide should be:

Adriaansen, D., M. Win-Gildenmeister, J. Frimel, J. Prestopnik, J. Halley Gotway,
T. Jensen, J. Vigh, C. Kalb, G. McCabe, and H. Fisher, 2018:
The METplus Version 2.0 User's Guide. Developmental Testbed Center.
Available at: https://github.com/NCAR/METplus/releases. 85 pp.

Acknowledgments
We thank the the National Science Foundation (NSF) along with three organizations within the National
Oceanic and Atmospheric Administration (NOAA): 1) Oce of Atmospheric Research (OAR); 2) Next
Generation Global Predition System project (NGGPS); and 3) United State Weather Research Program
(USWRP) for their support of this work. Thanks also go to the sta at the Developmental Testbed Center
for their help, advice, and many types of support.

We released METplus Alpha in February 2017 and

would not have made a decade of cutting-edge verication support without those who participated in DTC
planning workshops and the NGGPS United Forecast System Strategic Implementation Plan Working Groups
(NGGPS UFS SIP WGs).

The DTC is sponsored by the National Oceanic and Atmospheric Administration (NOAA), the United
States Air Force, and the National Science Foundation (NSF). NCAR is sponsored by the National Science
Foundation (NSF).

9

Chapter 1

Overview of METplus
1.1 Purpose and organization of the User's Guide
The goal of this User's Guide is to equip users with the information needed to use the Model Evaluation Tools
(MET) and it's companion package METplus. MET is a set of verication tools developed and supported
to community via the Developmental Testbed Center (DTC) for use by the numerical weather prediction
community. METplus is a suite of Python wrappers and ancillary scripts to enhance the user's ability to
quickly set-up and run MET. Over the next few years, METplus will become the authoritative repository
for verication of the Unied Forecast System.
The METplus User's Guide is organized as follows. Chapter 1 provides an overview of METplus. Chapter 2
contains basic information about how to get started with METplus - including system requirements, required
software , and how to download METplus. Chapter 3

1.2 The Developmental Testbed Center (DTC)
METplus has been developed, and will be maintained and enhanced, by the Developmental Testbed Center
(DTC;

http://www.dtcenter.org/

). The main goal of the DTC is to serve as a bridge between opera-

tions and research, to facilitate the activities of these two important components of the numerical weather
prediction (NWP) community.

The DTC provides an environment that is functionally equivalent to the

operational environment in which the research community can test model enhancements; the operational
community benets from DTC testing and evaluation of models before new models are implemented operationally. METplus serves both the research and operational communities in this way - oering capabilities
for researchers to test their own enhancements to models and providing a capability for the DTC to evaluate
the strengths and weaknesses of advances in NWP prior to operational implementation.
METplus will also be available to DTC visitors and to the WRF modeling community for testing and
evaluation of new model capabilities, applications in new environments, and so on. The METplus release
10

CHAPTER 1.

11

OVERVIEW OF METPLUS

schedule is coincident with the MET release schedule and the METplus major release number is six less than
the MET major release number (e.g. MET 8.0 is released with METplus 2.0).

1.3 METplus goals and design philosophy
METplus is a Python scripting infrastructure for the MET tools. The primary goal of METplus development
is to provide MET users with a highly congurable and simple means to perform model verication using the
MET tools. Prior to the availability of METplus, users who had more complex verications that required
the use of more than one MET tool were faced with setting up multiple MET cong les and creating
some automation scripts to perform the verication. METplus provides the user with the infrastructure to
modularly create the necessary steps to perform such verications.

METplus has been designed to be modular and adaptable.

This is accomplished through wrapping the

MET tools with Python and the use of hierarchical conguration les to enable users to readily customize
their verication environments. Wrappers can be run individually, or as a group of wrappers that represent
a sequence of MET processes.

New wrappers can readily be added to the METplus package due to this

modular design. Currently, METplus can easily be applied by any user on their own computer platform that
supports Python 2.7.

The METplus code and documentation is maintained by the DTC in Boulder, Colorado. METplus is freely
available to the modeling, verication, and operational communities, including universities, governments,
the private sector, and operational modeling and prediction centers through a publicly accessible GitHub
repository. Users simply need access to a web browser to download the source code and any other relevant
documentation and data samples.

1.4 METplus components
The major components of METplus package are METplus Python wrappers to the MET tools, MET conguration les and a hierarchy of METplus conguration les. Some Python wrappers do not correspond to
a particular MET tool, but wrap utilities to extend METplus functionality.

1.5 Future development plans
METplus is an evolving application. New capabilities are planned in controlled, successive version releases
that are synchronized with MET releases. Bug xes and user-identied problems will be addressed as they
are found and posted to the known issues section of the METplus Users web page (www.dtcenter.org/met/

users/support).

Future METplus development plans are based on several contributing factors, including

the needs of both the operational and research community. Issues that are in the development queue detailed
in the Issues section of the GitHub repository. Please send questions to

met_help@ucar.edu.

CHAPTER 1.

12

OVERVIEW OF METPLUS

1.6 Code support
METplus support is provided through a MET-help e-mail address: met_help@ucar.edu. We will endeavor to
respond to requests for help in a timely fashion. In addition, information about METplus and tools that can
be used with MET are provided on the MET Users web page (http://www.dtcenter.org/met/users/).

We welcome comments and suggestions for improvements to METplus, especially information regarding
errors.

Comments may be submitted using the MET Feedback form available on the MET website.

In

addition, comments on this document would be greatly appreciated. While we cannot promise to incorporate
all suggested changes, we will certainly take all suggestions into consideration.

METplus is a "living" set of wrappers and conguration les. Our goal is to continually enhance it and add
to its capabilities. Because our time, resources, and talents are limited, we welcome contributed code for
future versions of METplus. These contributions may represent new use cases or new plotting functions. For
more information on contributing code to METplus, please contact

met_help@ucar.edu.

Chapter 2

Software Installation/Getting Started
2.1 Introduction
This chapter describes how to download and set up METplus. METplus has been developed and tested on
the Debian Linux operating system.

2.2 Supported architectures
METplus was developed on Debian Linux and is supported on this platform.

2.3 Programming/scripting languages
METplus is written in Python 2.7. METplus is intended to be a tool for the modeling community to use and
adapt. As users make upgrades and improvements to the tools, they are encouraged to oer those upgrades
to the broader community by oering feedback to the developers or coordinating for a GitHub pull.
more information on contributing code to METplus, please contact

2.4 Pre-requisites
The following software is required to run METplus:

ˆ

Python 2.7

13

met_help@ucar.edu.

For

CHAPTER 2.

14

SOFTWARE INSTALLATION/GETTING STARTED

1

ˆ

R version 3.2.5

ˆ

nco (netCDF operators)

ˆ

MET version 6.1 or above

ˆ

Basic familiarity with MET

ˆ

GitHub account (if you plan on contributing code to METplus)

2.5 METplus directory structure
Once you have cloned the METplus from the GitHub repository at https://github.com/NCAR/METplus
to a location on your host, change directories to the METplus directory.

You should have the following

directory structure:

METplus
doc
internal_tests
parm
sorc
ush
README.md

The top-level METplus directory consists of a README.md le and several subdirectories.

The doc/ directory contains documentation for users (PDF) and Doxygen les that are used to create the
developer documentaton. The Doxygen documentation can be created and viewed via web browser if the
developer has Doxygen installed on the host.

The internal_tests/ directory contains unit test scripts that are only relevant to METplus developers and
contributors.

The parm/ directory contains all the conguration les for MET and METplus.

The sorc/ directory contains Doxygen executables to generate documentation for developers.

The src/ directory contains the source code for each of the wrappers in METplus.

The ush/ directory contains the Python wrappers to the MET tools.

1R

version 3.2.5 is required when the tcmpr_plotter_wrapper.py wraps the plot_tcmpr.R script. Please refer to Chapter

21 Plotting and Graphics Support for more information about plot_tcmpr.R.

CHAPTER 2.

SOFTWARE INSTALLATION/GETTING STARTED

15

2.6 Getting the METplus source code
The METplus source code is available for download from a public GitHub repository. You can retrieve the
source code through your web browser or the command line.

2.6.1

Get the source code via your Web Browser

2.6.1.1 Source code only:
If you wish to retrieve only the source code, then the following steps will illustrate how to quickly access the
METplus source code and relevant documentation:

ˆ

On your local host (or wherever you wish to install the METplus code) create a directory where you
want the code to reside

ˆ

Open the browser of your choice and navigate to https://github.com/NCAR/METplus. You will see
something like the following:

CHAPTER 2.

SOFTWARE INSTALLATION/GETTING STARTED

16

CHAPTER 2.

ˆ

SOFTWARE INSTALLATION/GETTING STARTED

17

You should be directed to the 'master' branch, verify this by looking at the button labelled 'Branch'
in the upper left corner of your window, directly beneath the solid blue horizontal line.

ˆ

Click on the green Clone or download button near the top right of the page.

ˆ

A box appears with Clone with HTTPS label

ˆ

Click on the blue text: Download Zip :

ˆ

Your browser should prompt you on what to do with this le. Save it to the directory you created
above

ˆ

cd to the directory where you saved the code. You should see the le METplus-master.zip

ˆ

Uncompress the le:



Linux/Unix:



unzip METplus-master.zip



You should now have a METplus-master directory

*

If you downloaded the code via the command line, you will get a METplus directory rather
than METplus-master.

*

GitHub appends the '-master' to the name to emphasize that is is from the master branch

*

To avoid clutter and confusion, you can now remove the METplus-master.zip (optional)

CHAPTER 2.

SOFTWARE INSTALLATION/GETTING STARTED

18

2.6.1.2 Source code, additional documentation, and sample data
If you are a new METplus user and would like to experiment with the use cases, you will want to follow
these instructions to retrieve the source code, additional documentation and sample data that accompanies
the use cases:

ˆ

On your local host (or wherever you wish to install the METplus code) create a directory where you
want the code to reside

ˆ

Open the browser of your choice and navigate to https://github.com/NCAR/METplus. You will see
something like the following:

CHAPTER 2.

SOFTWARE INSTALLATION/GETTING STARTED

19

CHAPTER 2.

SOFTWARE INSTALLATION/GETTING STARTED

20

ˆ

Click on the 'releases' link, highlighted by a red circle in the diagram below:

ˆ

You will be redirected to another screen. The latest available release appears at the top of the screen:

ˆ

Click on the 'Source code' link (either the
you created.

zip

or

tar.gz )

and when prompted, save it to the directory

CHAPTER 2.

21

SOFTWARE INSTALLATION/GETTING STARTED

: gunzip

ˆ

Uncompress the source code (on Linux/Unix

ˆ

Create a directory for the sample data directory

ˆ

Click on the

sample_data.tar.gz

for zip le or

tar xvfz

for the tar.gz le)

link and when prompted, save the le to the directory you created

above

2.6.2

ˆ

Get the source code via Command line

On your local host (or wherever you wish to install the METplus code) create a directory where you
want the code to reside

ˆ

cd to the directory you just created.

ˆ

On the command line, enter the following:

 git clone https://github.com/NCAR/METplus

ˆ

The source code should appear under the METplus directory

path /to /METplus

To update your copy, cd to your METplus install directory: /

and enter

git pull

at

the command line

2.7 Set up your environment
Environment variables need to be set to allow the METplus application to be run from any directory and
for locating the necessary Python modules. There is an option to set the JLOGFILE environment variable,
which indicates where JLOGS will be saved. JLOGS provide information pertinent to the conguration-le
framework. If this environment is unset, then output from the conguration framework will be directed to
stdout (your display).

Add the following information to your .cshrc (C shell) or .bashrc (Bash shell):

.cshrc:
ˆ

Open your .cshrc le and do the following:

ˆ

To your PATH, add:

ˆ

To your PYTHONPATH, add:

ˆ

Optional: add JLOGFILE variable and set to

ˆ

Close your .cshrc le and run

full-path-to -METplus /ush
full-path-to -METplus /ush:full-path-to-METplus /parm
full-path-to-save-jlog-les

source ~/.cshrc

CHAPTER 2.

SOFTWARE INSTALLATION/GETTING STARTED

22

ˆ e.g.
set path = (other_path_entries ~/METplus/ush
setenv PYTHONPATH ~/METplus/ush:~/METplus/parm:$PYTHONPATH
# optional
setenv JLOGFILE ~/jlog_out

.bashrc:
ˆ

Open your .bashrc le and do the following:

ˆ

To your PATH, add :

ˆ

To your PYTHONPATH, add

ˆ

Optional: add a JLOGFILE environment variable and set it to the directory where you want the logs

full-path-to-METplus /ush
full-path-to-METplus /parm

to reside

ˆ

Close your .bashrc le and run

source ~/.bashrc

ˆ e.g.
export PATH=~/METplus/ush:$PATH
export PYTHONPATH=~/METplus/ush:~/METplus/parm:/$PYTHONPATH
#optional
export JLOGFILE=~/

2.8 Set up METplus Conguration les
There are four METplus conguration les that must be dened prior to running METplus. These conguration les reside in the METplus_INSTALL_DIRECTORY/METplus/parm/metplus_cong

The following conguration les are automatically loaded during a METplus run and do not need to be
invoked on the command line.

ˆ

metplus_data.conf



ˆ

data-relevant settings:

*

lename templates

*

regular expressions for input or output lenames

*

directories where input data are located

metplus_logging.conf



set logging levels for METplus and MET output



turn on/o logging to stdout (screen) or log les

CHAPTER 2.

ˆ

23

SOFTWARE INSTALLATION/GETTING STARTED

metplus_runtime.conf



runtime-related settings:

*

location of METplus master_metplus.conf le (the 'master' conf le that is a collection of all
the nal METplus conguration les)

ˆ

metplus_system.conf



system-related settings:

*

location of METplus source code

*

location of MET source and build

*

location of other non-MET executables/binaries

*

location of METplus parm directory

They must be fully dened by replacing all variables with

/path/to's

with valid path names, or have those

variables dened in a down-stream cong le. If conguring METplus in a common location for multiple
users, it is recommended that the these four conguration les are fully dened. Individual users have the
option to make customizations by over-riding any of these values in their own conguration les.

2.9 Running METplus
Running METplus involves invoking the Python script master_metplus.py from any directory followed by a
list of conguration les (le path relative to the

path_to_METplus_install_dir /METplus/parm directory).

Example: Using a default conguration
>master_metplus.py
Does nothing, a usage message appears, indicating that other cong les are required to perform useful
tasks.
Example: Using a use-case conguration
>master_metplus.py -c use_cases/feature_relative/feature_relative.conf \
Runs
Any

METplus
variables

using

the

dened

defaults
in

set

these

in

the

three

three

cong

cong

les

les

found

can

be

in

parm/metplus_cong.
over-ridden

in

the

parm/use_cases/feature_relative/feature_relative.conf le. METplus will run using the values specied
in the feature_relative.conf le.

Example: Using example conguration to perform specic evaluation (e.g. Model 1 vs. Obs1, Model 1 vs
Obs 2, Model 2 vs. Obs 1, etc.)
>master_metplus.py -c use_cases/feature_relative/feature_relative.conf \
-c use_cases/feature_relative/example/series_by_lead_all_fhrs.conf
This runs METplus using the defaults set in the three cong les found in parm/metplus_cong,
where

variables

can

be

over-ridden

by

parm/use_cases/feature_relative/feature_relative.conf

parm/use_cases/feature_relative/example/series_by_lead_all_fhrs.conf.

or

in

The order in which conf les

are called is important. Variables that are dened in intermediate conf les will be over-ridden by the same
variables set in the conf le following it, or the last conf le.

Chapter 3

METplus System Conguration
This chapter is a guide on conguring METplus.

3.1 Cong Best Practices
Below is a list of Best Practices:

1. Set your log level to an appropriate level.
(a) Debug is the most verbose and is useful for developers and when you are troubleshooting problems
(b) Info is the less verbose than Debug and is the recommended level to initially set your log level
(c) Warning - only logs warnings, error or critical events
(d) Error - only logs errors or critical events
(e) Critical is the least verbose
2. Direct your logging either to stdout or to a log le.
3. Review your log le to verify that all your processes ran cleanly.
4. The order in which you list your METplus cong les matter. The last cong le on the command line
will over-ride any key-values dened in an earlier cong le.
5. Check the master_metplus.conf le, as it contains all the key-values based on what you have specied.
This will help you determine whether you forgot to replace any
that you have dened things as you expected.

24

/path/to

with valid paths or to verify

CHAPTER 3.

25

METPLUS SYSTEM CONFIGURATION

3.2 Cong File Structure
METplus employs a hierarchy of conguration les employed in METplus. At the lowest level are the
set-and-forget type conguration les that reside in the

METplus_installation_dir /parm/metplus_congl At the next level are the conguration les that pertain
to a user's specic needs in the METplus_installation_dir /parm/use_cases/specic_use_case
ˆ

Four conguration les are required for METplus to be fully congured (i.e. all keywords are dened
by either whitespace or a valid value):



metplus_system



metplus_data



metplus_logging



metplus_runtime

By default, key-values that require the user's input are set to

/path/to.

Make sure to replace these

with the appropriate directory for your project.

ˆ

Additional conguration les are optional and the key-values dened there will over-ride any values
dened in the four mandatory METplus conguration les. These additional conguration les enables
users to use a common set of conguration les and to create customized environments for their
verication tasks.

3.3 Cong Quick Start Example
Track and Intensity Use case with sample data
ˆ

Create a directory where you wish to store the sample data

ˆ

Retrieve the sample data from the GitHub repository:



In your browser, navigate to https://github.com/NCAR/METplus/releases



locate the latest release and click on the sample_data.tar.gz link associated with that release



save it to the directory you created above, hereafter referred to as INPUT_DATA_DIRECTORY



cd to your $INPUT_DATA_DIRECTORY and uncompress the tarball:



when you perform a listing of the sample_data directory, the INPUT_DATA_DIRECTORY/sample_data/GFS

tar xvfz sample_data.tar.gz

contains the data you will need for this use case

ˆ

Set up the conguration le:



Your METplus install directory will hereafter be referred to as METplus_INSTALL

CHAPTER 3.



26

METPLUS SYSTEM CONFIGURATION

Verify that all the

path/to values are replaced with valid paths in the METplus_INSTALL/parm/metplus_conf/met

and METplus_INSTALL/parm/metplus_conf/metplus_system.conf les



Two conguration les are used in this use case, track_and_intensity.conf le and tcmp_mean_median.conf
to take cyclone track data, and using tc_pairs_wrapper.py which wraps the MET TC-Pairs tool
(to match ADeck and BDeck cyclone tracks to generate matched pairs and error statistics). The
tcmpr_plotter_wrapper.py is then used (wraps the MET tool plot_tcmpr.R) to generate a mean
and median plots for these matched pairs.



In your editor, open the METplus_INSTALL/METplus/parm/use_cases/track_and_intensity.conf
le:

/path/to

*

You will replace any

*

METPLUS_BASE to the path to where you installed METplus with '

*

PARM_BASE to the path to where you installed METplus, appended with with '

with actual paths by setting the following:

ush ':

METplus_INSTALL/all_users/ME

parm ':

parm

METplus_INSTALL/all_users/METplus/

*

OUTPUT_BASE to where you wish to save the output:

·

ADECK_TRACK_DATA_DIR to INPUT_DATA_DIRECTORY/sample_data/GFS/track_data

*

save your changes and exit your editor

*

In your editor, open the METplus_INSTALL/METplus/parm/use_cases/track_and_intensity/examples/tcm

*

Verify that PROCESS_LIST is set to TcPairs, TCMPRPlotter. This instructs METplus to
run the TcPairs wrapper rst (TC-Pairs) followed by the TCMPR plotter wrapper (plot_TCMPR.R).

ˆ

Run the use case:



Make sure you have set the following environment in your .cshrc (C shell) or .bashrc (Bash):

*

csh: setenv RSCRIPTS_BASE $MET_BASE/scripts/Rscripts

*

bash: export RSCIPTS_BASE $MET_BASE/scripts/Rscripts

*

Refer to Section 2.7 for the full instructions on setting up the rest of your environment

*

on your command line, run:

·
*

master_metplus.py -c use_cases/track_and_intensity/track_and_intensity.conf -c use_cases/track_and

When complete, you will have a log le in the output directory you specied, and under
the tc_pairs directory you will see .tcst les under the 201412 subdirectory. These are the
matched pairs created by the MET tool Tc-pairs and can be viewed in any text editor.

*

Plots are generated under the tcmpr_plots subdirectory, in .png format. You should have the
following plots which can be viewed by any graphics viewers such as 'display' on Linux/Unix
hosts:

·

AMAX_WIND-BMAX_WIND_mean.png

·

AMAX_WIND-BMAX_WIND_median.png

·

AMSLP-BMSLP_mean.png

·

AMSLP-BMSLP_median.png

·

TK_ERR_mean.png

·

TK_ERR_median.png

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

27

3.4 A-Z Cong Glossary
This glossary was created from the two commands:
$ cat METplus/parm/metplus_cong/*.conf METplus/parm/use_cases/*/*.conf METplus/parm/use_cases/*/*/*.conf
> allopts.conf
$ grep = allopts.conf | grep -v \# | sort | uniq > uniqueopts.conf

General form of glossary entry:

CONFIG_NAME_HERE
...Some description here...

Used by: Which METplus utility is this used by?
Family: Which family? [dir], [cong], [lename_templates], [exe], [regex_pattern], etc...
Default: If it makes sense to include a default value (or value shipped in a release), do it here

3.4.1

A

ADECK_FILE_PREFIX
Prex of the les in ATCF format containing tropical cyclone forecast data (adeck matched pairs).

Used by: tc_pairs_wrapper.py
Family: [cong]
Default: Varies

ADECK_TRACK_DATA_DIR
Directory that contains the ATCF formatted les containing tropical cyclone forecast data (adeck matched
pairs).

Used by: tc_pairs_wrapper.py
Family: [dir]
Default: Varies

AMODEL
The model name of the ADeck model data

Used by: cyclone_plotter_wrapper.py, tc_stat_wrapper.py
Family: [cong]
Default:

ANLY_ASCII_REGEX_LEAD
The regular expression describing the analysis (obs) le name (in ASCII format) of the intermediate le
generated when running a series by lead case.

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

28

Used by: series_by_lead_wrapper.py
Family: [regex_pattern]
Default:

ANLY_NC_TILE_REGEX
The regular expression used to search the input les that are in netCDF format and used in the series by
analysis task.

Used by: series_by_lead_wrapper.py, series_by_init_wrapper.py
Family: [regex_pattern]
Default:

ANLY_TILE_PREFIX
The prex to the lename for the analysis le that is created as part of a series analysis.

Used by: feature_util.py
Family: [regex_pattern]
Default:

ANLY_TILE_REGEX
The regular expression for the analysis input le the le is in GRIB2.

Used by: series_by_lead_wrapper.py, series_by_init_wrapper.py
Family: [regex_pattern]
Default:

3.4.2

B

BACKGROUND_MAP
Control whether or not a background map shows up for series analysis plots. Set to 'yes' if background map
desired.

Used by: series_by_lead_wrapper.py, series_by_init_wrapper.py
Family: [cong]
Default: no

BASIN
Control what basins are desired for tropical cyclone analysis.

Per the MET users' guide, acceptable basin ID's are:
WP = Western Northern Pacic
IO = Northern Indian Ocean

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

SH = Southern Hemisphere
CP = Central Northern Pacic
EP = Eastern Northern Pacic
AL = Northern Atlantic
SL = Southern Atlantic

Used by: cyclone_plotter_wrapper.py, tc_pairs_wrapper.py, tc_stat_wrapper.py
Family: [cong]
Default: Varies

BDECK_FILE_PREFIX
Relevant for non-ATCF tropical cyclone data. The lename prex for the BDeck data.

Used by: tc_pairs_wrapper.py
Family: [cong]
Default: Varies

BDECK_TRACK_DATA_DIR
The input directory where the BDeck track data resides.

Used by: tc_pairs_wrapper.py
Family: [dir]
Default: Varies

BEG_TIME
Beginning time for analysis in YYYYMMDD format.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py
Family: [cong]
Default: Varies

BMODEL
The model name of the BDeck model data.

Used by: tc_stat_wrapper.py
Family: [cong]
Default:

3.4.3

C

CIRCLE_MARKER_SIZE
Control the size of the circle marker in the cyclone plotter.

29

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

30

Used by: cyclone_plotter_wrapper.py
Family: [cong]
Default: 41

CONFIG_DIR
Directory containing cong les relevant to MET tools.

Used by: compare_gridded_wrapper.py, ensemble_stat_wrapper.py, grid_stat_wrapper.py, mode_wrapper.py
Family: [dir]
Default: Varies

CONFIG_FILE
Specic conguration le name to use for MET tools.

Used by: grid_stat_wrapper.py, mode_wrapper.py, tcmpr_plotter_wrapper.py, tc_stat_wrapper.py
Family: [cong]
Default: Varies

CONVERT_EXE
Path to the ImageMagick convert executable.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py, series_by_init_wrapper.py, series_by_lead_wrapper.py
Family: [exe]
Default: /path/to

CROSS_MARKER_SIZE
Control the size of the cross marker in the cyclone plotter.

Used by: cyclone_plotter_wrapper.py
Family: [cong]
Default: 51

CUT_EXE
Path to the Linux cut executable.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py
Family: [exe]
Default: /path/to

CYCLONE
Specify which cyclone numbers to include in the tropical cyclone analysis. Per the MET users' guide, this
can be any number 01-99 (HH format). Use a space or comma separated list, or leave unset if all cyclones
are desired.

Used by: tc_pairs_wrapper.py, tc_stat_wrapper.py
Family: [cong]

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

31

Default: Varies

CYCLONE_INIT_DATE
Initialization date for the cyclone forecasts in YYYYMMDD format.

Used by: cyclone_plotter_wrapper.py
Family: [cong]
Default: Varies

CYCLONE_INIT_HR
Initialization hour for the cyclone forecasts in HH format.

Used by: cyclone_plotter_wrapper.py
Family: [cong]
Default: Varies

CYCLONE_INPUT_DIR
Input directory for the cyclone plotter. This should be the output directory for the MET TC Pairs utility.

Used by: cyclone_plotter_wrapper.py
Family: [dir]
Default: Varies

CYCLONE_MODEL
Dene the model being used for the tropical cyclone forecasts.

Used by: cyclone_plotter_wrapper.py
Family: [cong]
Default: Varies

CYCLONE_OUT_DIR
Specify the directory where the output from the cyclone plotter should go.

Used by: cyclone_plotter_wrapper.py
Family: [dir]
Default: Varies

CYCLONE_PLOT_TITLE
Title string for the cyclone plotter.

Used by: cyclone_plotter_wrapper.py
Family: [cong]
Default: Varies

CHAPTER 3.

3.4.4

METPLUS SYSTEM CONFIGURATION

32

D

DEMO_YR
The demo year.

This is an optional value used by the plot_TCMPR.R script, (which is wrapped by

tcmpr_plotter_wrapper.py). Please refer to Chapter 21 in the MET User's Guide for more details.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

DEP_VARS
Corresponds to the optional ag -dep in the plot_TCMPR.R, which is wrapped by tcmpr_plotter_wrapper.py.
The value to this ag is a comma-separated list of dependent variable columns to plot. Please refer to Chapter
21 in the MET User's Guide for more details.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

DLAND_FILE
The le generated by the MET tool tc_dland, containing the gridded representation of the minimum distance
to land. Please refer to Chapter 18 of the MET User's Guide for more information about the tc_dland tool.

Used by: tc_pairs_wrapper.py
Family: [cong]
Default: Varies

DLAT
The latitude value, in degrees.

Used by: met_util.py
Family: [cong]
Default: 0.5

DLON
The longitude value, in degrees.

Used by: met_util.py
Family: [cong]
Default: 0.5

CHAPTER 3.

3.4.5

METPLUS SYSTEM CONFIGURATION

E

EGREP_EXE
Path to the Linux egrep executable.

Used by: feature_util.py, pb2nc_wrapper.py, point_stat_wrapper.py
Family: [exe]
Default: /path/to

END_DATE
Ending time/date string for analysis with format YYYYMMDDHH.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py
Family: [cong]
Default: Varies

END_HOUR
Ending hour for analysis with format HH.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py
Family: [cong]
Default: Varies

END_TIME
Ending date string for analysis with format YYYYMMDD.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py
Family: [cong]
Default: Varies

EXTRACT_OUT_DIR
Set the output directory for the METplus extract_tiles utility.

Used by: extract_tiles_wrapper.py, series_by_init_wrapper.py, series_by_lead_wrapper.py
Family: [dir]
Default: Varies

EXTRACT_TILES_FILTER_OPTS
Control what options are passed to the METplus extract_tiles utility.

Used by: extract_tiles_wrapper.py
Family: [cong]
Default: Varies

33

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

34

EXTRACT_TILES_VAR_LIST
Control what variables the METplus extract_tiles utility runs on.

Used by: feature_util.py
Family: [cong]
Default: Varies

3.4.6

F

FCST_1_FIELD_NAME
This variable is used to dene a 1 hour accumulation eld in the forecast dataset used in the MET tool
pcp_combine.

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

FCST_6_FIELD_NAME
This variable is used to dene a 6 hour accumulation eld in the forecast dataset used in the MET tool
pcp_combine.

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

FCST_ASCII_REGEX_LEAD
Regular expression used to nd the forecast le (ASCII format) generated as an intermediate step in the
series by lead use case.

Used by: series_by_lead_wrapper.py
Family: [regex_pattern]
Default: Varies

FCST_GEMPAK_INPUT_DIR
Input directory for GEMPAK formatted forecast les.

Used by: pcp_combine_wrapper.py
Family: [dir]
Default: Varies

FCST_GEMPAK_TEMPLATE
Template used to specify input lenames for GEMPAK formatted forecast les.

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

35

Used by: pcp_combine_wrapper.py
Family: [lename_templates]
Default: Varies

FCST_GRID_STAT_INPUT_DIR
Input directory for forecast les to use with the MET tool grid_stat.

Used by: ensemble_stat_wrapper.py, grid_stat_wrapper.py
Family: [dir]
Default: Varies

FCST_GRID_STAT_INPUT_TEMPLATE
Template used to specify input lenames for the MET tool grid_stat.

Used by: grid_stat_wrapper.py, grid_stat_wrapper.py
Family: [lename_templates]
Default: Varies

FCST_HR_END
Specify the maximum forecast hour to use.

Used by: point_stat_wrapper.py
Family: [cong]
Default: Varies

FCST_HR_INTERVAL
Specify the stride for forecast lead times.

Used by: point_stat_wrapper.py
Family: [cong]
Default: Varies

FCST_HR_START
Specify the starting forecast hour to use.

Used by: point_stat_wrapper.py
Family: [cong]
Default: Varies

FCST_INIT_INTERVAL
Specify the stride for forecast initializations.

Used by: compare_gridded_wrapper.py, ensemble_stat_wrapper.py, grid_stat_wrapper.py, mode_wrapper.py
Family: [cong]
Default: Varies

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

36

FCST_INPUT_DIR_REGEX
Specify the regular expression used for searching for forecast le input directories.

Used by: point_stat_wrapper.py
Family: [regex_pattern]
Default: Varies

FCST_INPUT_DIR
Specify the input directory for the forecast les.

Used by: compare_gridded_wrapper.py, grid_stat_wrapper.py, mode_wrapper.py, point_stat_wrapper.py,
pcp_combine_wrapper.py

Family: [dir]
Default: Varies

FCST_INPUT_FILE_REGEX
Regular expression to use when identifying which forecast le to use.

Used by: point_stat_wrapper.py
Family: [regex_pattern]
Default: Varies

FCST_INPUT_FILE_TMPL
Specify the lename template for input forecast les.

Used by: point_stat_wrapper.py
Family: [lename_templates]
Default: Varies

FCST_IS_DAILY_FILE
Specify whether the forecast le is a daily le or not.

Acceptable values: true/false

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

FCST_IS_PROB
Specify whether the forecast data are probabilistic or not.

Acceptable values: true/false

Used by: compare_gridded_wrapper.py, ensemble_stat_wrapper.py, grid_stat_wrapper.py, mode_wrapper.py
Family: [cong]

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

37

Default: Varies

FCST_LEVEL
Specify what accumulation level should be used from the forecast data for the analysis.

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

FCST_MAX_FORECAST
Specify the maximum forecast lead time to use for the analysis.

Used by: compare_gridded_wrapper.py, ensemble_stat_wrapper.py, grid_stat_wrapper.py, mode_wrapper.py
Family: [cong]
Default: Varies

FCST_MXUPHL_5000-2000_THRESH
Deprecated.

Used by:
Family:
Default:

FCST_NATIVE_DATA_TYPE
Specify the data format of the forecast data.

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

FCST_NC_TILE_REGEX
Dene the regular expression for input forecast les that are in netCDF.

Used by: series_by_lead_wrapper.py, series_by_init_wrapper.py
Family: [regex_pattern]
Default: Varies

FCST_PCP_COMBINE_INPUT_DIR
Specify the input directory for forecast les used with the MET pcp_combine tool.

Used by: pcp_combine_wrapper.py
Family: [dir]
Default: Varies

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

FCST_PCP_COMBINE_INPUT_TEMPLATE
Template used to specify input lenames for forecast les used by the MET pcp_combine tool.

Used by: pcp_combine_wrapper.py
Family: [lename_templates]
Default: Varies

FCST_PCP_COMBINE_OUTPUT_DIR
Specify the output directory for forecast les generated by the MET pcp_combine tool.

Used by: pcp_combine_wrapper.py
Family: [dir]
Default: Varies

FCST_PCP_COMBINE_OUTPUT_TEMPLATE
Template used to specify output lenames for forecast les generated by the MET pcp_combine tool.

Used by: pcp_combine_wrapper.py
Family: [lename_templates]
Default: Varies

FCST_PCP_COMBINE_RUN
Specify whether to run the MET pcp_combine tool on forecast data or not.

Acceptable values: true/false

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

FCST_REFC_0_THRESH
Deprecated.

Used by:
Family:
Default:

FCST_REGRID_DATA_PLANE_TEMPLATE
Template used to specify lenames for forecast data used by the MET regrid_data_plane tool.

Used by: regrid_data_plane_wrapper.py
Family: [lename_templates]
Default: Varies

FCST_TILE_PREFIX

38

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

39

Prex for forecast tile les. Used to create lename of intermediate les that are created while performing
a series analysis.

Used by: feature_util.py
Family: [regex_pattern]
Default: Varies

FCST_TILE_REGEX
Regular expression for forecast input les that are in GRIB2.

Used by: series_by_init_wrapper.py, series_by_lead_wrapper.py
Family: [regex_pattern]
Default: Varies

FCST_VAR
Dene the name of the forecast variable to be used in the analysis.

Used by: compare_gridded_wrapper.py, ensemble_stat_wrapper.py, make_plots_wrapper.py, met_util.py
Family: [cong]
Default: Varies

FCST_VAR1_LEVELS
Dene the levels for the rst forecast variable to be used in the analysis. There can be N number of these
variables dened in conguration les, simply increment the  _VAR1_ string to match the total number
of variables being used, e.g.:
FCST_VAR1_LEVELS
FCST_VAR2_LEVELS
.
.
.
FCST_VARN_LEVELS

Used by: make_plots_wrapper.py, met_util.py
Family: [cong]
Default: Varies

FCST_VAR1_NAME
Dene the name for the rst forecast variable to be used in the analysis. There can be N number of these
variables dened in conguration les, simply increment the  _VAR1_ string to match the total number
of variables being used, e.g.:
FCST_VAR1_NAME
FCST_VAR2_NAME
.
.

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

40

.
FCST_VARN_NAME

Used by: make_plots_wrapper.py, met_util.py
Family: [cong]
Default: Varies

FCST_VAR1_OPTIONS
Dene the options for the rst forecast variable to be used in the analysis. There can be N number of these
variables dened in conguration les, simply increment the  _VAR1_ string to match the total number
of variables being used, e.g.:
FCST_VAR1_OPTIONS
FCST_VAR2_OPTIONS
.
.
.
FCST_VARN_OPTIONS

Used by: make_plots_wrapper.py, met_util.py
Family: [cong]
Default: Varies

FCST_VAR1_THRESH
Dene the threshold(s) for the rst forecast variable to be used in the analysis. There can be N number
of these variables dened in conguration les, simply increment the  _VAR1_ string to match the total
number of variables being used, e.g.:
FCST_VAR1_THRESH
FCST_VAR2_THRESH
.
.
.
FCST_VARN_THRESH

Used by: met_util.py
Family: [cong]
Default: Varies

FHR_BEG
Specify the rst forecast lead time to use in the analysis.
FHR_INC.

Used by: series_by_lead_wrapper.py
Family: [cong]
Default: Varies

Use in combination with FHR_END and

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

41

FHR_END
Specify the last forecast lead time to use in the analysis. Use in combination with FHR_BEG and FHR_INC.

Used by: series_by_lead_wrapper.py
Family: [cong]
Default: Varies

FHR_GROUP_BEG
Dene which forecast lead time should be rst in a group of forecast leads to use in the analysis. Use in
combination with FHR_GROUP_END and FHR_INC.
Example:
FHR_GROUP_BEG = 24
FHR_GROUP_END = 42
FHR_INC = 6

List of forecast leads processed: [24, 30, 36, 42]

Used by: series_by_lead_wrapper.py
Family: [cong]
Default: Varies

FHR_GROUP_END
Dene which forecast lead time should be the last in a group of forecast leads to use in the analysis. Use in
combination with FHR_GROUP_BEG and FHR_INC.
Example:
FHR_GROUP_BEG = 24
FHR_GROUP_END = 42
FHR_INC = 6

List of forecast leads processed: [24, 30, 36, 42]

Used by: series_by_lead_wrapper.py
Family: [cong]
Default: Varies

FHR_GROUP_LABELS
Label strings to use for the forecast groups.

Used by: series_by_lead_wrapper.py
Family: [cong]
Default: Varies

FHR_INC
Stride to use for incrementing forecast lead times used in the analysis. Use in combination with FHR_BEG
and FHR_END or FHR_GROUP_BEG and FHR_GROUP_END.

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

42

Used by: series_by_lead_wrapper.py
Family: [cong]
Default: Varies

FILTER
Corresponds to the optional -lter argument to the plot_TCMPR.R script which is wrapped by tcmpr_plotter_wrapper.py.
This is a list of ltering options for the tc_stat tool.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

FILTERED_TCST_DATA_FILE
Corresponds to the optional -tcst argument to the plot_TCMPR.R script which is wrapped by tcmpr_plotter_wrapper.py.
This is a tcst data le to be used instead of running the tc_stat tool. Indicate a full path to the data le.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

FOOTNOTE_FLAG
This corresponds to the optional -footnote ag in the plot_TCMPR.R script which is wrapped by tcmpr_plotter_wrapper.py.
According to the plot_TCMPR.R usage, this ag is used to disable footnote (date).

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

FORECAST_TMPL
Filename template used to lter forecast les.

Used by: tc_pairs_wrapper.py
Family: [lename_templates]
Default: Varies

FOURIER_HEIGHT_DECOMP
Specify whether to perform a Fourier height decomposition or not.

Acceptable values: true/false

Used by: make_plots_wrapper.py, stat_analysis_wrapper.py
Family: [cong]
Default: Varies

CHAPTER 3.

3.4.7

METPLUS SYSTEM CONFIGURATION

G

GEMPAKTOCF_INPUT_DIR
Specify the input directory for the tool used to convert GEMPAK les to netCDF.

Used by: gempak_to_cf_wrapper.py
Family: [dir]
Default: Varies

GEMPAKTOCF_INPUT_TEMPLATE
Filename template used for input les to the tool used to convert GEMPAK les to netCDF.

Used by: gempak_to_cf_wrapper.py
Family: [lename_templates]
Default: Varies

GEMPAKTOCF_OUTPUT_DIR
Specify the output directory for les generated by the tool used to convert GEMPAK les to netCDF.

Used by: gempak_to_cf_wrapper.py
Family: [dir]
Default: Varies

GEMPAKTOCF_OUTPUT_TEMPLATE
Filename template used for output les from the tool used to convert GEMPAK les to netCDF.

Used by: gempak_to_cf_wrapper.py
Family: [lename_templates]
Default: Varies

GENERATE_TRACK_ASCII
Specify whether or not to produce an ASCII le containing all of the tracks in the plot.

Acceptable values: true/false

Used by: cyclone_plotter_wrapper.py
Family: [conf]
Default: Varies

GEN_SEQ
Deprecated.

Used by:
Family:

43

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

44

Default:

GFS_ANLY_FILE_TMPL
Filename template used to identify the GFS analysis le.

Used by: feature_util.py
Family: [lename_templates]
Default: Varies

GFS_FCST_FILE_TMPL
Filename templated used to identify the GFS forecast les.

Used by: feature_util.py
Family: [lename_templates]
Default: Varies

GRID_STAT_CONFIG
Specify the absolute path to the conguration le used by the MET grid_stat tool.

Used by: grid_stat_wrapper.py
Family: [cong]
Default: Varies

GRID_STAT_OUT_DIR
Specify the output directory where les from the MET grid_stat tool are written.

Used by: grid_stat_wrapper.py
Family: [dir]
Default: Varies

3.4.8

H

HFIP_BASELINE
Corresponds to the optional -hp_bsln ag in the plot_TCMPR.R script which is wrapped by tcmpr_plotter_wrapper.py.
This is a string that indicates whether to add the HFIP baseline, and indicates the version (no, 0, 5, 10 year
goal).

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

CHAPTER 3.

3.4.9

METPLUS SYSTEM CONFIGURATION

45

I

INIT_BEG
Specify the beginning initialization time to be used in the analysis. Format can be controlled by INIT_TIME_FMT.

Used by: command_builder.py, extract_tiles_wrapper.py, make_plots_wrapper.py, master_metplus.py,
stat_analysis_wrapper.py, tc_pairs_wrapper.py, tc_stat_wrapper.py

Family: [cong]
Default: Varies

INIT_BEG_HOUR
Specify the beginning initialization hour to be used in the analysis. Format is HH.

Used by: make_plots_wrapper.py, stat_analysis_wrapper.py
Family: [cong]
Default: Varies

INIT_END
Specify the ending initialization time to be used in the analysis. Format can be controlled by INIT_TIME_FMT.

Used by: command_builder.py, extract_tiles_wrapper.py, make_plots_wrapper.py, master_metplus.py,
stat_analysis_wrapper.py, tc_pairs_wrapper.py, tc_stat_wrapper.py

Family: [cong]
Default: Varies

INIT_END_HOUR
Specify the ending initialization hour to be used in the analysis. Format is HH.

Used by: make_plots_wrapper.py, stat_analysis_wrapper.py
Family: [cong]
Default: Varies

INIT_EXCLUDE
Specify which, if any, forecast initializations to exclude from the analysis.

Used by: tc_pairs_wrapper.py, tc_stat_wrapper.py
Family: [cong]
Default: Varies

INIT_HOUR_END
Specify the ending initialization hour to be used in the analysis. Format is HH.

Used by: extract_tiles_wrapper.py, tc_pairs_wrapper.py, tc_stat_wrapper.py
Family: [cong]

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

46

Default: Varies

INIT_INCLUDE
Specify which forecast initializations to include in the analysis.

Used by: tc_pairs_wrapper.py, tc_stat_wrapper.py
Family: [cong]
Default: Varies

INIT_INCREMENT
Control the increment or stride to use when stepping between forecast initializations. Units are seconds.

Used by: command_builder.py, extract_tiles_wrapper.py, make_plots_wrapper.py, master_metplus.py,
stat_analysis_wrapper.py, tc_pairs_wrapper.py, tc_stat_wrapper.py

Family: [cong]
Default: Varies

INIT_TIME_FMT
Specify a formatting string to use for INIT_BEG and INIT_END.

Used by: command_builder.py, master_metplus.py
Family:
Default:

INTERVAL_TIME
Dene the interval time in hours (HH) to be used by the MET pb2nc tool.

Used by: pb2nc_wrapper.py
Family: [cong]
Default: Varies

3.4.10

J

3.4.11

K

3.4.12

L

LAT_ADJ
Specify a latitude adjustment, in degrees to be used in the analysis.

Used by: met_util.py
Family: [cong]

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

47

Default: Varies

LEAD
For cyclone_plotter_wrapper.py, this refers to the column of interest in the input ASCII cyclone le.

In the tcmpr_plotter_wrapper.py, this corresponds to the optional -lead argument in the plot_TCMPR.R
script (which is wrapped by tcmpr_plotter.py). This argument is set to a comma-separted list of lead times
(h) to be plotted.

In feature_util.py, this corresponds to the name of the column of interest in the input ASCII data le.

In tc_stat_wrapper.py, this corresponds to the name of the column of interest in the input ASCII data le.

Used by: cyclone_plotter_wrapper.py, tcmpr_plotter_wrapper.py, feature_util.py, tc_stat_wrapper.py
Family: [cong]
Default: Varies

LEAD_LIST
Specify a list of forecast leads to include in the analysis. Comma separated list format, e.g.:
0, 24, 48, 72, 96, 120

Used by: make_plots_wrapper.py, stat_analysis_wrapper.py
Family: [cong]
Default: Varies

LEAD_SEQ
Specify the sequence of forecast lead times to include in the analysis. Comma separated list format, e.g.:
0, 6, 12

Used by: compare_gridded_wrapper.py, ensemble_stat_wrapper.py, gempak_to_cf_wrapper.py, grid_stat_wrapper.py,
mode_wrapper.py, reformat_gridded_wrapper.py

Family: [cong]
Default: Varies

LEGEND
The text to be includede in the legend of your plot.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

LOG_DIR
Specify the directory where log les from MET and METplus should be written.

Used by: command_builder.py, met_util.py
Family: [dir]

CHAPTER 3.

48

METPLUS SYSTEM CONFIGURATION

Default: Varies

LOG_LEVEL
Specify the level of logging.

Everything above this level is sent to standard output.

To quiet the output to a comfortable level, set

this to ERROR.

Options (ordered MOST verbose to LEAST verbose):
NOTSET
DEBUG
INFO
WARNING
ERROR
CRITICAL

Used by: met_util.py
Family: [cong]
Default: Varies

LOG_METPLUS
Control the lename of the METplus log le.

Control the timestamp appended to the lename with

LOG_TIMESTAMP_TEMPLATE. To turn OFF all logging, do not set this option.

Used by: master_metplus.py, met_util.py
Family: [cong]
Default: Varies

LOG_MET_OUTPUT_TO_METPLUS
Control whether logging output from the MET tools is sent to the METplus log le, or individual log les
for each MET tool.

Used by: command_runner.py
Family: [cong]
Default: yes/no

LOG_MET_VERBOSITY
Control the verbosity of the logging from the MET tools.
0 = Least amount of logging (lowest verbosity)
5 = Most amount of logging (highest verbosity)

Used by: command_builder.py
Family: [cong]
Default: 2

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

49

LOG_TIMESTAMP_TEMPLATE
Set the timestamp template for the METplus log le. Use Python strftime directives, e.g.
%Y%m%d for YYYYMMDD.

Used by: met_util.py
Family: [cong]
Default: %Y%m%d

LON_ADJ
Specify a longitude adjustment, in degrees to be used in the analysis.

Used by: met_util.py
Family: [cong]
Default: Varies

LOOP_BY_INIT
Control whether the analysis is processed across initialization times or not.

Used by: command_builder.py, compare_gridded_wrapper.py, ensemble_stat_wrapper.py, grid_stat_wrapper.py,
make_plots_wrapper.py, master_metplus.py, mode_wrapper.py, stat_analysis_wrapper.py

Family: [cong]
Default: true

LOOP_METHOD
Control the looping method for METplus. Valid options are times or processes.

Used by: master_metplus.py, pb2nc_wrapper.py, point_stat_wrapper.py
Family: [cong]
Default: Varies

3.4.13

M

METPLUS_BASE
Set the base directory for the METplus installation.

Used by: cong_launcher.py, grid_stat_wrapper.py, pb2nc_wrapper.py, point_stat_wrapper.py, tc_stat_wrapper.py
Family: [dir]
Default: /path/to

METPLUS_CONF
Provide the absolute path to the METplus nal conguration le. This le will contain every conguration
option and value used when METplus was run.

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

50

Used by: cong_launcher.py
Family: [cong]
Default: Varies

MET_BASE
The base directory where your MET installation resides.

Used by: cyclone_plotter_wrapper.py, extract_tiles_wrapper.py, master_metplus.py, met_util.py, pb2nc_wrapper.py,
point_stat_wrapper.py, series_by_init_wrapper.py, series_by_lead_wrapper.py, tcmpr_plotter_wrapper.py,
tc_pairs_wrapper.py, usage_wrapper.py

Family: [dir]
Default:

MET_BIN
The location of MET binaries.

Used by:
Family:
Default:

MET_BUILD_BASE
The base directory of the MET install. Only needed if using MET version 6.0

Used by: tcmpr_plotter_wrapper.py
Family: [dir]
Default: Varies

MET_INSTALL_DIR
The base directory of the MET install. To be dened when using MET version 6.1 and beyond

Used by:

compare_gridded_wrapper.py, cyclone_plotter_wrapper.py, ensemble_stat_wrapper.py, ex-

tract_tiles_wrapper.py, feature_util.py, grid_stat_wrapper.py, mode_wrapper.py, pb2nc_wrapper.py, pcp_combine_wrap
point_stat_wrapper.py, regrid_data_plane_wrapper.py, series_by_init_wrapper.py, series_by_lead_wrapper.py,

stat_analysis_wrapper.py, tcmpr_plotter_wrapper.py, tc_pairs_wrapper.py, tc_stat_wrapper.py, wavelet_stat_wrapper.p

Family: [dir]
Default: Varies

MISSING_VAL
Specify the missing value code.

Used by: tc_pairs_wrapper.py
Family: [cong]
Default: Varies

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

51

MISSING_VAL_TO_REPLACE
Specify the missing value code to replace.

Used by: tc_pairs_wrapper.py
Family: [cong]
Default: Varies

MODEL
Specify the model name.

Used by: compare_gridded_wrapper.py, ensemble_stat_wrapper.py, stat_analysis_wrapper.py, tc_pairs_wrapper.py
Family: [cong]
Default: Varies

MODEL_DATA_DIR
Specify the directory where the model data are located.

Used by: feature_util.py
Family: [dir]
Default: Varies

MODEL_LIST
Specify the list of models that were used in the analysis.

Used by: make_plots_wrapper.py, stat_analysis_wrapper.py
Family: [cong]
Default: Varies

MODEL_NAME
Specify the model name.

Used by: point_stat_wrapper.py
Family: [cong]
Default: Varies

MODEL_TYPE
Specify the model name.

Used by: compare_gridded_wrapper.py, ensemble_stat_wrapper.py, grid_stat_wrapper.py, mode_wrapper.py,
stat_analysis_wrapper.py

Family: [cong]
Default: Varies

CHAPTER 3.

3.4.14

METPLUS SYSTEM CONFIGURATION

N

NCAP2_EXE
Path to the ncap2 executable.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py, series_by_lead_wrapper.py
Family: [exe]
Default: /path/to

NCDUMP_EXE
Path to the ncdump executable.

Used by: met_util.py, pb2nc_wrapper.py, point_stat_wrapper.py, series_by_lead_wrapper.py
Family: [exe]
Default: /path/to

NC_FILE_TMPL
File template used to match netCDF les used for analysis.

Used by: pb2nc_wrapper.py
Family: [lename_templates]
Default: Varies

NLAT
The number of latitude points.

Used by: met_util.py
Family: [cong]
Default: Varies

NLON
The number of longitude points.

Used by: met_util.py
Family: [cong]
Default: Varies

NO_EE
Set the NO_EE ag for the TC Matched Pairs plotting utility.

Acceptable values: yes/no

Used by: tcmpr_plotter_wrapper.py
Family: [cong]

52

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

53

Default: no

NO_LOG
Set the NO_LOG ag for the TC Matched Pairs plotting utility.

Acceptable values: yes/no

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: no

3.4.15

O

OBS_12_FIELD_NAME
This variable is used to dene a 12 hour accumulation eld in the observation dataset used in the MET tool
pcp_combine.

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

OBS_1_FIELD_NAME
This variable is used to dene a 1 hour accumulation eld in the observation dataset used in the MET tool
pcp_combine.

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

OBS_24_FIELD_NAME
This variable is used to dene a 24 hour accumulation eld in the observation dataset used in the MET tool
pcp_combine.

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

OBS_3_FIELD_NAME
This variable is used to dene a 3 hour accumulation eld in the observation dataset used in the MET tool
pcp_combine.

Used by: pcp_combine_wrapper.py
Family: [cong]

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

54

Default: Varies

OBS_6_FIELD_NAME
This variable is used to dene a 6 hour accumulation eld in the observation dataset used in the MET tool
pcp_combine.

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

OBS_BUFR_VAR_LIST
Specify which BUFR codes to use from the observation dataset when using the MET pb2nc tool. Format is
comma separated list, e.g.:

PMO, TOB, TDO

Used by: pb2nc_wrapper.py
Family: [cong]
Default: Varies

OBS_DATA_INTERVAL
Specify the accumulation interval of the observation dataset used by the MET pcp_combine tool.

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

OBS_GEMPAK_INPUT_DIR
Specify the input directory for GEMPAK formatted observation les.

Used by: pcp_combine_wrapper.py
Family: [dir]
Default: Varies

OBS_GEMPAK_TEMPLATE
Filename template used to lter GEMPAK formatted observation les.

Used by: pcp_combine_wrapper.py
Family: [lename_templates]
Default: Varies

OBS_GRID_STAT_INPUT_DIR
Specify the directory where the input observation les are for the MET grid_stat tool.

Used by: grid_stat_wrapper.py
Family: [dir]

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

55

Default: Varies

OBS_GRID_STAT_INPUT_TEMPLATE
Filename template used to lter input observation les used by the MET grid_stat tool.

Used by: grid_stat_wrapper.py
Family: [lename_templates]
Default: Varies

OBS_INPUT_DIR
Specify the input directory for observation les.

Used by: compare_gridded_wrapper.py, grid_stat_wrapper.py, mode_wrapper.py, point_stat_wrapper.py
Family: [dir]
Default: Varies

OBS_INPUT_DIR_REGEX
Specify the regular expression to use when searching for observation le input directories.

Used by: point_stat_wrapper.py
Family: [regex_pattern]
Default: Varies

OBS_INPUT_FILE_REGEX
Regular expression used to lter observation input les used in the analysis.

Used by: point_stat_wrapper.py,
Family: [regex_pattern]
Default: Varies

OBS_INPUT_FILE_TEMPL
Specify the lename template to use for observation input les.

Used by: point_stat_wrapper.py,
Family: [lename_templates]
Default: Varies

OBS_IS_DAILY_FILE
Specify whether the forecast le is a daily le or not.

Acceptable values: true/false

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

OBS_LEVEL
Specify what accumulation level should be used from the observation data for the analysis.

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

OBS_MXUPHL_500_THRESH
Deprecated.

Used by:
Family:
Default:

OBS_MergedReectivityQCComposte_500_THRESH
Deprecated.

Used by:
Family:
Default:

OBS_NAME
Provide a string to identify the observation dataset name.

Used by: point_stat_wrapper.py
Family: [cong]
Default: Varies

OBS_NATIVE_DATA_TYPE
Specify the data format of the observation data.

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

OBS_PCP_COMBINE_INPUT_DIR
Specify the input directory for the observation data used by the MET pcp_combine tool.

Used by: pcp_combine_wrapper.py
Family: [dir]
Default: Varies

OBS_PCP_COMBINE_INPUT_TEMPLATE
Filename template used to lter input observation les used by the MET pcp_combine tool.

56

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

Used by: pcp_combine_wrapper.py
Family: [lename_templates]
Default: Varies

OBS_PCP_COMBINE_OUTPUT_DIR
Specify the output directory where les from the MET pcp_combine tool are written.

Used by: pcp_combine_wrapper.py
Family: [dir]
Default: Varies

OBS_PCP_COMBINE_OUTPUT_TEMPLATE
Filename template used for writing output les from the MET pcp_combine tool.

Used by: pcp_combine_wrapper.py
Family: [lename_templates]
Default: Varies

OBS_PCP_COMBINE_RUN
Specify whether to run pcp_combine on the observation data or not.

Acceptable values: True/False

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

OBS_REGRID_DATA_PLANE_INPUT_DIR
Specify the input directory for observation les used by the MET regrid_data_plane tool.

Used by: regrid_data_plane_wrapper.py
Family: [dir]
Default: Varies

OBS_REGRID_DATA_PLANE_OUTPUT_DIR
Specify the output directory where les are written from the MET regrid_data_plane tool.

Used by: regrid_data_plane_wrapper.py
Family: [dir]
Default: Varies

OBS_REGRID_DATA_PLANE_RUN
Specify whether to run regrid_data_plane on the observation data or not.

Acceptable values: True/False

57

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

58

Used by: regrid_data_plane_wrapper.py
Family: [cong]
Default: Varies

OBS_REGRID_DATA_PLANE_TEMPLATE
Specify the lename template to use for observation les (input and output) used by the MET regrid_data_plane
tool.

Used by: regrid_data_plane_wrapper.py
Family: [lename_templates]
Default: Varies

OBS_VAR
Specify the string for the observation variable used in the analysis.

Used by: compare_gridded_wrapper.py
Family: [cong]
Default: Varies

OBS_WINDOW_BEG
Corresponds to the OBS_WINDOW_BEG in the MET cong le for pb2nc. Please refer to Chapter 4 of
the MET User's Guide.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py
Family: [cong]
Default: Varies

OBS_WINDOW_END
Corresponds to the OBS_WINDOW_END in the MET cong le for pb2nc. Please refer to Chapter 4 of
the MET User's Guide.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py
Family: [cong]
Default: Varies

OB_TYPE
Provide a string to represent the type of observation data used in the analysis.

Used by: compare_gridded_wrapper.py, ensemble_stat_wrapper.py, grid_stat_wrapper.py, mode_wrapper.py,
stat_analysis_wrapper.py

Family: [cong]
Default: Varies

OUTPUT_BASE
Provide a path to the top level output directory for METplus.

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

59

Used by: cong_launcher.py, pb2nc_wrapper.py, point_stat_wrapper.py, tc_pairs_wrapper.py, tc_stat_wrapper.py
Family: [dir]
Default: Varies

OVERWRITE_NC_OUTPUT
Specify whether to overwrite the netCDF output or not when using the MET pb2nc tool.

Acceptable values: yes/no

Used by: pb2nc_wrapper.py
Family: [cong]
Default: yes

OVERWRITE_TRACK
Specify whether to overwrite the track data or not.

Acceptable values: yes/no

Used by: extract_tiles_wrapper.py, feature_util.py
Family: [cong]
Default: no

3.4.16

P

PARM_BASE
Specify the top level METplus parameter le directory.

Used by: cong_launcher.py, pb2nc_wrapper.py, point_stat_wrapper.py, tc_stat_wrapper.py
Family: [dir]
Default: Varies

PB2NC_CONFIG_FILE
Specify the absolute path to the conguration le for the MET pb2nc tool.

Used by: pb2nc_wrapper.py
Family: [cong]
Default: Varies

PB2NC_GRID
Specify a grid to use with the MET pb2nc tool.

Used by: pb2nc_wrapper.py
Family: [cong]

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

Default: Varies

PB2NC_MESSAGE_TYPE
Specify which PREPBUFR (PB) message types to convert using the MET pb2nc tool.

Used by: pb2nc_wrapper.py
Family: [cong]
Default: Varies

PB2NC_OUTPUT_DIR
Specify the directory where les will be written from the MET pb2nc tool.

Used by: pb2nc_wrapper.py
Family: [dir]
Default: Varies

PB2NC_POLY
Specify a polygon to be used with the MET pb2nc tool.

Used by: pb2nc_wrapper.py
Family: [cong]
Default: Varies

PB2NC_STATION_ID
Specify the ID of the station to use with the MET pb2nc tool.

Used by: pb2nc_wrapper.py
Family: [cong]
Default: Varies

PCP_COMBINE_METHOD
Specify the method to be used with the MET pcp_combine tool.

Used by: pcp_combine_wrapper.py
Family: [cong]
Default: Varies

PLOTTING_OUT_DIR
Specify the output directory where plots will be saved.

Used by: make_plots_wrapper.py
Family: [dir]
Default: Varies

60

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

PLOTTING_SCRIPTS_DIR
Specify the directory where the plotting scripts are located.

Used by: make_plots_wrapper.py
Family: [dir]
Default: Varies

PLOT_CONFIG_OPTS
Specify plot conguration options for the TC Matched Pairs plotting tool.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

PLOT_STATS_LIST
Specify which statistics should be plotted in a comma separated list, e.g.:
acc, bias, rmse

Used by: make_plots_wrapper.py
Family: [cong]
Default: Varies

PLOT_TYPES
Specify what plot types are desired for the TC Matched Pairs plotting tool.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

POINT_STAT_CONFIG_FILE
Specify the absolute path to the conguration le to be used with the MET point_stat tool.

Used by: point_stat_wrapper.py
Family: [cong]
Default: Varies

POINT_STAT_GRID
Specify the grid to use with the MET point_stat tool.

Used by: point_stat_wrapper.py
Family: [cong]
Default: Varies

61

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

62

POINT_STAT_MESSAGE_TYPE
Specify which PREPBUFR message types to process with the MET point_stat tool.

Used by: point_stat_wrapper.py
Family: [cong]
Default: Varies

POINT_STAT_OUTPUT_DIR
Specify the directory where output les from the MET point_stat tool are written.

Used by: point_stat_wrapper.py
Family: [dir]
Default: Varies

POINT_STAT_POLY
Specify a polygon to use with the MET point_stat tool.

Used by: point_stat_wrapper.py
Family: [cong]
Default: Varies

POINT_STAT_STATION_ID
Specify the ID of a specic station to use with the MET point_stat tool.

Used by: point_stat_wrapper.py
Family: [cong]
Default: Varies

PREFIX
This corresponds to the optional -prex ag of the plot_TCMPR.R script (which is wrapped by tcmpr_plotter_wrapper.py).
This is the output le name prex.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

PREPBUFR_DATA_DIR
Specify the directory where the PREPBUFR data are located for the MET pb2nc tool.

Used by: pb2nc_wrapper.py
Family: [dir]
Default: Varies

PREPBUFR_DIR_REGEX
Regular expression to use when searching for PREPBUFR data.

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

63

Used by: pb2nc_wrapper.py
Family: [regex_pattern]
Default: Varies

PREPBUFR_FILE_REGEX
Regular expression to use when searching for PREPBUFR les.

Used by: pb2nc_wrapper.py
Family: [regex_pattern]
Default: Varies

PREPBUFR_MODEL_DIR_NAME
Specify the name of the model being used with the MET pb2nc tool.

Used by: pb2nc_wrapper.py
Family: [cong]
Default: Varies

PROCESS_LIST
Specify the list of processes for METplus to perform, in a comma separated list.

Used by: master_metplus.py
Family: [cong]
Default: Varies

PROJ_DIR
A directory for generic use. The user can store input les (if INPUT_BASE is not dened), intermediate
les, and any other project-related les.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py, tc_stat_wrapper.py
Family: [dir]
Default: Varies

3.4.17

Q

3.4.18

R

REFERENCE_TMPL
The lename template describing the observation/reference data.

Used by: tc_pairs_wrapper.py
Family: [lename_templates]

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

64

Default: Varies

REGION_LIST
A list of the regions of interest.

Used by: make_plots_wrapper.py, stat_analysis_wrapper.py
Family: [cong]
Default: Varies

REGRID_TO_GRID
If supported, provide the output grid that is desired from the MET tool being used in the analysis.

Used by: make_plots_wrapper.py, point_stat_wrapper.py
Family: [cong]
Default: Varies

REGRID_USING_MET_TOOL
Specify whether to regrid using the MET regrid_data_plane tool or not.

Acceptable values: yes/no

Used by: feature_util.py, met_util.py, series_by_init_wrapper.py, series_by_lead_wrapper.py
Family: [cong]
Default: yes

RM_EXE
Specify the path to the Linux rm executable.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py, series_by_lead_wrapper.py
Family: [exe]
Default: /path/to

RP_DIFF

This corresponds to the optional -rp_di ag of the plot_TCMPR.R script (which is wrapped by tcmpr_plotter_wrapper.py).
This a comma-separated list of thresholds to specify meaningful dierences for the relative performance plot.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

3.4.19

SAVE

S

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

65

Corresponds to the optional -save ag in plot_TCMPR.R (which is wrapped by tcmpr_plotter_wrapper.py).
This is a yes/no value to indicate whether to save the image (yes).

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

SAVE_DATA
Corresponds to the optional -save_data ag in plot_TCMPR.R (which is wrapped by tcmpr_plotter_wrapper.py).
Indicates whether to save the ltered track data to a le instead of deleting it.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

SCATTER_X
Corresponds to the optional -scatter_x ag in plot_TCMPR.R (which is wrapped by tcmpr_plotter_wrapper.py).
This is a comma-separated list of x-axis variable columns to plot.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

SCATTER_Y
Corresponds to the optional -scatter_y ag in plot_TCMPR.R (which is wrapped by tcmpr_plotter_wrapper.py).
This is a comma-separated list of y-axis variable columns to plot.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

SERIES
Corresponds to the optional -series ag in plot_TCMPR.R (which is wrapped by tcmpr_plotter_wrapper.py).
This is the column whose unique values dene the series on the plot, optionally followed by a comma-separated
list of values, including: ALL, OTHER, and colon-separated groups.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

SERIES_ANALYSIS_BY_INIT_CONFIG_FILE
Specify the absolute path for the conguration le to use with the MET series_analysis tool by initialization
time.

Used by: series_by_init_wrapper.py
Family: [cong]

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

66

Default: Varies

SERIES_ANALYSIS_BY_LEAD_CONFIG_FILE
Specify the absolute path for the conguration le to use with the MET series_analysis tool by lead time.

Used by: series_by_lead_wrapper.py
Family: [cong]
Default: Varies

SERIES_ANALYSIS_FILTER_OPTS
Filtering options to be applied during series analysis. Filter options are performed by invoking the MET
tc_stat tool within the METplus wrapper.

Used by: series_by_lead_wrapper.py, series_by_init_wrapper.py
Family: [cong]
Default: Varies

SERIES_CI
Corresponds to the optional -series_ci ag in plot_TCMPR.R (which is wrapped by tcmpr_plotter_wrapper.py).
This is a list of true/false for condence intervals. This list can be optionally followed by a comma-separated
list of values, including ALL, OTHER, and colon-separated groups.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

SERIES_INIT_FILTERED_OUT_DIR
Specify the directory where ltered les will be written from the MET series_analysis tool when processing
by initialization time.

Used by: series_by_init_wrapper.py
Family: [dir]
Default: Varies

SERIES_INIT_OUT_DIR
Specify the directory where les will be written from the MET series analysis tool when processing by
initialization time.

Used by: series_by_init_wrapper.py
Family: [dir]
Default: Varies

SERIES_LEAD_FILTERED_OUT_DIR
Specify the directory where ltered les will be written from the MET series_analysis tool when processing
by lead time.

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

67

Used by: series_by_lead_wrapper.py
Family: [dir]
Default: Varies

SERIES_LEAD_OUT_DIR
Specify the directory where les will be written from the MET series analysis tool when processing by lead
time.

Used by: series_by_lead_wrapper.py
Family: [dir]
Default: Varies

SKILL_REF
This corresponds to the optional -skill_ref ag in plot_TCMPR.R (which is wrapped by tcmpr_plotter_wrapper.py).
This is the identier for the skill score reference.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

START_DATE
Specify the start data for the analysis time period. Format is YYYYYMMDDHH.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py
Family: [cong]
Default: Varies

START_HOUR
Specify the start hour for the analysis time period. Format is HH.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py
Family: [cong]
Default: Varies

STAT_ANALYSIS_CONFIG
Specify the absolute path for the conguration le used with the MET stat_analysis tool.

Used by: stat_analysis_wrapper.py
Family: [cong]
Default: Varies

STAT_ANALYSIS_LOOKIN_DIR
Specify the input directory where the MET stat_analysis tool will nd input les.

Used by: stat_analysis_wrapper.py
Family: [dir]

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

Default: Varies

STAT_ANALYSIS_OUT_DIR
Specify the output directory where les will be written from the MET stat_analysis tool.

Used by: stat_analysis_wrapper.py
Family: [dir]
Default: Varies

STAT_FILES_INPUT_DIR
Specify the directory where stat les exist that plots can be generated from.

Used by: make_plots_wrapper.py
Family: [dir]
Default: Varies

STAT_LIST
Specify a list of statistics to be computed by the MET series_analysis tool.

Used by: series_by_init_wrapper.py, series_by_lead_wrapper.py
Family: [cong]
Default: Varies

STORM_ID
The identier of the storm(s) of interest.

Used by: cyclone_plotter_wrapper.py, met_util.py, tc_pairs_wrapper.py, tc_stat_wrapper.py
Family: [cong]
Default: Varies

STORM_NAME
The name(s) of the storm of interest.

Used by: tc_pairs_wrapper.py, tc_stat_wrapper.py
Family: [cong]
Default: Varies

SUBTITLE
The subtitle of the plot.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

68

CHAPTER 3.

3.4.20

METPLUS SYSTEM CONFIGURATION

T

TCMPR_DATA
Provide the input directory for the track data for the TC Matched Pairs plotting tool.

Used by: tcmpr_plotter_wrapper.py
Family: [dir]
Default: Varies

TCMPR_PLOT_OUT_DIR
Provide the output directory where the TC Matched Pairs plotting tool will create les.

Used by: tcmpr_plotter_wrapper.py
Family: [dir]
Default: Varies

TC_PAIRS_CONFIG_FILE
Provide the absolute path to the conguration le for the MET tc_pairs tool.

Used by: tc_pairs_wrapper.py
Family: [cong]
Default: Varies

TC_PAIRS_DIR
Specify the directory where the MET tc_pairs tool will write les.

Used by: tc_pairs_wrapper.py
Family: [dir]
Default: Varies

TC_PAIRS_FORCE_OVERWRITE
Specify whether to overwrite the output from the MET tc_pairs tool or not.

Acceptable values: yes/no

Used by: tc_pairs_wrapper.py
Family: [cong]
Default: no

TC_STAT_AMODEL
Specify the AMODEL for the MET tc_stat tool.

Used by: tc_stat_wrapper.py
Family: [cong]

69

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

70

Default: Varies

TC_STAT_BASIN
Specify the BASIN for the MET tc_stat tool.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_BMODEL
Specify the BMODEL for the MET tc_stat tool.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_CMD_LINE_JOB
Specify expression(s) that will be passed to the MET tc_stat tool via the command line.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_COLUMN_STR_NAME
Specify the string names of the columns for stratication with the MET tc_stat tool.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_COLUMN_STR_VAL
Specify the values for the columns set via the TC_STAT_COLUMN_STR_NAME option for use with the
MET tc_stat tool.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_COLUMN_THRESH_NAME
Specify the string names of the columns for stratication by threshold with the MET tc_stat tool.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

71

TC_STAT_COLUMN_THRESH_VAL
Specify the values used for thresholding the columns specied in the TC_STAT_COLUMN_THRESH_NAME
option for use with the MET tc_stat tool.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_CYCLONE
Specify the CYCLONE of interest for use with the MET tc_stat tool.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_DESC
Specify the DESC option for use with the MET tc_stat tool.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_INIT_BEG
Specify the beginning initialization time for stratication when using the MET tc_stat tool.

Acceptable formats: YYYYMMDD_HH, YYYYMMDD_HHmmss

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_INIT_END
Specify the ending initialization time for stratication when using the MET tc_stat tool.

Acceptable formats: YYYYMMDD_HH, YYYYMMDD_HHmmss

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_INIT_EXCLUDE
Specify the initialization times to exclude when using the MET tc_stat tool, via a comma separated list
e.g.:

20141220_18, 20141221_00

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

72

Acceptable formats: YYYYMMDD_HH, YYYYMMDD_HHmmss

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_INIT_HOUR
The beginning hour (HH) of the initialization time of interest.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_INIT_INCLUDE
Specify the initialization times to include when using the MET tc_stat tool, via a comma separated list e.g.:

20141220_00, 20141220_06, 20141220_12

Acceptable formats: YYYYMMDD_HH, YYYYMMDD_HHmmss

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_INIT_MASK
This corresponds to the INIT_MASK keyword in the MET tc_stat cong le. For more information, please
refer to Chapter 20 in the MET User's Guide.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_INIT_STR_NAME
This corresponds to the INIT_STR_NAME keyword in the MET tc_stat cong le. Please refer to Chapter
20 in the MET User's Guide for more details.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_INIT_STR_VAL
This corresponds to the INIT_STR_VAL keyword in the MET tc_stat cong le. Please refer to Chapter
20 in the MET User's Guide for more information.

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

73

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_INPUT_DIR
Specify the input directory where the MET tc_stat tool will look for les.

Used by: tc_stat_wrapper.py
Family: [dir]
Default: Varies

TC_STAT_JOBS_LIST
Specify expressions for the MET tc_stat tool to execute.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_LANDFALL
Specify whether only those points occurring near landfall should be retained when using the MET tc_stat
tool.

Acceptable values: True/False

Used by: tc_stat_wrapper.py
Family: [cong]
Default: False

TC_STAT_LANDFALL_BEG
Specify the beginning of the landfall window for use with the MET tc_stat tool.

Acceptable formats: HH, HHmmss

Used by: tc_stat_wrapper.py
Family: [cong]
Default: -24

TC_STAT_LANDFALL_END
Specify the end of the landfall window for use with the MET tc_stat tool.

Acceptable formats: HH, HHmmss

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

74

TC_STAT_LEAD
Specify the lead times to stratify by when using the MET tc_stat tool.

Acceptable formats: HH, HHmmss

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_LEAD_REQ
Specify the LEAD_REQ when using the MET tc_stat tool.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_MATCH_POINTS
Specify whether only those points common to both the ADECK and BDECK tracks should be written out
or not when using the MET tc_stat tool.

Acceptable values: True/False

Used by: tc_stat_wrapper.py
Family: [cong]
Default: false

TC_STAT_OUTPUT_DIR
Specify the output directory where the MET tc_stat tool will write les.

Used by: tc_stat_wrapper.py
Family: [dir]
Default: Varies

TC_STAT_RUN_VIA
Specify the method for running the MET tc_stat tool.

Acceptable values: CONFIG

If left blank (unset), tc_stat will run via the command line.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: CONFIG

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

75

TC_STAT_STORM_ID
Set the STORM_ID(s) of interest with the MET tc_stat tool.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_STORM_NAME
Set the STORM_NAME for use with the MET tc_stat tool.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_TRACK_WATCH_WARN
Specify which watches and warnings to stratify over when using the MET tc_stat tool.

Acceptable values: HUWARN, HUWATCH, TSWARN, TSWATCH, ALL

If left blank (unset), no stratication will be done.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_VALID_BEG
Specify a comma separated list of beginning valid times to stratify with when using the MET tc_stat tool.

Acceptable formats: YYYYMMDD_HH, YYYYMMDD_HHmmss

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_VALID_END
Specify a comma separated list of ending valid times to stratify with when using the MET tc_stat tool.

Acceptable formats: YYYYMMDD_HH, YYYYMMDD_HHmmss

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_VALID_EXCLUDE
Specify a comma separated list of valid times to exclude from the stratication with when using the MET

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

76

tc_stat tool.

Acceptable formats: YYYYMMDD_HH, YYYYMMDD_HHmmss

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_VALID_HOUR
This corresponds to the VALID_HOUR keyword in the MET tc_stat cong le.

For more information,

please refer to Chapter 20 of the MET User's Guide.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_VALID_INCLUDE
Specify a comma separated list of valid times to include in the stratication with when using the MET
tc_stat tool.

Acceptable formats: YYYYMMDD_HH, YYYYMMDD_HHmmss

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_VALID_MASK
This corresponds to the VALID_MASK in the MET tc_stat cong le. Please refer to Chapter 20 of the
MET User's Guide for more information.

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

TC_STAT_WATER_ONLY
Specify whether to exclude points where the distance to land is <= 0. If set to TRUE, once land is encountered the remainder of the forecast track is not used for the verication, even if the track moves back over
water.

Acceptable values: true/false

Used by: tc_stat_wrapper.py
Family: [cong]
Default: Varies

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

TIME_METHOD
Specify which time method to use with the MET pb2nc and point_stat tools.

Acceptable values: BY_VALID, BY_INIT

Used by: pb2nc_wrapper.py, point_stat_wrapper.py
Family:
Default:

TIME_SUMMARY_BEG
Specify the starting time of the summary when using the MET pb2nc tool.

Acceptable formats: HHMMSS

Used by: pb2nc_wrapper.py
Family: [cong]
Default: 000000

TIME_SUMMARY_END
Specify the ending time of the summary when using the MET pb2nc tool.

Acceptable formats: HHMMSS

Used by: pb2nc_wrapper.py
Family: [cong]
Default: 235959

TIME_SUMMARY_FLAG
Specify whether to receive a time summary from the MET pb2nc tool or not.

Acceptable values: True/False

Used by: pb2nc_wrapper.py
Family: [cong]
Default: False

TIME_SUMMARY_TYPES
Specify a comma separated list of time summary types to receive from the MET pb2nc tool.

Used by: pb2nc_wrapper.py
Family: [cong]
Default: Varies

TIME_SUMMARY_VAR_NAMES
Specify a comma separated list of time summary variable names to receive from the MET pb2nc tool.

77

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

78

Used by: pb2nc_wrapper.py
Family: [cong]
Default: Varies

TITLE
Specify a title string for the TC Matched Pairs plotting tool.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

TMP_DIR
Specify the path to a temporary directory where the user has write permissions.

Used by: extract_tiles_wrapper.py, pb2nc_wrapper.py, point_stat_wrapper.py, series_by_init_wrapper.py,
series_by_lead_wrapper.py, tc_stat_wrapper.py

Family: [dir]
Default: Varies

TOP_LEVEL_DIRS
Specify whether to use top-level directories when using the MET tc_pairs utility or not.

Acceptable values: yes/no

Used by: tc_pairs_wrapper.py
Family: [cong]
Default: no

TRACK_DATA_DIR
Specify the directory where track data are located for use with the MET tc_pairs tool.

Used by: tc_pairs_wrapper.py
Family: [dir]
Default: Varies

TRACK_DATA_MOD_FORCE_OVERWRITE
Specify whether to force an overwrite of the track data or not.

Acceptable values: yes/no

Used by: tc_pairs_wrapper.py
Family: [cong]
Default: no

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

79

TRACK_DATA_SUBDIR_MOD
Specify the sub-directory where modied track data les are stored for use with the MET tc_pairs tool.

Used by: tc_pairs_wrapper.py
Family: [dir]
Default: Varies

TRACK_TYPE
Specify the track type to lter by when using the MET tc_pairs tool.

Used by: tc_pairs_wrapper.py
Family: [cong]
Default: Varies

TR_EXE
Specify the path to the Linux tr executable.

Used by: pb2nc_wrapper.py, point_stat_wrapper.py
Family: [exe]
Default: /path/to

3.4.21

U

3.4.22

V

VALID_BEG
Specify a begin time for valid times for use in the analysis.

Acceptable formats: YYYYMM[DD[_HH]]

Used by: command_builder.py, make_plots_wrapper.py, master_metplus.py, stat_analysis_wrapper.py,
tc_pairs_wrapper.py, tc_stat_wrapper.py

Family: [cong]
Default: Varies

VALID_BEG_HOUR
Specify a beginning hour for valid times for use in the analysis.

Acceptable formats: HH

Used by: make_plots_wrapper.py, stat_analysis_wrapper.py
Family: [cong]

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

80

Default: Varies

VALID_END
Specify an end time for valid times for use in the analysis.

Acceptable formats: controlled via VALID_TIME_FMT

Used by: command_builder.py, make_plots_wrapper.py, master_metplus.py, stat_analysis_wrapper.py,
tc_pairs_wrapper.py, tc_stat_wrapper.py

Family: [cong]
Default: Varies

VALID_END_HOUR
Specify an end hour for valid times for use in the analysis.

Acceptable formats: controlled via VALID_TIME_FMT

Used by: make_plots_wrapper.py, stat_analysis_wrapper.py
Family: [cong]
Default: Varies

VALID_INCREMENT
Specify the time increment for valid times for use in the analysis.

Acceptable formats: seconds

Used by: command_builder.py, make_plots_wrapper.py, master_metplus.py, stat_analysis_wrapper.py,
tc_stat_wrapper.py

Family: [cong]
Default: Varies

VALID_TIME_FMT
Specify a strftime formatting string for use with VALID_BEG and VALID_END.

Used by: command_builder.py, master_metplus.py
Family: [cong]
Default: Varies

VAR_LIST
Specify a comma separated list of variables to be used in the analysis.

Used by: feature_util.py, pb2nc_wrapper.py, series_by_init_wrapper.py, series_by_lead_wrapper.py
Family: [cong]
Default: Varies

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

81

VERIFICATION_GRID
Specify the absolute path to a le containing information about the desired output grid from the MET
regrid_data_plane tool.

Used by: regrid_data_plane_wrapper.py
Family: [cong]
Default: Varies

VERIF_CASE
Specify a string identifying the verication case being performed.

Used by: make_plots_wrapper.py, stat_analysis_wrapper.py
Family: [cong]
Default: Varies

VERIF_TYPE
Specify a string describing the type of verication being performed.

Used by: make_plots_wrapper.py, stat_analysis_wrapper.py
Family: [cong]
Default: Varies

VERTICAL_LOCATION
Specify the vertical location desired when using the MET pb2nc tool.

Used by: pb2nc_wrapper.py
Family: [cong]
Default: Varies

3.4.23

W

WAVE_NUM_BEG_LIST
Specify a comma separated list of desired beginning wave numbers.

Used by: make_plots_wrapper.py, stat_analysis_wrapper.py
Family: [cong]
Default: Varies

WAVE_NUM_END_LIST
Specify a comma separated list of desired ending wave numbers.

Used by: make_plots_wrapper.py, stat_analysis_wrapper.py
Family: [cong]

CHAPTER 3.

METPLUS SYSTEM CONFIGURATION

Default: Varies

WGRIB2
Specify the path to the wgrib2 executable.

Used by: feature_util.py, pb2nc_wrapper.py, point_stat_wrapper.py
Family: [exe]
Default: /path/to

3.4.24

X

XLAB
Specify the x-axis label when using the TC Matched Pairs plotting tool.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

XLIM
Specify the x-axis limit when using the TC Matched Pairs plotting tool.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

3.4.25

Y

YLAB
Specify the y-axis label when using the TC Matched Pairs plotting tool.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

YLIM
Specify the y-axis limit when using the TC Matched Pairs plotting tool.

Used by: tcmpr_plotter_wrapper.py
Family: [cong]
Default: Varies

82

CHAPTER 3.

3.4.26

Z

METPLUS SYSTEM CONFIGURATION

83

References
Alberson, S.D., 1998: Five-day Tropical cyclone track forecasts in the North Atlantic Basin.

Weather &

Forecasting, 13, 1005-1015.
Bradley, A.A., S.S. Schwartz, and T. Hashino, 2008: Sampling Uncertainty and Condence Intervals for the
Brier Score and Brier Skill Score.

Weather and Forecasting, 23, 992-1006.

Brill, K. F., and F. Mesinger, 2009: Applying a general analytic method for assessing bias sensitivity to

Weather and Forecasting, 24, 17481754.

bias-adjusted threat and equitable threat scores.

Brown, B.G., R. Bullock, J. Halley Gotway, D. Ahijevych, C. Davis, E. Gilleland, and L. Holland, 2007:
Application of the MODE object-based verication tool for the evaluation of model precipitation

AMS 22nd Conference on Weather Analysis and Forecasting and 18th Conference on Numerical
Weather Prediction, 25-29 June, Park City, Utah, American Meteorological Society (Boston), Available
elds.

http://ams.confex.com/ams/pdfpapers/124856.pdf.

at

Bullock, R., T. Fowler, and B. Brown, 2016: Method for Object-Based Diagnostic Evaluation. NCAR Tech.
Note NCAR/TN-532+STR, 66 pp.

,

Candille

G., and O. Talagrand, 2008: Impact of observational error on the validation of ensemble prediction

systems.

Q. J. R. Meteorol. Soc.

134: 959971.

Casati, B., G. Ross, and D. Stephenson, 2004: A new intensity-scale approach for the verication of spatial
precipitation forecasts.

Meteorol. Appl.

11, 141-154.

Davis, C.A., B.G. Brown, and R.G. Bullock, 2006a: Object-based verication of precipitation forecasts, Part
I: Methodology and application to mesoscale rain areas.
Davis, C.A., B.G. Brown, and R.G. Bullock, 2006b:
Part II: Application to convective rain systems.

Monthly Weather Review, 134, 1772-1784.

Object-based verication of precipitation forecasts,

Monthly Weather Review, 134, 1785-1795.

Dawid, A.P., 1984: Statistical theory: The prequential approach.

J. Roy. Stat. Soc, A147, 278-292.

Ebert, E.E., 2008: Fuzzy verication of high-resolution gridded forecasts: a review and proposed framework.

Meteorological Applications, 15, 51-64.
Eckel, F. A., M.S. Allen, M. C. Sittel, 2012: Estimation of Ambiguity in Ensemble Forecasts.

casting, 27, 50-69.

doi:

http://dx.doi.org/10.1175/WAF-D-11-00015.1

84

Wea. Fore-

CHAPTER 3.

85

METPLUS SYSTEM CONFIGURATION

Efron, B. 2007: Correlation and large-scale signicance testing.

Journal of the American Statistical Associ-

ation, 102(477), 93-103.
Gilleland, E., 2010:

NCAR Technical Note

Condence intervals for forecast verication.

NCAR/TN-

479+STR, 71pp.

Calibrated Probabilistic Forecasting Using
Ensemble Model Output Statistics and Minimum CRPS Estimation. Technical Report no. 449, De-

Gneiting, T., A. Westveld, A. Raferty, and T. Goldman, 2004:

partment of Statistics, University of Washington. [Available online at

edu/www/research/reports/

http://www.stat.washington.

]

Hamill, T. M., 2001: Interpretation of rank histograms for verifying ensemble forecasts.

Mon. Wea. Rev.,

129, 550-560.
Hogan, R., E. O'Connor, and A. Illingworth, 2009: Verication of cloud-fraction forecasts.

Quart. Jour.

Roy. Meteorol. Soc., 135, 1494-1511.
Jollie, I.T., and D.B. Stephenson, 2012:

Forecast verication. A practitioner's guide in atmospheric science.

Wiley and Sons Ltd, 240 pp.
Kna, J.A., M. DeMaria, C.R. Sampson, and J.M. Gross, 2003:

Statistical, Five-Day Tropical Cyclone

Intensity Forecasts Derived from Climatology and Persistence.

Weather & Forecasting,

Vol. 18 Issue

2, p. 80-92.
Mason

,

S. J., 2004: On Using Climatology as a Reference Strategy in the Brier and Ranked Probability

Skill Scores.

Mon. Wea. Rev., 132, 18911895.

Mittermaier, M., 2013: A strategy for verifying near-convection-resolving model forecasts at observing sites.
Wea. Forecasting, 29, 185-204.
Mood

,

A. M., F. A. Graybill and D. C. Boes, 1974:

Introduction to the Theory of Statistics,

McGraw-Hill,

299-338.
Murphy, A.H., and R.L. Winkler, 1987: A general framework for forecast verication.

Monthly Weather

Review, 115, 1330-1338.
Roberts, N.M., and H.W. Lean, 2008:

Scale-selective verication of rainfall accumulations from high-

resolution forecasts of convective events.

Monthly Weather Review, 136, 78-97.

Saetra O., H. Hersbach, J-R Bidlot, D. Richardson, 2004: Eects of observation errors on the statistics for
ensemble spread and reliability.

Mon. Weather Rev.

132: 14871501.

Santos C. and A. Ghelli, 2012: Observational probability method to assess ensemble precipitation forecasts.

Q. J. R. Meteorol. Soc.

138: 209221.

Stephenson, D.B., 2000: Use of the Odds Ratio for diagnosing forecast skill.

Weather and Forecasting, 15,

221-232.
Stephenson, D.B., B. Casati, C.A.T. Ferro, and C.A. Wilson, 2008:
non-vanishing measure for forecasts of rare events.

Meteor. Appl.

The extreme dependency score:
15, 41-50.

A

CHAPTER 3.

86

METPLUS SYSTEM CONFIGURATION

, M., F. Kapp, and P. Friederichs, 2016: Spatial Verication Using Wavelet Transforms:
Quarterly Journal of the Royal Meteorological Society, 143, 120-136.

Weniger

A Review.

Wilks, D.S. 2010: Sampling distributions of the Brier score and Brier skill score under serial dependence.
Q.J.R. Meteorol. Soc., 136, 21092118. doi:10.1002/qj.709
Wilks, D., 2011:

Statistical methods in the atmospheric sciences.

Elsevier, San Diego.

List of Tables

87

List of Figures

88



Source Exif Data:
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.5
Linearized                      : No
Page Count                      : 89
Page Mode                       : UseOutlines
Author                          : 
Title                           : 
Subject                         : 
Creator                         : LaTeX with hyperref package
Producer                        : pdfTeX-1.40.15
Create Date                     : 2018:09:28 11:36:11-06:00
Modify Date                     : 2018:09:28 11:36:11-06:00
Trapped                         : False
PTEX Fullbanner                 : This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2015/dev/Debian) kpathsea version 6.2.1dev
EXIF Metadata provided by EXIF.tools

Navigation menu