TauFactor
TauFactor is an application for calculating tortuosity factors from tomographic data.
- Free software: MIT license
- Documentation: https://taufactor.readthedocs.io.
Requirements
Before installing taufactor, download the most recent version of PyTorch. Ensure you have pytorch>=1.10 installed in your Python environment.
For example, for a Linux machine with CUDA GPU
conda install pytorch pytorch-cuda=11.7 -c pytorch -c nvidia
Quickstart
To install TauFactor via PyPI
pip install taufactor
To extract effective diffusivity and tortuosity factor from your data:
import taufactor as tau
import tifffile
# 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)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.
TauFactor MATLAB
The package in this repository refers to a Python implementation of the TauFactor solver. There is a deprecated MATLAB implementation, which is no longer maintained.
