Data

Tools

Indexes

Applications

Experiments

Open Source Science

TauFactor 2

TauFactor 2: A GPU accelerated python tool for microstructural analysis - Published in JOSS (2023)

https://github.com/tldr-group/taufactor

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org
  • ✓
    Committers with academic emails
    3 of 6 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Mathematics Computer Science - 63% confidence
Last synced: 6 months ago · JSON representation

Repository

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

Basic Info
  • Host: GitHub
  • Owner: tldr-group
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 6.17 MB
Statistics
  • Stars: 31
  • Watchers: 0
  • Forks: 6
  • Open Issues: 3
  • Releases: 7
Created about 5 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog Contributing License Authors

README.md

TauFactor

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

TauFactor

DOI badge PyPI ReadTheDocs MIT LICENSE github actions

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:

```python 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.

Owner

  • Name: tldr group
  • Login: tldr-group
  • Kind: organization
  • Location: United Kingdom

The Tools for Learning, Design and Research (tldr) group is a multidisciplinary team based in the Dyson school of Design engineering at Imperial College London.

JOSS Publication

TauFactor 2: A GPU accelerated python tool for microstructural analysis
Published
August 09, 2023
DOI
Volume 8, Issue 88, Page 5358
Authors
Steve Kench ORCID
Imperial College London, United Kingdom
Isaac Squires ORCID
Imperial College London, United Kingdom
Samuel Cooper ORCID
Imperial College London, United Kingdom
Editor
Bonan Zhu ORCID
Tags
Material Science Tortuosity Modelling Effective diffusivity Bruggeman coefficient
View PDF Review Thread Software Archive

GitHub Events

Total
  • Create event: 5
  • Release event: 1
  • Issues event: 7
  • Watch event: 2
  • Delete event: 3
  • Issue comment event: 6
  • Push event: 11
  • Pull request review event: 8
  • Pull request review comment event: 4
  • Pull request event: 20
  • Fork event: 1
Last Year
  • Create event: 5
  • Release event: 1
  • Issues event: 7
  • Watch event: 2
  • Delete event: 3
  • Issue comment event: 6
  • Push event: 11
  • Pull request review event: 8
  • Pull request review comment event: 4
  • Pull request event: 20
  • Fork event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 203
  • Total Committers: 6
  • Avg Commits per committer: 33.833
  • Development Distribution Score (DDS): 0.488
Past Year
  • Commits: 34
  • Committers: 2
  • Avg Commits per committer: 17.0
  • Development Distribution Score (DDS): 0.206
Top Committers
Name Email Commits
isaacsquires i****s@m****m 104
sk3619 s****9@i****k 51
daubners s****r@i****k 27
amirDahari1 a****i@m****l 19
stke9 5****9 1
Juanjo Bazán j****n@g****m 1
Committer Domains (Top 20 + Academic)
mail.huji.ac.il: 1 imperial.ac.uk: 1 ic.ac.uk: 1 me.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 40
  • Total pull requests: 82
  • Average time to close issues: 5 months
  • Average time to close pull requests: 11 days
  • Total issue authors: 15
  • Total pull request authors: 6
  • Average comments per issue: 1.48
  • Average comments per pull request: 0.09
  • Merged pull requests: 75
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 20
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 17
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • isaacsquires (8)
  • ma-sadeghi (7)
  • amirDahari1 (6)
  • alexsquires (3)
  • LDXu93 (2)
  • therob84 (2)
  • pcmkible (2)
  • camsooper (2)
  • igennart (1)
  • Yugal0 (1)
  • oarcelus (1)
  • stke9 (1)
  • slieblappen (1)
  • isaacbasil (1)
  • pandego (1)
Pull Request Authors
  • isaacsquires (46)
  • amirDahari1 (18)
  • daubners (14)
  • stke9 (6)
  • isaacbasil (1)
  • xuanxu (1)
Top Labels
Issue Labels
good first issue (2)
Pull Request Labels
bug (2) enhancement (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 544 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 8
  • Total maintainers: 3
pypi.org: taufactor

TauFactor is an application for calculating tortuosity factors from tomographic data

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 544 Last month
Rankings
Dependent packages count: 10.0%
Stargazers count: 13.1%
Forks count: 14.2%
Downloads: 24.8%
Average: 26.0%
Dependent repos count: 67.7%
Maintainers (3)
isaacsquires stevekench amirDahari1
Last synced: 6 months ago

Dependencies

docs/requirements.txt pypi
  • cupy *
  • m2r2 *
  • matplotlib *
  • numpy *
  • scipy *
requirements_dev.txt pypi
  • Click ==7.0 development
  • Sphinx ==3.4.3 development
  • bump2version ==1.0.1 development
  • coverage ==5.4 development
  • flake8 ==3.7.8 development
  • matplotlib ==4.3.3 development
  • pip ==21.0.1 development
  • pytest ==4.6.5 development
  • pytest-runner ==5.2 development
  • tox ==3.21.4 development
  • twine ==3.3.0 development
  • watchdog ==0.9.0 development
  • wheel ==0.33.6 development