Merge pull request #41 from tldr-group/release/v0.1.4

Release/v0.1.4

.gitignore

@@ -108,3 +108,5 @@ ENV/
 /xy_352_rep_49.tif.npy
 /precision_tests.py
 /PeriodicVerticalMirror.tif
+
+temp

HISTORY.rst

@@ -1,28 +1,34 @@
 =======
 History
 =======
+------------------
+0.1.4 (2022-07-11)
+------------------
+
+* Add TauE solver
+* Add triple phase boundary calculations
+* Fix cuboids not converging
+* Fix convergence messaging
+
+------------------
 0.1.3 (2021-03-25)
 ------------------
 
 * Hotfix code in taufactor.py
 
 ------------------
-
 0.1.2 (2021-03-25)
 ------------------
 
 * Added multi-phase and periodic solvers and metrics calculations
 
 ------------------
-
-
 0.1.1 (2021-02-10)
 ------------------
 
 * Removed CuPy from requirements and added installation instructions to README
 
 ------------------
-
 0.1.0 (2021-02-08)
 ------------------
 

docs/Usage.md

@@ -72,6 +72,22 @@ s = tau.MultiPhaseSolver(img, cond=cond, iter_limit=1000)
 s.solve()
 ```
 
+### Electrode tortuosity factor solver
+
+This solver implements the electrode tortuosity method from [Nguyen _et al._](https://doi.org/10.1038/s41524-020-00386-4)
+
+```
+import taufactor as tau
+
+# load n phase segmented image
+img = tifffile.imread('path/filename')
+
+# create an electrode solver object and set an iteration limit
+s = tau.ElectrodeSolver(img)
+# call solve function
+s.solve()
+```
+
 ## Metrics
 
 Metrics can be calculated using the metrics module

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.3
+current_version = 0.1.4
 commit = True
 tag = True
 

setup.py

@@ -43,6 +43,6 @@
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/tldr-group/taufactor',
-    version='0.1.3',
+    version='0.1.4',
     zip_safe=False,
 )

taufactor/__init__.py

@@ -2,6 +2,6 @@
 
 __author__ = """Isaac Squires"""
 __email__ = '[email protected]'
-__version__ = '0.1.3'
+__version__ = '0.1.4'
 
 from .taufactor import *