Metadata-Version: 2.1
Name: PyGeoStudio
Version: 0.3.0
Summary: Python library allowing reading/writing GeoStudio .gsz files
Home-page: https://github.com/MoiseRousseau/PyGeoStudio
Author: Moise Rousseau
Author-email: rousseau.moise@gmail.com
Project-URL: Bug Reports, https://github.com/MoiseRousseau/PyGeoStudio/issues
Project-URL: Source, https://github.com/MoiseRousseau/PyGeoStudio/
Project-URL: Documentation, https://pygeostudio.readthedocs.io/
Keywords: Geotechnics,Numerical Simulation,Hydrogeology,Optimization
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: plyfile
Requires-Dist: bs4
Requires-Dist: lxml
Requires-Dist: prettytable

# PyGeoStudio

Python library allowing reading/writing GeoStudio .gsz file. 
But, why do you need an external software such as Python to read your file while GeoStudio possess graphical tool to create your analysis and visualize your data ?

1. Automatise your numerical model processing without the need to export it in Excel
2. Harness the power of Python to treat your data
3. Make quality plots using [matplotlib](www.matplotlib.org)
4. Modify analysis without using the graphical interface
5. Program analysis (e.g. the same analysis but with different parameters)
6. Perform automatic calibration / optimisation
7. The idea you have in mind which is not included in the 6 before

## Use case (TODO)

* Scripting
* Statistical modelling / Sensitivity analysis
* Automatic calibration
* Design optimization
* Real-time forecast and predictive modelling
* Model converger
* Post-processing (Paraview, Matplotlib)

## Installation

1. Clone or download this repository

2. Go into the (extracted) folder and run `pip install .`

## Examples

One example is provided in the folder `example`. 
It contains the `rapid_drawdown` tutorial problem found on GeoStudio website.
In this example, `PyGeoStudio` is used to plot the overall problem and to plot the evolution of the pore wwater pressure at a given point. 

## Roadmap

* Improve reading
* Implement writing (to modify the input file)
* Solve analysis directly in Python
* Loop over input - solve - output to allow optimization
* Other examples

## Contributing

Every contribution is welcome!
Note this is a brand new project for me, and that I develop the library based on my need.
If you have a particular problem with GeoStudio you want to solve with Python, just let me know, and I would figure out what I can do to help you.

If you like this project, please star it! 
It will encourage me to pursuit its development.


