| ▼Nconfdoc | Generates the doc/config-files.dox, which documents configuration files |
| Ccoredoc | Subclass of override, for documenting the core configuration files |
| Cdocbase | Stores documentation for all configuration options and sections |
| Coverride | Subclass of docbase for documenting files that override the base configuration |
| Cparsefile | Config file parser |
| ▼Nhwrf | Defines classes that know how to run all parts of the HWRF system |
| ►Nbufrprep | Contains Bufrprep, which converts data tanks to bufr files, and otherwise preprocesses the prepbufr and bufr files |
| CBufrprep | This is a HWRF task that preprocesses observations in data tanks to create bufr files suitable for input to hwrf.gsi classes |
| ►Nconfig | Parses UNIX conf files and makes the result readily available |
| CConfFormatter | Internal class that implements HWRFConfig.strinterp() |
| CConfTimeFormatter | Internal function that implements time formatting |
| CEnvironment | Returns environment variables, allowing substitutions |
| CHWRFConfig | Class that contains configuration information |
| ►Ncopywrf | Contains the WRFCopyTask, which delivers WRF output and input |
| CWRFCopyTask | Wrf file delivery task |
| ►Ncoupling | |
| CComponent | |
| CComponentIniter | |
| CCoupledWRF | |
| CCouplingStatus | |
| ►Nensda | Utilities for ensemble-based data assimilation |
| CAlwaysRunENSDA | Used in place of CycleTDRCheck to force ENSDA to always run |
| CCycleTDRCheck | Determines if Tail Doppler Radar (TDR) data is available |
| CDAEnsemble | Represents a two-dimensional ensemble-vs-time array of hwrf.hwrftask.HWRFTask objects |
| CFromGFSENKF | Forecast ensemble member based on the GFS ENKF |
| CFromPriorCycle | Represents an ensemble member from the previous forecast cycle |
| ►Nexceptions | Exceptions raised by the hwrf package |
| CDomainExists | Raised when adding a domain, if a domain by the same name already exists |
| CDomainsDone | Raised when it is no longer possible to add domains, but the caller tried to add one |
| CDuplicateTaskName | Raised when more than one task is registered with the same name in an HWRFConfig object |
| CEmptyCouplerNamelist | |
| CEndBeforeStart | Raised when the end of a timespan is before the beginning |
| CEndNotTimestep | Raised when the end of a timespan is not a timestep |
| CEnsdaTrackerMissing | |
| CForecastInputError | Parent class of exceptions specific to the hwrf.fcsttask module |
| CGeogridNoLog | Raised when geogrid did not create a log file |
| CGeogridNoOutput | Raised when a geogrid output file is missing or empty |
| CGribberError | Exceptions for hwrf.regrib.GRIBTask for certain internal errors |
| CGRIBInputError | Raised when a GRIB file is invalid |
| CGRIBLocationError | Raised when no location is specified for a tracker input GRIB file |
| CGridlessError | Raised when a grid was expected but none was provided |
| CGridMismatchError | Raised when two GRIB files have non-matching grids, but a matching grid is required |
| CGSIInputError | Raised when GSI cannot find a required input file |
| CHWRFArchiveInsane | Raised when the sanity check of the HWRF archiving settings fails |
| CHWRFConfigFileOrder | Raised when configuration files were specified in the wrong order |
| CHWRFConfigInsane | Raised when the requested configuration conf or hwrf_expt files fail a sanity check |
| CHWRFConfigUnsupported | Raised when the user requests a configuration that makes sense, but is not supported |
| CHWRFCouplingError | |
| CHWRFCycleInsane | Raised when the configuration had a different cycle than expected |
| CHWRFDirInsane | Raised when a directory is unspecified, missing or invalid |
| CHWRFError | Base class of all exceptions in this module |
| CHWRFExecutableInsane | Raised when the HWRF executables fail a sanity check |
| CHWRFFixInsane | Raised when the HWRF fix files fail a sanity check |
| CHWRFInputError | Base class of exceptions related to the hwrf.input module |
| CHWRFInputInsane | Raised when input files to HWRF fail a sanity check |
| CHWRFSanityError | Base class of all sanity checker exceptions |
| CHWRFScriptInsane | Raised when HWRF scripts fail a sanity check |
| CHWRFStormInsane | Raised when the configuration had a different storm than expected |
| CHWRFTimeError | Base class used for time-related HWRF exceptions |
| CHWRFVariableInsane | Raised when a sanity check on a variable's value failed |
| CInputSourceBadType | Raised when a configuration file requests a DataCatalog class that does not exist |
| CInvalidConfigOptName | Raised when one tries to use an invalid string for an option name |
| CInvalidDomainStart | Raised when the hwrf.wrf.WRFDomain start type is unrecognized |
| CInvalidInputSpecification | Raised when an input source is missing the location, or both histprio and fcstprio |
| CInvalidRegribResult | Debug assetion in hwrf.regrib used to detect type mismatches |
| CInvalidTimespan | Superclass of exceptions relating to groups of one or more distinct times and relationships between them |
| CInvalidTimestep | Raised when a timestep is invalid, such as a negative timestep for a situation that requires a positive one |
| CMissingGRIBError | Not currently used, this would be raised when GRIB inputs to the tracker are missing |
| CNamelistKeyError | Raised when an hwrf.namelist is asked for a key that does not exist |
| CNamelistValueError | Raised when hwrf.namelist cannot convert a value to or from Fortran namelist format |
| CNoCoupledComponents | |
| CNoGeogData | Raised when the prep_hybrid program cannot find WPS geogrid output data |
| CNoIndexError | Raised when a GRIB file should have an index file already, but doesn't |
| CNoNearbyValues | Raised when an operation has a set of known times, but another provided time is not near one of those known times |
| CNoOceanData | |
| CNoOutputTime | Raised when a time was required, but none was provided |
| CNoProductError | Raised when an operation that produces input to Regrib should have produced a Product, but produced nothing at all |
| CNoSpectralData | Raised when the spectral input files to prep_hybrid do not exist after some specified amount of time |
| CNoSuchDomain | Raised by hwrf.input when trying to get the wrong domain from its hwrf.relocate.Relocate child objects |
| CNoTimespan | Raised when a timespan was expected, but none was available |
| CNotInTimespan | Raised when a time is outside the range of times being processed by a function |
| COceanExeUnspecified | |
| COceanInitFailed | Raised when the ocean init did not produce some expected outputs |
| COutputStreamDisabled | Raised when attempting to obtain information about when a WRF stream outputs, if the stream is disabled |
| COverspecifiedOutputTime | Raised when an output time is specified in two redundant ways |
| CPartialTransfer | Raised when a file transfer, done by an InputSource, was incomplete |
| CPostFailed | Raised upon errors that would cause a retry, in the PostOneWRF.run when passed the raiseall=True argument |
| CPostHasNoInput | Raised when the post's input file is not available and raiseall=True in PostOneWRF.run |
| CPrecisionTooHigh | Raised when a time was requested with higher precision than available |
| CPrepHybridError | Base class of exceptions related to the prep_hybrid program |
| CProductAmbiguityError | Raised when an operation that provides input to Regrib produces more than one product |
| CRealNMMError | Raised when failing to run the real_nmm program |
| CRegribError | Superclass of errors used by Regrib |
| CRegribGridError | Base class of grid-related regrib errors |
| CRegribKeyError | Raised when a RegribMany is given an invalid name: one that does not match a known grid or operation |
| CRegribManyError | Base class of errors from the hwrf.regrib.RegribMany |
| CRegribProductError | Superclass of errors relating to regrib products |
| CRelocateOutputMissing | Raised when a relocation program did not produce an expected output file |
| CRelocationConfigurationError | Raised when an impossible configuration is requested |
| CRelocationError | Raised when something in the vortex relocation fails |
| CRelocationInputError | Raised when required inputs to the relocation are missing |
| CSetNestFailed | Raised when failing to set the parent start location via the set_nest (set_ij_start) program |
| CStartNotAtParentTimestep | Raised when a timespan's beginning is not at a timestep |
| CStormRadiusError | Raised when the merge cannot find the storm_radius file in the relocate or fix directory |
| CSubsetless | Raised when a Regrib was expecting a GRIB subsetter function, but no such function was provided |
| CTimestepModularityError | Called when one hour is not divisable by the WRF output timestep |
| CTimestepTooLong | Raised when a timestep is too long for the process under consideration |
| CTimestepTooShort | Raised when a timestep is too short for the process under consideration |
| CTimezoneProvided | Raised when a timezone is provided |
| CTrackerError | Base class of hwrf.tracker exceptions |
| CTrackerInputError | Base class of exceptions raised when the tracker's input files are missing or invalid |
| CTrackerModeError | Raised when an impossible tracker configuration is requested, such as running with a grid that is both regional and global |
| CTrackerStormError | Raised when multiple storms are requested, but only one was expected |
| CUnexpectedColdStart | Raised when the relocation could not find the prior cycle's 6hr forecast, but it expected to be able to |
| CUngribCannotSubset | Raised when hwrf.wps.Ungrib cannot subset files as requested |
| CUngribInputUnknown | Raised for hwrf.wps.Ungrib input problems |
| CUngribNoInput | Raised when ungrib cannot find an input file it needs |
| CUngribSubsetError | Raised when wgrib or wgrib2 generates an empty or invalid file |
| CUnsupportedTransfer | Raised when a configuration file requests an unsupported data transfer method (such as carrier pigeon) |
| CWaveInitFailed | |
| CWPSAssertion | Raised when WPS inputs are implausable |
| CWPSError | Base class of WPS-related exceptions |
| CWRFAnlMissing | Raised when wrf or real want to run, but wrfanl files are missing |
| CWRFBdyMissing | Raised when wrf or real want to run, but wrfbdy files are missing |
| CWRFDomainError | Base class of errors related to a WRF domain |
| CWRFError | Base class of WRF-related errors |
| CWRFGeogridMissing | Raised when wrf or real want to run but geogrid data is missing |
| CWRFInputMissing | Raised when wrf or real want to run, but wrfinput files are missing |
| CWRFMetgridMissing | Raised when wrf or real want to run, but metgrid data is missing |
| CWRFMissing | Raised when wrf or real want to run but needed input data is missing |
| CWRFPrepMissing | Raised when real wants prep_hybrid data, but that data is missing |
| CWW3InputError | |
| ►Nfcsttask | Runs the real_nmm or wrf executables |
| CAnalysisCycle | Runs wrf for an analysis cycle |
| CFcstTask | Abstract base class of anything that runs or prepares input for a forecast model |
| CFort652WRF | Links real_nmm fort.65 files the current directory for a wrf run |
| CGeog2WRF | Links Geogrid data to the current directory for a wrf or real_nmm run |
| CInput2Fcst | Abstract base class of wrf/real_nmm input providers |
| CMet2WRF | Links Metgrid data to the current directory for a wrf or real_nmm run |
| CPrep2WRF | Links prep_hybrid files to the current directory for a real_nmm run |
| CRealNMM | HWRFTask subclass that runs real_nmm |
| CWRFAnl | Runs a short WRF simulation to generate wrfanl files |
| CWRFAnl2WRF | Links wrfanl or ghost files the current directory for a wrf run |
| CWRFAnl4Trak | Runs wrfanl and generates a track file |
| CWRFAtmos | The uncoupled HWRF forecast Task |
| CWRFBdy2WRF | Links real_nmm wrfbdy_d01 files the current directory for a wrf run |
| CWRFGhost | Runs a short WRF simulation to generate wrfanl files named "ghost" |
| CWRFGhostForPost | Runs wrf to generate ghost (wrfanl) and wrfout files |
| CWRFInput2WRF | Links real_nmm wrfinput_d01 files the current directory for a wrf run |
| CWRFTaskBase | Base class of classes that run wrf or real_nmm |
| ►Nfinalmergetask | |
| CFinalMergeTask | |
| CInput2FinalMerge | |
| CMerge2FinalMerge | |
| CWRFInput2FinalMerge | |
| ►Ngribtask | Declares GRIBTask, which automates regribbing operations |
| CGRIBTask | An hwrf.hwrftask.HWRFTask that performs regribbing operations |
| CLockDummy | A Python "with" block construct that does nothing |
| ►Ngsi | Runs the GSI data assimilation on the HWRF system |
| CFGATGSI | Runs the GSI based on the HWRF FGAT scheme |
| CGSIBase | Base class of anything that runs the GSI |
| ►Ngsipost | Post-processes GSI input and output for data assimilation diagnostics |
| CGSIPost | Post-processes GSI inputs and outputs |
| ►Nhwrfsystem | Combines multiple tasks together to make the HWRF post-processing system |
| CFakeStormForecast | |
| CForecastBase | |
| CHWRFForecastPostProcessing | Creates the post-processing for the HWRF forecast job |
| CHWRFGSIPostProcessing | Configures the GSI post-processing and regribbing |
| ►Nhwrftask | Base class of tasks run by HWRF |
| CHWRFTask | The base class of tasks run by the HWRF system |
| ►Nhycom | |
| CHYCOMInit | |
| CHYCOMIniter | |
| CHYCOMPost | |
| CWRFCoupledHYCOM | |
| ►Ninit | Combines Tasks from multiple modules into a single initialization object |
| CFGATInit | The FGATInit represents an array of InitBeforeGSI objects, each run for one forecast hour of some parent model (usually GDAS) |
| CHWRFInit | Runs the deterministic model initialization |
| CInitBeforeGSI | Runs the FGAT initialization for one FGAT member |
| ►Ninput | Obtains input data needed by various subclasses of hwrf.hwrftask.HWRFTask |
| CDataCatalog | Provides the location of a file in an archive, on disk or on a remote server via sftp or ftp |
| CInputSource | Fetch data from multiple sources |
| ►Nlauncher | Creates the initial HWRF directory structure, loads information into each job |
| CHWRFLauncher | A replacement for the hwrf.config.HWRFConfig used throughout the HWRF system |
| ►Nmpipomtc | Runs the POM initialization and POM-WRF coupled forecast |
| CPOMInit | A wrapper around the pom package that runs the POM initialization |
| CPOMIniter | This is an internal implementation class that should never be used directly |
| CWRFCoupledPOM | Runs a WRF-POM coupled simulation |
| ►Nmultistorm | |
| CFakeInit | |
| CForecastWatcher | |
| CInput2FinalMerge | |
| CRealInit | |
| CWRFAtmosMultiStorm | |
| CWRFCopyTaskMS | |
| ►Nnamelist | This module provides two different ways to generate Fortran namelist files from HWRFConfig sections: |
| CConf2Namelist | Generates a Fortran namelist entirely from config files |
| CNamelistInserter | Insert config file data into a Fortran namelist file |
| CNamelistRecursion | Used to indicate namelist recursion |
| ►Nnhc_products | Generates NHC-specific products and validates wrfdiag files |
| CNHCProducts | This is a wrapper around the hwrf_nhc_products Fortran program |
| ►Nnumerics | Time manipulation and other numerical routines |
| Cpartial_ordering | Sorts a pre-determined list of objects, placing unknown items at a specified location |
| CTimeArray | A time-indexed array that can only handle equally spaced times |
| CTimeContainer | Abstract base class that maps from time to objects |
| CTimeMapping | Maps from an ordered list of times to arbitrary data |
| ►Npost | Runs the Unified Post Processor on outputs from the WRF-NMM, producing E grid GRIB files as EGRIB1Product objects |
| CEGRIB1Product | Represents an E grid WRF-NMM GRIB1 file, and stores two metadata values: CENLA and CENLO which contain the domain center location |
| CPostManyWRF | A wrapper around PostOneWRF that posts many WRF output times |
| CPostOneWRF | This is an HWRFTask that post-processes output data for a single WRF stream, from several WRF domains at a a given time |
| ►Nprep | PrepHybrid runs the prep_hybrid program to transform GFS spectral files to the HWRF grid |
| CPrepHybrid | Runs the prep_hybrid program on GFS spectral files |
| ►Nregrib | Describes regribbing operations using an algebraic structure |
| CFixedLocation | Represents a specific location on the earth as a latitude, longitude pair |
| CGRIB1Fetcher | The GRIB1Fetcher is a GRIB1Op subclass that fetches a GRIB1 file from a RegribMany |
| CGRIB1File | This subclass of GRIB1Op represents a GRIB1 file on disk that is ALREADY PRESENT |
| CGRIB1Op | This subclass of GRIBOp produces GRIB1 files |
| CGRIB1Product | This class represents a GRIB1 file produced by this workflow |
| CGRIB1Selector | This object produces a GRIB1Op from a call to a Task object's Task.product |
| CGRIB2File | This subclass of GRIB2Op represents a GRIB2 file on disk that is ALREADY PRESENT |
| CGRIB2Op | This subclass of GRIBOp produces GRIB2 files, and can be converted to GRIB1 via obj*GRIB1 or obj.to_grib1() |
| CGRIB2Product | This class represents a GRIB2 file that is produced by this workflow |
| CGRIBBase | Base class for the regridding object tree |
| CGRIBGrid | This class represents a GRIB1 or GRIB2 grid specification |
| CGRIBGridBase | This abstract base class represents something that is able to produce a GRIBGrid object when make() is called |
| CGRIBGridCompute | This class represents a GRIBGrid that must be computed from some other input, usually a GRIB file |
| CGRIBGridFetcher | This class represents a GRIBGrid that is stored in a RegribMany object |
| CGRIBOp | This is the abstract base class for all GRIB1 and GRIB2 files and operators |
| CGRIBSubsetter | A GRIBBase that subsets GRIB files, keeping only certain parameters |
| CGRIBSubsetterFetcher | This class grabs a GRIBSubsetter from a RegribMany object |
| CRegrib | This is a helper class intended to be used internally by RegribMany |
| CRegribBase | This is the abstract base class of Regrib and RegribMany and should not be instantiated directly |
| CRegribMany | Runs regrib operations on many input times, sending output to an hwrf.gribtask.GRIBTask |
| CUpstreamGRIB1 | This subclass of GRIB1Op and UpstreamFile represents a GRIB1 file that is produced by an upstream workflow |
| ►Nrelocate | This module implements Python classes that run the 2014 HWRF Relocation |
| CMerge | This is a HWRF task that merges the WRF analysis files |
| CRelocation | This represents all three stages of the relocate |
| CRelocationInfo | Passes information about relocation status between relocation stages |
| CRelocationTask | This is a HWRF task that forms the base class for all vortex relocation tasks, including the Merge |
| CStage1 | This is a HWRF task that encapsulates stage 1 of the vortex relocation |
| CStage2 | This is a HWRF task that encapsulates stage 2 of the vortex relocation which removes the parent model's vortex |
| CStage3 | This is a HWRF task that encapsulates stage 3 of the vortex relocation which relocates and pastes the vortexes together from various sources |
| ►Nrevital | Defines the Revital class which manipulates tcvitals files |
| CRevital | This class reads one or more tcvitals files and rewrites them as requested |
| CRevitalError | Base class of errors related to rewriting vitals |
| CRevitalInitError | This exception is raised when an argument to the Revital constructor is invalid |
| ►Nstorminfo | Defines StormInfo and related functions for interacting with vitals ATCF data |
| CCenturyError | Raised when an implausible century is found |
| CInvalidATCF | Raised when invalid ATCF data is found |
| CInvalidBasinError | This exception is raised when an invalid Tropical Cyclone basin is found |
| CInvalidStormInfoLine | This exception is raised when the StormInfo class receives an invalid tcvitals line or ATCF line that it cannot parse |
| CInvalidVitals | Raised when a syntax error is found in the tcvitals, and the code cannot guess what the operator intended |
| CNoSuchVitals | This should be raised when the user requests a specific storm or cycle of a storm and no such vitals exists |
| CStormInfo | Storm vitals information from ATCF, B-deck, tcvitals or message files |
| CStormInfoError | This is the base class of all exceptions raised when errors are found in the tcvitals, Best Track, Aid Deck or other storm information databases |
| ►Ntracker | This module contains tasks to prepare input for the GFDL Vortex Tracker, run the tracker and deliver its results |
| CCleanATCFSubsetProduct | A FileProduct that delivers a subset of a track |
| CGRIB1VintTave | A GRIB1Op that runs vint and tave: two of the tracker prep programs |
| CRawATCFProduct | A FileProduct for tracker output |
| CTrackerTask | This task runs the GFDL Vortex Tracker on HWRF output |
| CTrackerView | This Task is used by the delivery script executed by the gettrk program itself |
| ►Nwps | This module contains Tasks to run the WRF Preprocessing System (WPS): Geogrid, Ungrib and Metgrid |
| CGeogrid | This is a HWRF task that pre processes the geogrid to define the model domains and interpolates static geographical data to the grids |
| CMetgrid | This is a HWRF task that horizontally interpolates the meteorological fields extracted by ungrib to the model grids defined by geogrid |
| CUngrib | This is a HWRF task that extracts the meteorological fields from GRIB formatted files and write the fields to intermediate files |
| CWPSTask | This subclass of HWRFTask represents a WPS Task |
| ►Nwrf | Create namelists, monitor wrf simulations, generate filenames |
| CExternalWRFTask | Monitors a running wrf simulation |
| CWRFDomain | A domain in a WRF simulation |
| CWRFSimulation | Generate and manipulate wrf namelists, predict output filenames |
| ►Nwrfbase | Low-level wrf implementation, underlying hwrf.wrf |
| CWRFDomainBase | Superclass of WRFDomain |
| CWRFDomains | Abstract base class of WRFSimulation |
| CWRFOutput | A class that provides information about WRF output and input files |
| ►Nww3 | |
| CWRFCoupledWW3 | |
| CWRFWW3POM | |
| CWW3Init | |
| CWW3Initer | |
| CWW3Post | |
| ▼Nhwrf_alerts | This module contains the track delivery function and all dbn alerts in the HWRF system |
| CTrackDeliveryFailed | Raised when the send_nhc_track() is unable to deliver the track file |
| ▼Nhwrf_scrub | |
| CDeleter | Recursive directory deleter with safeguards to prevent accidental deletion of certain critical directories |
| CWillNotDelete | Raised by various safety checks if someone tries to delete something they should not, such as "/" |
| ▼Npom | Runs the MPI Princeton Ocean Model for Tropical Cyclones (MPIPOMTC) ocean model initialization |
| ►Nexceptions | This module contains exception classes for reporting errors in the POM initialization |
| CPOMConfigError | Raised when an impossible configuration is requested, such as an unsupported tropical basin |
| CPOMException | The base class of all exceptions relating to the POM |
| CPOMInitFailed | Raised when a POM initialization program unexpectedly fails |
| CPOMInputError | Raised when a required input or input directory did not exist |
| CPOMPrepError | Raised when the POM prep fails |
| CPOMSSTError | Raised when the init has trouble extracting SSTs |
| CPOMUnsupportedBasin | Raised when an unsupported basin is requested |
| ►Ninit | POM preprocessing and spinup scripts |
| Cfbtr | Runs the FBTR (feature-based) initialization of the MPIPOMTC |
| Cg3 | Runs the G3 initialization for POM |
| CHwrf | Abstract base class that stores data relating to the HWRF workflow in which the POM initialization resides |
| Cna | Runs the na (NCODA) initialization of POM |
| COceanini | Parent class of POM initialization classes |
| Cpget | Utility class for obtaining input data |
| Cphase | Runs a later phase of the ocean init to add additional features such as cold wakes |
| Cprun | Utility class for executing ocean initialization setrun functions |
| Cpsend | Utility class for delivering Oceanini output |
| ►Nnml | Generates the POM namelist |
| Cnml | Class that generates the namelist for POM |
| ►Nutil | Utility scripts for the pom package |
| Ccounter | A simple integer counter class |
| ▼Nprodutil | Platform-independent weather and ocean forecasting utility package |
| ►Nacl | Manipulates Access Control Lists (ACL) |
| CACL | ACL class wrapped around the libacl library: |
| CACLCannotGet | Raised when the libacl library could not get a file's ACL |
| CACLCannotSet | Raised when the libacl library could not set a file's ACL |
| CACLCannotStringify | Raised when libacl cannot convert an ACL to text |
| CACLError | Superclass of any ACL errors |
| CACLLibraryError | Raised when the libacl library could not be loaded |
| CACLMissingError | Raised when a function that requires an ACL object received None, or an invalid ACL |
| ►Natparse | ATParser is a text parser that replaces strings with variables and function output |
| CATParser | Takes input files or other data, and replaces certain strings with variables or functions |
| CNoSuchVariable | Raised when a script requests an unknown variable |
| CParserSyntaxError | Raised when the parser encounters a syntax error |
| CScriptAbort | Raised when an "@** abort" directive is reached in a script |
| CScriptAssertion | Raised when a script @[VARNAME:?message] is encountered, and the variable does not exist |
| ►Nbatchsystem | Provides information about the batch system |
| CFakeClass | A special class for constants |
| ►Ncd | Change directory, handle temporary directories |
| CNamedDir | This subclass of TempDir takes a directory name, instead of generating one automatically |
| CTempDir | This class is intended to be used with the Python "with TempDir() as t" syntax |
| ►Ncluster | Provides information about the cluster on which this job is running |
| CCluster | Stores information about a computer cluster |
| CNOAAGAEA | Represents the NOAA GAEA cluster |
| CNOAAJet | The NOAA Jet Cluster |
| CNOAATheia | |
| CNOAAWCOSS | Represents the NOAA WCOSS clusters, Tide, Gyre and the test system Eddy |
| CNOAAZeus | Represents the NOAA Zeus cluster |
| CUCARYellowstone | Represents the Yellowstone cluster |
| CWCOSSCray | This subclass of NOAAWCOSS handles the new Cray portions of WCOSS |
| CWisconsinS4 | Represents the S4 cluster |
| ►Ndatastore | Stores products and tasks in an sqlite3 database file |
| CCallbackExceptions | Exception raised when a Product class encounters exceptions while calling its callback functions in Product.call_callbacks |
| CDatastore | Stores information about Datum objects in a database |
| CDatum | Superclass of anything that can be stored in a Datastore |
| CDatumException | Superclass of all exceptions local to produtil.datastore |
| CDatumLockHeld | Raised when a LockDatum is held by another Worker |
| CFakeException | This is a fake exception used to get a stack trace |
| CFileProduct | A subclass of Product that represents file delivery |
| CInvalidID | Raised when a Datum or subclass receives a prodname or category name that is invalid |
| CInvalidOperation | Raised when an invalid Datum operation is requested, such as delivering an UpstreamProduct |
| CProduct | A piece of data produced by a Task |
| CTask | Represents a process or actor that makes a Product |
| CTransaction | Datastore transaction support |
| CUnknownLocation | Raised when delivering data, but no location is provided |
| CUpstreamFile | Represents a Product created by an external workflow |
| ►Ndbnalert | This module runs the NCO dbn_alert program, or logs dbn_alert messages if run with dbn alerts disabled |
| CDBNAlert | This class represents a call to dbn_alert, as a callable Python object |
| ►Nfileop | This module provides a set of utility functions to do filesystem operations |
| CCannotFindExe | Thrown when find_exe cannot find an executable in the path or directory list |
| CCannotLinkMulti | This exception is raised when the caller tries to create multiple symlinks in a single target, but the target is not a directory |
| CDeliveryFailed | This exception is raised when a file cannot be delivered |
| CFileOpError | This is the superclass of several exceptions relating to multi-file operations in produtil.fileop |
| CFileOpErrors | This exception is raised when an operation that processes multiple files catches more than one exception |
| CFileWaiter | A class that waits for files to meet some requirements |
| CFindExeInvalidExeName | Thrown when find_exe is given an executable name that contains a directory path |
| CInvalidExecutable | Thrown when a find_exe fails |
| CRelativePathError | Raised when a relative path is given, but an absolute path is expected |
| CUnexpectedAbsolutePath | This exception indicates that the renamer function sent to make_symlinks_in returned an absolute path |
| CVerificationFailed | This exception is raised when a copy of a file has different content than the original |
| CWrongSymlink | Raised when os.symlink makes a symlink to a target other than the one that was requested |
| ►Nlisting | Contains the Listing class, which emulates "ls -l" |
| CListing | Imitates the shell "ls -l" program |
| ►Nlocking | Handles file locking using Python "with" blocks |
| CLockFile | Automates locking of a lockfile |
| CLockHeld | This exception is raised when a LockFile cannot lock a file because another process or thread has locked it already |
| CLockingDisabled | This exception is raised when a thread attempts to acquire a lock while Python is exiting according to produtil.sigsafety |
| ►Nlog | Configures logging |
| CJLogFormatter | This subclass of MasterLogFormatter does not include exception information in the log file |
| CJLogHandler | Custom LogHandler for the jlogfile |
| CMasterLogFormatter | This is a custom log formatter that inserts the thread or process (logthread) that generated the log message |
| CMasterLogHandler | Custom LogHandler for the master process of a multi-process job |
| CThreadLogger | Custom logging.Logger that inserts thread information |
| ►Nmpi_impl | Converts a group of MPI ranks to a runnable command |
| ►Nlsf_cray_intel | Adds support for LSF+aprun with the Intel OpenMP to produtil.run |
| CSyncer | Calls sync and aprun -B sync |
| ►Nmpi_impl_base | Utilities like CMDFGen to simplify adding new MPI implementations to the produtil.run suite of modules |
| CCMDFGen | Generates files with one line per MPI rank, telling what program to run on each rank |
| CMPIAllRanksError | Raised when the allranks=True keyword is sent to mpirun or mpirunner, but the MPI program specification has more than one rank |
| CMPIConfigError | Base class of MPI configuration exceptions |
| CMPIDisabled | Thrown to MPI is not supported |
| CMPIMixed | Thrown to indicate serial and parallel processes are being mixed in a single mpi_comm_world |
| CMPISerialMissing | Raised when the mpiserial program is required, but is missing |
| COpenMPDisabled | Raised when OpenMP is not supported by the present implementation |
| CWrongMPI | Unused: raised when the wrong MPI implementation is accessed |
| ►Nmpiprog | Object structure for describing MPI programs |
| CComplexProgInput | Raised when something that cannot be expressed as a pure MPI rank is given as a pure MPI rank |
| CInputsNotStrings | Raised when the validation scripts were expecting string arguments or string executable names, but something else was found |
| CMPIProgSyntaxError | Base class of syntax errors in MPI program specifications |
| CMPIRank | Represents a single MPI rank |
| CMPIRanksBase | This is the abstract superclass of all classes that represent one or more MPI ranks, including MPI ranks that are actually serial programs |
| CMPIRanksMPMD | Represents a group of MPI programs, each of which have some number of ranks assigned |
| CMPIRanksSPMD | Represents one MPI program duplicated across many ranks |
| CMPISerial | Represents a single rank of an MPI program that is actually running a serial program |
| CNotMPIProg | Raised when an MPI program was expected but something else was given |
| CNotSerialProg | Raised when a serial program was expected, but something else was given |
| ►Npipeline | Internal module that launches and monitors processes |
| CConstant | A class used to implement named constants |
| CNoMoreProcesses | Raised when the produtil.sigsafety package catches a fatal signal |
| CPipeline | This class is a wrapper around launch and manage |
| ►Nprog | Implements the produtil.run: provides the object tree for representing shell commands |
| CEqualInEnv | Raised when converting a Runner or pipeline of Runners to a POSIX sh string if there is an equal ("=") sign in an environment variable name |
| CEqualInExecutable | Raised when converting a Runner or pipeline of Runners to a posix sh string if a Runner's executable contains an equal ("=") sign |
| CFileOpener | This is part of the internal implementation of Runner, used to convert it to a produtil.pipeline.Pipeline for execution |
| CImmutableRunner | An copy-on-write version of Runner |
| CInvalidPipeline | Raised when the caller specifies an invalid input or output when piping a Runner into or out of another object |
| CMultipleStderr | Raised when the caller specifies more than one destination for a Runner's stderr |
| CMultipleStdin | Raised when the caller specifies more than one source for the stdin of a Runner |
| CMultipleStdout | Raised when the caller specifies more than one destination for a Runner's stdout |
| CNoSuchRedirection | Raised when trying to convert a pipeline of Runners to a POSIX sh string, if a redirection in the pipeline cannot be expressed in POSIX sh |
| CNotValidPosixSh | Base class of exceptions that are raised when converting a Runner or pipeline of Runners to a POSIX sh command, if the Runner cannot be expressed as POSIX sh |
| CNotValidPosixShString | Raised when converting a Runner or pipeline of Runners to a POSIX sh string |
| COutIsError | Instructs a Runner to send stderr to stdout |
| COverspecifiedStream | Raised when one tries to specify the stdout, stderr or stdin to go to, or come from, more than one location |
| CProgSyntaxError | Base class of exceptions raised when a Runner is given arguments that make no sense |
| CRunner | Represents a single stage of a pipeline to execute |
| CStreamGenerator | This is part of the internal implementation of Runner, and is used to convert it to a produtil.pipeline.Pipeline for execution |
| CStreamReuser | Arranges for a stream-like object to be sent to the stdout, stderr or stdin of a Runner |
| CStringInput | Represents sending a string to a process's stdin |
| ►Nrstprod | Handles data restriction classes |
| CRestrictionClass | This is a python class intended to be used to automate restricting data to a specific restriction class using access control lists or group ownership |
| CRstBadGroup | Raised when a group's id or name could not be determined |
| CRstNoAccessControl | Raised when the cluster has no access control mechanisms |
| CRstprodError | The base class of all exceptions specific to the rstprod module |
| ►Nrun | A shell-like syntax for running serial, MPI and OpenMP programs |
| CExitStatusException | Raised to indicate that a program generated an invalid return code |
| CInvalidRunArgument | Raised to indicate that an invalid argument was sent into one of the run module functions |
| ►Nrusage | This module allows querying resource usage and limits, as well as setting resource limits |
| CRLimit | Gets the resource limits set on this process: core, cpu, fsize, data, stack, rss, nproc, nofile, memlock, aspace Each is set to a tuple containing the soft and hard limit |
| CRUsage | Contains resource usage (rusage) information that can be used with a Python "with" construct to collect the resources utilized by a block of code, or group of subprocesses executing during that block |
| CRUsageReport | Raised when caller makes an RUsage, and tries to generate its report, before calling its enter or exit routines |
| ►Nsigsafety | Sets up signal handlers to ensure a clean exit |
| CCaughtSignal | Base class of the exceptions thrown when a signal is caught |
| CFatalSignal | Raised when a fatal signal is caught, as defined by the call to install_handlers |
| CHangupSignal | With the default settings to install_handlers, this is raised when a SIGHUP is caught |
| ►Nworkpool | Contains the WorkPool class, which maintains pools of threads that perform small tasks |
| CWorkPool | A pool of threads that perform some list of tasks |
| CWorkTask | Stores a piece of work |
| CWrongThread | Raised when a thread unrelated to a WorkPool attempts to interact with the WorkPool |
| ▼Nscripts | High-level logic of the HWRF Python scripts |
| ►Nexhwrf_output | Delivers data to the COM directory or elsewhere |
| CDeliverer | A utility class for delivering files |
| ▼Nsetup_hurricane | |
| CStormCurses | This class implements a user interface for selecting which storms GFDL and HWRF should run |
| ▼Nush | Utility scripts for testing and workflow management |
1.8.10
