API

This page gives an overview of the public modules, classes, and functions within PyTUFLOW.

Control File Classes

TCF	Initialises the TCF class in a build state.
ECF	Initialises the ECF class in a build state.
TGC	Initialises the TGC class in a build state.
TBC	Initialises the TBC class in a build state.
TEF	Initialises the TEF class in a build state.
QCF	Initialises the QCF class in a build state.
TOC	Initialises the TOC class in a build state.
TRFC	Initialises the TRFC class in a build state.
TSCF	Initialises the TSCF class in a build state.
TESF	Initialises the TESF class in a build state.
TSCF	Initialises the TSCF class in a build state.
ADCF	Initialises the ADCF class in a build state.

Database Classes

BCDatabase	Database class for boundary conditions.
MatDatabase	Database class for material properties.
PitInletDatabase	Database class for pit inlet properties.
RainfallDatabase	Database class for rainfall values.
SoilDatabase	Database class for soil properties.
CrossSectionDatabase	Database class for storing cross-sections.

Input Classes

SettingInput	Input for Settings or Set commands.
FileInput	Class for handling inputs that reference files.
FolderInput	Represents a folder input command.
GisInput	Class for handling GIS inputs (Vector only).
GridInput	Class for handling GRID inputs.
TinInput	Class for handling TIN inputs.
ControlFileInput	Class for control files.Includes TRD, TEF
DatabaseInput	Input class for database inputs.
CommentInput	Input class for comment only lines.

Run State Classes

TCFRunState	Class for storing the run state of a TCF file.
TEFRunState	Class for storing the run state of the TEF file.
ControlFileRunState	Class for storing the run state of a control file.
DatabaseRunState	Class for storing the run state of a database.
BCDatabaseRunState	Class for storing the run state of a bc_dbase.csv.
MatDatabaseRunState	Class for storing the run state of a materials.csv file.
SoilDatabaseRunState	Class for storing the run state of a soil.tsoilf file.
CrossSectionRunState	Run state class for cross-sections database.
InputRunState	Class for storing the run state of an input.
GisInputRunState	Class for storing the run state of a GisInput.

Output Classes

XMDF	Class for handling XMDF output files.
TPC	Class to handle the standard TUFLOW Time Series result file (.tpc).
NCGrid	Class for reading netCDF grid outputs (NC) from TUFLOW, though any CF-compliant netCDF file should work.
NCMesh	Class for handling TUFLOW FV style output files.
CATCHJson	Class for handling TUFLOW CATCH JSON output files.
INFO	Class for reading TUFLOW info time series results (.info).
DAT	Class for handling DAT mesh file.
GPKG1D	Class for handling 1D GeoPackage time series results (.gpkg - typically ending with _1D.gpkg or _swmm_ts.gpkg).
GPKG2D	Class for handling 2D GeoPackage time series results (.gpkg - typically ending with _2D.gpkg).
GPKGRL	Class for handling RL GeoPackage time series results (.gpkg - typically ending with _RL.gpkg).
FMTS	Class for handling 1D Flood Modeller time series outputs.
FVBCTide	Class for FV BC Tide input time-series data.
HydTablesCheck	Class for reading the TUFLOW check file for 1D hydraulic tables.
BCTablesCheck	Class for reading 1D and 2D BC Table Check files.
CrossSections	Class for reading TUFLOW cross-section input layers.

Utilities

register_tuflow_binary	Register (save) a TUFLOW binary version path.
register_tuflow_binary_folder	Register a directory containing TUFLOW releases.
tuflow_binaries	Class for managing TUFLOW binary versions and paths.

Everything Else

TuflowBinaries	Class for managing TUFLOW binary versions and paths.
results.ResultTypeError	Raised when a result file does not contain the expected data.