tfv documentation

tfv is a suite of tools for post-processing results from TUFLOW FV, a 1D, 2D and 3D hydrodynamic, sediment transport, water quality and particle tracking modelling software.

The purpose of this page is to serve as the tfv package API Reference. Also provided are links to tutorials and example datasets.


The tfv package is available via the Python Package Index PyPi and Conda Forge.

To install tfv from the conda command line tool:

$ conda install -c conda-forge tfv

Alternatively to install tfv using pip:

$ python -m pip install tfv

*Note: Version 1.0.5 has been built and tested on Python 3.9 to 3.11.

Getting Started

For tips on the setup of Python and tfv, including tutorials and examples please refer to the TUFLOW FV Python Toolbox Wiki Page.

API Reference

Class reference documentation


Tutorial and example notebooks


For help with the tfv package contact