Metadata-Version: 2.1
Name: pygsflow
Version: 1.0.1
Summary: pyGSFLOW is a python package to create, run, and post-process GSFLOW-based models
Home-page: https://github.com/pygsflow/pygsflow
Author: Ayman Alzraiee, Joshua Larsen, Rich Niswonger
Author-email: aalzraiee@usgs.gov, jlarsen@usgs.gov, rniswon@usgs.gov
License: MIT license
Keywords: gsflow
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering :: Hydrology
Classifier: Operating System :: OS Independent
Requires-Python: >=3.4
Description-Content-Type: text/markdown
License-File: LICENCE.md
License-File: LICENSE

<p align="center">
  <img src="https://raw.githubusercontent.com/pygsflow/pygsflow/master/examples/figures/motto2.PNG" alt="pyGSFLOW logo"/>
</p>

[![pygsflow continuous integration](https://github.com/pygsflow/pygsflow/actions/workflows/ci.yml/badge.svg)](https://github.com/pygsflow/pygsflow/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/pygsflow/pygsflow/branch/master/graph/badge.svg?token=UC4KRJAHUS)](https://codecov.io/gh/pygsflow/pygsflow)
# pygsflow
pyGSFLOW is a python package to Create, Read, Write, Edit, and Visualize GSFLOW models

## API Documentation
pyGSFLOW API documentation can be found @

https://pygsflow.github.io/pygsflowdocs/

## Examples
Ipython notebook example problems can be found in the examples directory.  
https://github.com/pygsflow/pygsflow/tree/master/examples

## Installation
The pygsflow repository can be installed using pip.
Open a command prompt or anaconda prompt terminal and type:

`pip install pygsflow`

or

`pip install https://github.com/pygsflow/pygsflow/zipball/master`

pygsflow is now installed

Alternatively the user can download a copy of the repository, open a command prompt or anaconda promt terminal, cd into the trunk directory and type:

`pip install . `

## Authors
Ayman Alzraiee, Joshua Larsen, Rich Niswonger

## How to Cite

[Larsen, J. D., Alzraiee, A., Niswonger, R., 2021, pyGSFLOW v1.0.0: U.S. Geological
Survey Software Release, 2 July 2021, https://doi.org/10.5066/P9NPZ5AD](https://doi.org/10.5066/P9NPZ5AD)

## Project History
This project is a refinement and continuation of the original pygsflow repository at:

https://github.com/aymanalz/pygsflow

## Disclaimer
This software has been approved for release by the U.S. Geological Survey 
(USGS). Although the software has been subjected to rigorous review, the USGS 
reserves the right to update the software as needed pursuant to further 
analysis and review. No warranty, expressed or implied, is made by the USGS or 
the U.S. Government as to the functionality of the software and related 
material nor shall the fact of release constitute any such warranty. 
Furthermore, the software is released on condition that neither the USGS nor 
the U.S. Government shall be held liable for any damages resulting from its 
authorized or unauthorized use.

