Python Module Index

a | c | d | e | f | g | h | i | k | l | m | n | p | s | t | u | v | w
 
a
AutoPlotHazard Plot hazard maps and curves for locations within the simulation domain.
 
c
CalcFrequency Calculate annual genesis frequency of TCs within the track generation domain.
CalcTrackDomain Determine track generator domain, ensuring it encompasses all tracks entering the windfield generator domain.
colours Create customised colour maps that are more palatable and/or suitable for plotting data. To access the additional colour maps, simply import this module, then call pyplot.get_cmap(<new_cmap_name>) to get the new colour map. See the matplotlib examples pages for more details: http://matplotlib.org/examples/pylab_examples/custom_cmap.html
columns Load csv formatted data into a numpy array
config Provides functions for manipulating configuration files e.g. reading setting from a configuration file.
convolve Convolve two 2-d fields to apply a smoother (e.g. directional filtering, gaussian smoother).
curves provide methods to plot curves (hazard curves, distributions, logarithmic axes, etc).
 
d
DataProcess Processes the database of historical TCs into suitably formatted text files.
    DataProcess.CalcFrequency
    DataProcess.CalcTrackDomain
    DataProcess.DataProcess
 
e
Evaluate Provide some evaluation methods for testing the track generation model.
    Evaluate.interpolateTracks
    Evaluate.landfallRates
    Evaluate.longitudeCrossing
    Evaluate.pressureDistribution
    Evaluate.trackDensity
 
f
figures Basic figure elements for statistical and other plotting actions.
 
g
GenerateDistributions Generate CDFs for parameters for each grid cell in the model domain.
generateStats Calculates the mean, variance and autocorrelation statistics for all grid cells in the domain, for a given parameter.
grid Read, write and sample ascii grid files.
 
h
hazard
    hazard.evd
 
i
interp3d Interpolate data to a set of points in 3-d space.
interpTrack interpolate a TC track to a shorter time interval.
Intersections Functions to determine line intersections for polygons and line features.
 
k
KDEOrigin Kernel density estimation for genesis probability.
KDEParameters Generate KDEs of TC parameters.
 
l
LandfallRates Given a set of cyclone tracks and gates around the coastline, bin each coastal crossing into the gate corresponding to it's landfall location - then repeat for a set of synthetic events.
lat_long_UTM_conversion Convert from latitude-longitude coordinates to UTM coordinates.
lmomentFit Functions translated from the LMOMENTS Fortran package for fitting a GEV function.
loadData Load formatted csv file containing tropical cyclone track information
LongitudeCrossing Calculate the rate of TCs crossing lines of longitude and latitude, comparing historical and synthetic events.
 
m
maps Generate map images using `cartopy`
maputils Mapping functions.
metutils perform basic meteorological calculations.
 
n
nctools This modlue contains basic utilities for manipulating netCDF format files. It relies on the netCDF4 module (https://code.google.com/p/netcdf4-python/)
 
p
parallel Provides a couple of base functions that set up a parallel processing environment. There are only a small number of parallel processing functions required for TCRM, so we only need to ensure those functions are available, either as the real thing or, if the required modules are not available, dummy functions that pass straight through. We base our parallel processing on :term:`mpi4py`
pathLocator A function to determine the directory one level above the Utilities folder. Designed to work even if the code has been compiled with py2exe. This results in the modules being built-in to the interpreter, so the path of the executable is returned instead.
PlotInterface
    PlotInterface.AutoPlotHazard
    PlotInterface.curves
    PlotInterface.figures
    PlotInterface.maps
    PlotInterface.plotStats
    PlotInterface.plotTimeseries
    PlotInterface.timeseries
plotStats A collection of statistical plotting routines.
plotTimeseries Load timeseries data generated by TCRM and plot the wind speed, component wind speeds and bearing.
PressureDistribution calculate central pressure distributions based on historic and synthetic event sets
PressureInterface
    PressureInterface.pressureProfile
pressureProfile Returns the radial pressure field for a range of parametric radial wind models.
process Provides functions to control processing of files. The module records details of each file processed in a text file, which can then be looked up at a later time to determin if a file has previously been processed. It uses the MD5 checksum value of the file as the primary indicator of modifications to a file.
progressbar print a progress bar on to standard output.
 
s
SamplingOrigin Generate a sample of random TC origins from CDFs derived using kernel density estimation.
SamplingParamters Generate samples of TC parameters.
StatInterface
    StatInterface.GenerateDistributions
    StatInterface.generateStats
    StatInterface.KDEOrigin
    StatInterface.KDEParameters
    StatInterface.SamplingOrigin
    StatInterface.SamplingParameters
    StatInterface.StatInterface
stats Miscellaneous tools required for statistics-related classes.
 
t
tcevent Run the wind field module for a single TC track.
tcrm The main interface to TCRM. Determines which components of the model system to execute, based on the configuration settings specified.
template Read in a text file, with formatted elements and replace with strings.
tests
    tests.NumpyTestCase
    tests.pathLocate
    tests.run
    tests.test_evd
    tests.test_files
    tests.test_gridNC
    tests.test_interp3d
    tests.test_Intersections
    tests.test_KDEOrigin
    tests.test_loadData
    tests.test_nctools
    tests.test_TrackGenerator
    tests.test_windmodels
TrackDensity Calculate density of TC tracks over a grid (TCs/degree/year)
TrackGenerator
    TrackGenerator.TrackGenerator
    TrackGenerator.trackLandfall
tracks This module contains funcitons for reading/writing track data from/to csv and netCDF formats.
tracks2shp Writes track instances to a shape file as a collection of line, ployline or point features.
tsmultipliers Multiply the wind speed in a timeseries file by the appropriate multiplier values. Still a very rudimentary process.
 
u
Utilities
    Utilities.colours
    Utilities.columns
    Utilities.config
    Utilities.confjson
    Utilities.convolve
    Utilities.datasets
    Utilities.files
    Utilities.grid
    Utilities.interp3d
    Utilities.interpTrack
    Utilities.Intersections
    Utilities.lat_long_UTM_conversion
    Utilities.lmomentFit
    Utilities.loadData
    Utilities.maputils
    Utilities.metutils
    Utilities.nctools
    Utilities.parallel
    Utilities.pathLocator
    Utilities.process
    Utilities.progressbar
    Utilities.shptools
    Utilities.smooth
    Utilities.stats
    Utilities.tcrandom
    Utilities.template
    Utilities.timeseries
    Utilities.track
    Utilities.tracks2shp
    Utilities.tsmultipliers
    Utilities.version
    Utilities.vorticity
 
v
version Provide ways to determine the version of the currently executing code.
vmax Calculate maximum wind speed in a cyclone from the pressure deficit.
 
w
wind
    wind.vmax
    wind.windmodels