Readme¶

TauFactor¶

TauFactor is an application for calculating tortuosity factors from tomographic data. TauFactor uses CuPy which is an implementation of NumPy-compatible multi-dimensional array on CUDA.

Free software: MIT license
Documentation: https://taufactor.readthedocs.io.

TauFactor

Requirements¶

You will need an NVIDIA GPU to use this distribution of taufactor.
Before installing taufactor, download the most recent version of CuPy: https://docs.cupy.dev/en/stable/install.html

Quickstart¶

A basic example for taufactor:

import taufactor as tau

# load image
img = tifffile.imread('path/filename')
# ensure 1s for conductive phase and 0s otherwise.
# here we perform an example segmentation on a grayscale img
img[img > 0.7] = 1
img[img != 1] = 0
# create a solver object
s = tau.Solver(img)
# call solve function
s.solve()
# view effective diffusivity
D_eff = s.D_eff
# 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. This package was created with Cookiecutter* and the audreyr/cookiecutter-pypackage* project template.

Cookiecutter

``audreyr/cookiecutter-pypackage` <https://github.com/audreyr/cookiecutter-pypackage>`_