Metadata-Version: 2.1
Name: linesink-maker
Version: 0.1.5
Summary: Rapid creation of linesink elements for streamf network simulation in GFLOW.
Home-page: https://github.com/aleaf/linesink-maker
Author: Andrew Leaf
Author-email: aleaf@usgs.gov
License: BSD (3-clause)
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
License-File: LICENSE.md
License-File: AUTHORS.rst

linesink-maker
===
Rapid creation of linesink elements for stream network simulation in the groundwater flow modeling program GFLOW (<http://www.haitjema.com/>). Nearfield (highest resultion), mid-field and farfield (least resolution, zero resistance) areas of a desired stream network can be defined by polygon shapefiles. The LinesinkData are then created from NHDPlus hydrography. The number of resulting linesink equations (level of detail) in the various areas of the stream network can be controlled by a distance tolerance parameter specified by geographic area (defined by one of the polygons). Results are written to a linesink string (LSS) XML file that can be imported into the GFLOW GUI (version 2.2 or higher).
 
### Version 0.1

![Tests](https://github.com/doi-usgs/linesink-maker/workflows/Tests/badge.svg)
[![codecov](https://codecov.io/gh/doi-usgs/linesink-maker/branch/develop/graph/badge.svg)](https://codecov.io/gh/doi-usgs/linesink-maker)
[![PyPI version](https://badge.fury.io/py/linesink-maker.svg)](https://badge.fury.io/py/linesink-maker)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)


Getting Started
----------------------------------------------- 
See the [linesink-maker documentation](https://doi-usgs.github.io/linesink-maker/index.html)


Installation
-----------------------------------------------
See the [Installation Instructions](https://doi-usgs.github.io/linesink-maker/latest/installation.html)

How to cite
--------------
###### Citation for Linesink-maker

Leaf, A.T., Fienen, M.N. and Reeves, H.W. (2021), SFRmaker and Linesink-Maker: Rapid Construction of Streamflow Routing Networks from Hydrography Data. Groundwater, 59: 761-771. https://doi.org/10.1111/gwat.13095

###### Software/Code citation for Linesink-maker (IP-122356):
Leaf, A.T., 2021, Linesink-maker version 0.1.3: U.S. Geological Survey Software Release, 29 Jan. 2021, [https://doi.org/10.5066/P99QSDDX](https://doi.org/10.5066/P99QSDDX)

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.
