tfv documentation

tfv is the TUFLOW FV Python Toolbox used with TUFLOW’s flexible mesh hydrodynamic (1D, 2D and 3D), sediment transport, water quality and particle tracking modelling software TUFLOW FV.

The purpose of this page is to serve as the TUFLOW FV Python Toolbox API Reference and Examples Gallery of Jupyter notebooks.

Installation

Users are recommended to install tfv using a pre-configured tfv-workspace Conda environment. Step-by-step setup instructions are provided on the TUFLOW FV Python Toolbox Wiki Page. The wiki page includes a download package containing working copies of the examples gallery Jupyter notebooks.

Alternatively, the tfv package can be installed via the Python Package Index PyPi and Conda Forge.

To install tfv from the conda command line tool:

$ conda install -c conda-forge tfv

To install tfv using pip:

$ python -m pip install tfv

Version 1.0.11 has been built and tested on Python 3.9 to 3.13.

API Reference

Class reference documentation

• API Reference
  • Xarray Module
  • Extractor Module
  • Time Series Module
  • Visual Module
  • Viewer Module
  • Particles Module
  • Geometry Module

Examples Gallery

Tutorial and example notebooks

• Examples Gallery
  • Tutorial 1. TUFLOW FV Post-Processing Using Xarray
    • Loading Data
    • Some Common Use Examples
  • Tutorial 2. Introductory Matplotlib Plot Composition
    • Load Data
    • A Note on Looking at Results Quickly
    • Examples
  • Tutorial 3: Working With Gridded Boundary Condition Data
    • In Brief
    • Examples
  • Tutorial 4. Introduction to the Particle Tracking Module Tools
    • Loading data
    • Available Methods
    • Plotting
    • Analysing Results
  • Gallery 1: Timeseries Plots
    • Open TUFLOW FV Model Result
    • Extract Time Series Data
    • Plot Single Time Series
    • Trim the Time to Plot
    • Plot Time Series at Multiple Locations
    • Plot Time Series at All Locations
    • Plot Times Series at Multiple Depths and Save to Disk
    • Convert to Pandas Dataframe
    • Read TUFLOW FV CSV Point Using Pandas
    • Plot Temperature Time Series At Single Location Using The Column Name
    • Temperature Time Series Plot All Locations Using Filter
    • Temperature Time Series Plot Single Location Using Filters
    • Plot Velocity Magnitude and Direction At Single Location
    • Plot Velocity Magnitude and Direction At All Locations
    • Save Data At Specific Time
    • Plot Results On A Specific Day
    • Plot Results Over A Specific Time Range
    • Plot Results Over A Specific Time Range And Location
    • Combining TUFLOW FV XArray and Pandas
  • Gallery 2: Profile Plots
    • Open TUFLOW FV Model Result
    • Define Locations for Extraction
    • Extract Profile Data Directly from TUFLOW FV Xarray Accessor Object
    • Plot Profile
  • Gallery 3: Sheet Plots
    • Open TUFLOW FV Model Result
    • Single Sheet Plot
    • Sheet Plot With Vectors and Save to Disk
    • Sheet Plot at Different Depths
    • Save Sheet To ASCII Arc Grid
    • Extract Grid From Sheet And Output To GeoTiff
    • Multiple Sheet Plots
    • Impact Sheet Multiple Models
    • Extract Contours From Sheet
    • Plot Sheet Max
    • Save Max to asc
    • Save Sheet Plot Animation
    • Interactive Sheet Plot
  • Gallery 4: Curtain Plots
    • Open TUFLOW FV Model Result
    • Single Curtain Plot
    • Multiple Curtain Plots
    • Plot Interactive Curtain
  • Gallery 5: Combined Plots
    • Open TUFLOW FV Model Result
    • Plot Multiple Ways
  • Gallery 6: Particle Tracking Plots
    • Load Results
    • Scatter Plots
    • Grid Plots
  • Gallery 7: Miscellaneous
    • Open TUFLOW FV Model Result
    • Hovmoller Plot

Support

For help with the TUFLOW FV Python Toolbox contact support@tuflow.com