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.
3 maintainers
Metadata
3 maintainers
Release files for taufactor 1.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| taufactor-1.2.1.tar.gz | 633.7 kB | Without provenance | Details for taufactor-1.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| taufactor-1.2.1-py3-none-any.whl | Python 3 | none | any | Details for taufactor-1.2.1-py3-none-any.whl |
Total release size: 654.7 kB
Release files / taufactor-1.2.1.tar.gz
| Download URL | taufactor-1.2.1.tar.gz |
|---|---|
| Size | 633.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
63161f6f07f347f4d7fa32b79fc4843b4163ae314fa2851913076c8e907334e6
|
|
BLAKE2b-256 checksum How to use checksums |
ee20d6ffc875628a7e90d4a66bdca6a516ce086d873d01b6ed81b0cd63ac73be
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.18
|
Release files / taufactor-1.2.1-py3-none-any.whl
| Download URL | taufactor-1.2.1-py3-none-any.whl |
|---|---|
| Size | 21.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b9bdd3aaa340e4bdf7659ce004c707c91020aedd2299b7fb491053be9139fde7
|
|
BLAKE2b-256 checksum How to use checksums |
c64097de620e4304b5fd763b346bbccd49376894e234226f60aa5c13da76c28c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.18
|
Security for taufactor 1.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
