TFV

tfv is the TUFLOW FV Python Toolbox for post-processing results from TUFLOW FV, TUFLOW's flexible mesh hydrodynamic (1D, 2D and 3D), sediment transport, water quality and particle tracking modelling software.

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.

Alternatively, the tfv package is available via the Python Package Index (PyPI) or 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

Note: The latest version has been built and tested on Python 3.10 to 3.13.

Dependencies

The tfv package depends on the following core packages:

    numpy>=1.24.0
    matplotlib>=3.7.0
    netCDF4>=1.6.3
    xarray>=2023.1.0
    dask>=2023.1.0
    scipy>=1.10.0
    tqdm>=4.65.0
    pyproj>=3.5.0
    geopandas>=0.13.0
    shapely>=2.0.0
    rioxarray>=0.13.0
    ipywidgets>=8.0.0
    ipympl>=0.9.0

These will be automatically installed or updated as part of the tfv installation.

Tutorials, Documentation & Support

The data download package available via the TUFLOW FV Python Toolbox Wiki Page includes working copies of the example tutorial and gallery notebooks. These notebooks can be previewed on the tfv Read the Docs example page. The API reference is provided via tfv Read the Docs.

For support contact TUFLOW Support.

Development and Release Workflow

For local development, testing, documentation builds, release publishing, and conda feedstock updates, see RELEASE.md.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Release files for tfv 1.0.16

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tfv 1.0.16
File	Size	Uploaded
tfv-1.0.16.tar.gz	2.3 MB	May 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for tfv 1.0.16
File	Interpreter	ABI	Platform	Reset
tfv-1.0.16-py3-none-any.whl 2.3 MB May 30, 2026	Python 3	none	any	Details

Total release size: 4.6 MB

Release files / tfv-1.0.16.tar.gz

Download URL	tfv-1.0.16.tar.gz
Size	2.3 MB
Tags	Source
SHA-256 checksum How to use checksums	`97575aa5165feff90349fa480baab2cc05230aa2dbc4f87a3517e130116bc711`
BLAKE2b-256 checksum How to use checksums	`49337c3ec57714c357fb9e9c23692ec47180a134fb70962d8bde055f7f9db60c`
Upload date	May 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.12.13`

Release files / tfv-1.0.16-py3-none-any.whl

Download URL	tfv-1.0.16-py3-none-any.whl
Size	2.3 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`dfe56f50fe21da3ddf19aa057a9fbf22605ce5d29cec05b99df0c4342f9dff50`
BLAKE2b-256 checksum How to use checksums	`4d93bcf9fccd32aca96e4627d49810003d668f9e6dc7986e79d921255428b633`
Upload date	May 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.12.13`