hwrf.relocate Namespace Reference

This module implements Python classes that run the 2014 HWRF Relocation. More...

Detailed Description

This module implements Python classes that run the 2014 HWRF Relocation.

The HWRF relocation is divided into four parts:

• Stage1 — remove the prior cycle's vortex
• Stage2 — remove the parent vortex
• Stage3 — Relocate and paste the fields together
• Merge — merge the relocation output and GSI. This is only used when GSI is enabled.

In addition, due to the requirement of splitting the relocation into three stages, there are "relocation info" files for passing information between the three. The RelocationInfo object provides a means to read and write these files.

Classes
class	Merge
	This is a HWRF task that merges the WRF analysis files. More...
class	Relocation
	This represents all three stages of the relocate. More...
class	RelocationInfo
	Passes information about relocation status between relocation stages. More...
class	RelocationTask
	This is a HWRF task that forms the base class for all vortex relocation tasks, including the Merge. More...
class	Stage1
	This is a HWRF task that encapsulates stage 1 of the vortex relocation. More...
class	Stage2
	This is a HWRF task that encapsulates stage 2 of the vortex relocation which removes the parent model's vortex. More...
class	Stage3
	This is a HWRF task that encapsulates stage 3 of the vortex relocation which relocates and pastes the vortexes together from various sources. More...

Variables
list	__all__
	List of symbols to export via "from hwrf.relocate import *". More...
tuple	WARM = object()
	A constant used by the RelocationInfo to represent warm starts. More...
tuple	COLD = object()
	A constant used by the RelocationInfo to represent cold starts. More...

Variable Documentation

hwrf.relocate.__all__

Initial value:

= ['Stage1', 'Stage2', 'Stage3', 'Merge', 'RelocationInfo',
         'WARM', 'COLD']

List of symbols to export via "from hwrf.relocate import *".

Definition at line 21 of file relocate.py.

hwrf.relocate.COLD = object()

A constant used by the RelocationInfo to represent cold starts.

Definition at line 64 of file relocate.py.

hwrf.relocate.WARM = object()

A constant used by the RelocationInfo to represent warm starts.

Definition at line 60 of file relocate.py.