Skip to content

TauFactor is a parallelised solver for calculating tortuosity factors from voxel data.

License

Notifications You must be signed in to change notification settings

tldr-group/taufactor

Repository files navigation

TauFactor

TauFactor is an application for calculating tortuosity factors from tomographic data.

TauFactor

PyPI ReadTheDocs MIT LICENSE github actions

Requirements

Before installing taufactor, download the most recent version of PyTorch.

Quickstart

To install TauFactor via PyPI

pip install taufactor

To extract effective diffusivity and tortuosity factor from your data:

import taufactor as tau

# load image
img = tifffile.imread('path/filename')
# ensure 1s for conductive phase and 0s otherwise.

# create a solver object with loaded image
s = tau.Solver(img)

# call solve function
s.solve()

# view effective diffusivity and tau
print(s.D_eff, s.tau)

# plot steady state maps
s.flux_map()
s.conc_map()

Tests

To run unit tests navigate to the root directory and run

pytest

Credits

This package was created by the tldr group at the Dyson School of Design Engineering, Imperial College London.