Skip to main content

Post processing tools for TUFLOW FV results

Project description

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.9 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]((https://fvwiki.tuflow.com/index.php?title=TUFLOW_FV_Python_Toolbox) includes working copies of the example tutorial and gallery notebooks. These notebooks can be previewed on the tfvreadthedocs Example Page. The API reference is provided via tfvreadthedocs.

For support contact TUFLOW Support.

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tfv-1.0.11.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

tfv-1.0.11-py3-none-any.whl (84.4 kB view details)

Uploaded Python 3

File details

Details for the file tfv-1.0.11.tar.gz.

File metadata

  • Download URL: tfv-1.0.11.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for tfv-1.0.11.tar.gz
Algorithm Hash digest
SHA256 791d12e9316a090872edc86c4d4018acb7107078a5fe68556644a42cc9df15f1
MD5 ca2f96d6514d8c6baab2658fed579775
BLAKE2b-256 d012b223f3edb2c908266b699bbc79b1d9f8d0779f041cd85927a0751f1c6436

See more details on using hashes here.

File details

Details for the file tfv-1.0.11-py3-none-any.whl.

File metadata

  • Download URL: tfv-1.0.11-py3-none-any.whl
  • Upload date:
  • Size: 84.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for tfv-1.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 bba236f16dc10a2c5cf193afcbfb76fc2bcbeedd8815f71a115c504f7814e37d
MD5 42750cfc37977b4e90c327570d264c1b
BLAKE2b-256 c970aafd5df77537fbddc7bc7ae64fdbd566bcbe617108ca2958371b18ed386a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page