Skip to content

Commit 5d4d3c0

Browse files
committed
update readme
1 parent 09119ad commit 5d4d3c0

File tree

1 file changed

+24
-12
lines changed

1 file changed

+24
-12
lines changed

README.md

+24-12
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,15 @@ TimML is coded in Python and uses numba to speed up evaluation of the bessel lin
1818

1919
**Python versions:**
2020

21-
TimML requires **Python** >= 3.7 and can be installed from PyPI.
21+
TimML requires Python >= 3.8 and can be installed from PyPI.
2222

2323
**Dependencies:**
2424

25-
TimML requires **numpy** >=1.17, **scipy** >=1.5 and **matplotlib** >=3.1, **numba>=0.5**.
25+
TimML requires:
26+
* numpy
27+
* scipy
28+
* matplotlib
29+
* numba
2630

2731
**Installation:**
2832

@@ -44,16 +48,24 @@ To uninstall TimML type:
4448
* The documentation is hosted on [readthedocs](https://timml.readthedocs.io/).
4549
* Example Notebooks are available from the notebooks directory on github, of from [here](https://github.com/mbakker7/timml/tree/master/notebooks).
4650

47-
## TimML Version 6
48-
49-
TimML version 6 has the same functionality as version 5, but doesn't depend on a fortran extension anymore, so installation is easy on all platforms.
50-
TimML version 5 is a total rewrite and is not backwards compatible with previous TimML versions.
51-
TimML version 5 is intended to be compatible with TTim.
52-
TimML version 5 has many new features and elements, the code base is Python 3, and the object oriented design is much simpler.
53-
TimML version 4 remains available through the timml4 branch.
54-
55-
## Release
56-
TimML 6.0. First release that depends on numba and doesn't depend on fortran extension anymore. Code is now pure python (with numba for speed).
51+
## Latest release
52+
TimML 0.6.5
53+
* Improved documentation: new look, better organization, tutorials, how-to guides etc. Check it out [here](https://timml.readthedocs.io/)!
54+
* New elements
55+
* Building pit elements for 3D (multi-layer single aquifer) models.
56+
* Large diamater wells (only for radial flow).
57+
* Enhancements
58+
* Building pit leaky wall resistance can be set per layer and per side (for modeling leaks or gaps).
59+
* Return integrated normal flux per layer and per line segment.
60+
61+
## TimML Versions
62+
63+
* TimML version 0.6 has the same functionality as version 5, but doesn't depend on a fortran extension anymore, so installation is easy on all platforms.
64+
* TimML version 0.5
65+
* is a total rewrite and is not backwards compatible with previous TimML versions.
66+
* is intended to be compatible with TTim.
67+
* has many new features and elements, the code base is Python 3, and the object oriented design is much simpler.
68+
* TimML version 0.4 remains available through the timml4 branch.
5769

5870
## Citation
5971

0 commit comments

Comments
 (0)