PyTOUGH (Python TOUGH) is a Python library for simplifying, extending and automating the use of the TOUGH2 subsurface fluid and heat flow simulator. Using PyTOUGH, it is possible to automate the creation and editing of TOUGH2 model grids and data files, and the analysis and display of model simulation results, using Python scripts.
First, make sure you have Python and the Numerical Python library installed on your machine. (For some features you will need other libraries such as Scientific Python or Matplotlib- consult the user guide for details.)
Click the Clone or download button at the right of the PyTOUGH web page and then click Download ZIP , and save the .zip file to your computer. Unzip this to any directory on your computer. This will create a directory containing a file called setup.py. At the command line type python setup.py install.
(Alternatively, if you are confident using the Git version control system, you can clone the PyTOUGH repository instead of downloading a .zip file.)
For more detailed information on PyTOUGH, consult the user guide (PDF format, in the 'doc' directory of your PyTOUGH install) and the PyTOUGH wiki, which has links to published articles on PyTOUGH.
The latest stable version is 1.5.2, which has:
- fixes to accommodate more TOUGH2 and TOUGHREACT variants
- further Python 3 compatibility fixes
- new mulgrid snap_columns_to_nearest_layers() method
- new coordinate optional parameter in mulgrid line_plot() method
- new t2data json() method
- new t2data effective_incons() method
as well as various bug fixes and other minor enhancements.
Since PyTOUGH version 1.3.6, the PyTOUGH user guide (PyTOUGH-guide.pdf) is now included in the 'doc' directory of your PyTOUGH install. Previously this was available separately from the 'Downloads' section on the website, but GitHub decided to phase out this 'Downloads' section.