Metadata-Version: 2.1
Name: modflow-export
Version: 0.1.0
Summary: Fast & easy export of MODFLOW data to GIS file formats
Home-page: https://github.com/aleaf/modflow-export
Author: Andrew Leaf
Author-email: aleaf@usgs.gov
License: BSD (3-clause)
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Requires-Dist: pyyaml
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: gdal
Requires-Dist: fiona
Requires-Dist: rasterio
Requires-Dist: shapely
Requires-Dist: pyproj
Requires-Dist: flopy
Requires-Dist: gis-utils


modflow-export
-----------------------------------------------
Fast & easy summarizing of MODFLOW data and export to GIS file formats.

### Version 0.1
[![Build Status](https://travis-ci.com/aleaf/modflow-export.svg?branch=master)](https://travis-ci.com/aleaf/modflow-export.svg?branch=master)
[![Coverage Status](https://codecov.io/github/aleaf/modflow-export/coverage.svg?branch=master)](https://codecov.io/github/aleaf/modflow-export/coverage.svg?branch=master)
[![PyPI version](https://badge.fury.io/py/modflow-export.svg)](https://badge.fury.io/py/modflow-export)




Getting Started
-----------------------------------------------

[Example Notebook](Examples/modflow_nwt_example.ipynb)


### Bugs

If you think you have discovered a bug in modflow-export in which you feel that the program does not work as intended, then we ask you to submit a [Github issue](https://github.com/aleaf/modflow-export/labels/bug).


Installation
-----------------------------------------------

**Python versions:**

modflow-export requires **Python** 3.6 (or higher)

**Dependencies:**  
pyyaml  
numpy  
pandas  
gdal   
fiona  
rasterio  
shapely  
pyproj  
flopy
gis-utils

### Install python and dependency packages
Download and install the [Anaconda python distribution](https://www.anaconda.com/distribution/).
Open an Anaconda Command Prompt on Windows or a terminal window on OSX.
From the root folder for the package (that contains `requirements.yml`), install the above packages from `requirements.yml`.

```
conda env create -f requirements.yml
```
activate the environment:

```
conda activate mfexport
```
### Install to site_packages folder
```
python setup.py install
```
### Install in current location (to current python path)
(i.e., for development)  

```  
pip install -e .
```



MODFLOW Resources
-----------------------------------------------

+ [MODFLOW Online Guide](https://water.usgs.gov/ogw/modflow-nwt/MODFLOW-NWT-Guide/index.html?nwt_newton_solver.htm)
+ [MODFLOW 6](https://www.usgs.gov/software/modflow-6-usgs-modular-hydrologic-model)



Disclaimer
----------

This software is preliminary or provisional and is subject to revision. It is
being provided to meet the need for timely best science. The software has not
received final approval by the U.S. Geological Survey (USGS). 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. The software is provided on the condition that
neither the USGS nor the U.S. Government shall be held liable for any damages
resulting from the authorized or unauthorized use of the software.



