sfrmaker


Namesfrmaker JSON
Version 0.11.2 PyPI version JSON
download
home_page
SummaryRapid construction of MODFLOW SFR Package input from hydrography data
upload_time2024-01-15 17:07:32
maintainer
docs_urlNone
author
requires_python>=3.11
licenseLicense ======= Unless otherwise noted, This project is in the public domain in the United States because it contains materials that originally came from the United States Geological Survey, an agency of the United States Department of Interior. For more information, see the official USGS copyright policy at https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits Additionally, we waive copyright and related rights in the work worldwide through the CC0 1.0 Universal public domain dedication. CC0 1.0 Universal Summary ------------------------- This is a human-readable summary of the [Legal Code (read the full text)][1]. ### No Copyright The person who associated a work with this deed has dedicated the work to the public domain by waiving all of his or her rights to the work worldwide under copyright law, including all related and neighboring rights, to the extent allowed by law. You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission. ### Other Information In no way are the patent or trademark rights of any person affected by CC0, nor are the rights that other persons may have in the work or in how the work is used, such as publicity or privacy rights. Unless expressly stated otherwise, the person who associated a work with this deed makes no warranties about the work, and disclaims liability for all uses of the work, to the fullest extent permitted by applicable law. When using or citing the work, you should not imply endorsement by the author or the affirmer. [1]: https://creativecommons.org/publicdomain/zero/1.0/legalcode
keywords modflow groundwater hydrogeology
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            SFRmaker
===
SFRmaker is a python package for automating construction of stream flow routing networks from hydrography data. Hydrography are input from a polyline shapefile and intersected with a structured grid defined using a shapefile or a Flopy `StructuredGrid` instance. Attribute data are supplied via `.dbf` files (NHDPlus input option) or via specified fields in the hydrography shapefile. Line fragments representing intersections between the flowlines and model grid cells are converted to SFR reaches using the supplied attribute data. MODFLOW-NWT/2005 or MODFLOW-6 SFR package input can then be written, along with shapefiles for visualizing the SFR package dataset.


### Version 0.11

![Tests](https://github.com/doi-usgs/sfrmaker/workflows/Tests/badge.svg)
[![Coverage Status](https://codecov.io/github/doi-usgs/SFRmaker/coverage.svg?branch=develop)](https://codecov.io/github/doi-usgs/SFRmaker/coverage.svg?branch=develop)
[![PyPI version](https://badge.fury.io/py/sfrmaker.svg)](https://badge.fury.io/py/sfrmaker)
[![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 [SFRmaker documentation](https://doi-usgs.github.io/sfrmaker/index.html)


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

How to cite
--------------
###### Citations for SFRmaker

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

Leaf, A.T., 2023, Automated construction of Streamflow-Routing networks for MODFLOW—Application in the Mississippi Embayment region: U.S. Geological Survey Scientific Investigations Report 2023–5051, 28 p., https://doi.org/10.3133/sir20235051.

###### Software/Code citation for SFRmaker (IP-122355):
Leaf, A.T., Fienen, M.N. and Reeves, H.W., 2021, SFRmaker version 0.7.1: U.S. Geological Survey Software Release, 29 Jan. 2021, [https://doi.org/10.5066/P9U2T031](https://doi.org/10.5066/P9U2T031)

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. It is the responsibility of the user to check the accuracy of the results.

Any use of trade, firm, or product names is for descriptive purposes only and does not imply endorsement by the U.S. Government.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "sfrmaker",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "",
    "keywords": "MODFLOW,groundwater,hydrogeology",
    "author": "",
    "author_email": "Andrew Leaf <aleaf@usgs.gov>, Mike Fienen <mnfienen@usgs.gov>, Howard Reeves <hwreeves@usgs.gov>",
    "download_url": "https://files.pythonhosted.org/packages/18/6a/8c654854753da74e3c1b2ea411697077bc917190f4d352b33f2f45ad63b2/sfrmaker-0.11.2.tar.gz",
    "platform": null,
    "description": "SFRmaker\n===\nSFRmaker is a python package for automating construction of stream flow routing networks from hydrography data. Hydrography are input from a polyline shapefile and intersected with a structured grid defined using a shapefile or a Flopy `StructuredGrid` instance. Attribute data are supplied via `.dbf` files (NHDPlus input option) or via specified fields in the hydrography shapefile. Line fragments representing intersections between the flowlines and model grid cells are converted to SFR reaches using the supplied attribute data. MODFLOW-NWT/2005 or MODFLOW-6 SFR package input can then be written, along with shapefiles for visualizing the SFR package dataset.\n\n\n### Version 0.11\n\n![Tests](https://github.com/doi-usgs/sfrmaker/workflows/Tests/badge.svg)\n[![Coverage Status](https://codecov.io/github/doi-usgs/SFRmaker/coverage.svg?branch=develop)](https://codecov.io/github/doi-usgs/SFRmaker/coverage.svg?branch=develop)\n[![PyPI version](https://badge.fury.io/py/sfrmaker.svg)](https://badge.fury.io/py/sfrmaker)\n[![Project Status: Active \u2013 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)\n\nGetting Started\n----------------------------------------------- \nSee the [SFRmaker documentation](https://doi-usgs.github.io/sfrmaker/index.html)\n\n\nInstallation\n-----------------------------------------------\nSee the [Installation Instructions](https://doi-usgs.github.io/sfrmaker/latest/installation.html)\n\nHow to cite\n--------------\n###### Citations for SFRmaker\n\nLeaf, 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\n\nLeaf, A.T., 2023, Automated construction of Streamflow-Routing networks for MODFLOW\u2014Application in the Mississippi Embayment region: U.S. Geological Survey Scientific Investigations Report 2023\u20135051, 28 p., https://doi.org/10.3133/sir20235051.\n\n###### Software/Code citation for SFRmaker (IP-122355):\nLeaf, A.T., Fienen, M.N. and Reeves, H.W., 2021, SFRmaker version 0.7.1: U.S. Geological Survey Software Release, 29 Jan. 2021, [https://doi.org/10.5066/P9U2T031](https://doi.org/10.5066/P9U2T031)\n\nDisclaimer\n----------\n\nThis software is preliminary or provisional and is subject to revision. It is\nbeing provided to meet the need for timely best science. The software has not\nreceived final approval by the U.S. Geological Survey (USGS). No warranty,\nexpressed or implied, is made by the USGS or the U.S. Government as to the\nfunctionality of the software and related material nor shall the fact of release\nconstitute any such warranty. The software is provided on the condition that\nneither the USGS nor the U.S. Government shall be held liable for any damages\nresulting from the authorized or unauthorized use of the software. It is the responsibility of the user to check the accuracy of the results.\n\nAny use of trade, firm, or product names is for descriptive purposes only and does not imply endorsement by the U.S. Government.\n",
    "bugtrack_url": null,
    "license": "License =======  Unless otherwise noted, This project is in the public domain in the United States because it contains materials that originally came from the United States Geological Survey, an agency of the United States Department of Interior. For more information, see the official USGS copyright policy at https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits  Additionally, we waive copyright and related rights in the work worldwide through the CC0 1.0 Universal public domain dedication.   CC0 1.0 Universal Summary -------------------------  This is a human-readable summary of the [Legal Code (read the full text)][1].   ### No Copyright  The person who associated a work with this deed has dedicated the work to the public domain by waiving all of his or her rights to the work worldwide under copyright law, including all related and neighboring rights, to the extent allowed by law.  You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission.   ### Other Information  In no way are the patent or trademark rights of any person affected by CC0, nor are the rights that other persons may have in the work or in how the work is used, such as publicity or privacy rights.  Unless expressly stated otherwise, the person who associated a work with this deed makes no warranties about the work, and disclaims liability for all uses of the work, to the fullest extent permitted by applicable law. When using or citing the work, you should not imply endorsement by the author or the affirmer.    [1]: https://creativecommons.org/publicdomain/zero/1.0/legalcode ",
    "summary": "Rapid construction of MODFLOW SFR Package input from hydrography data",
    "version": "0.11.2",
    "project_urls": {
        "documentation": "https://doi-usgs.github.io/sfrmaker/latest/",
        "repository": "https://github.com/doi-usgs/sfrmaker"
    },
    "split_keywords": [
        "modflow",
        "groundwater",
        "hydrogeology"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e4dd2710a00fc2660e70bcf305c7a4cf9586d408c488a7a7da76e1d91b82ebbf",
                "md5": "2a3f3dad1fc1218651aa47410efd31b5",
                "sha256": "0c942373cdeaaa41c74ae4b4d258bc1c22057c01257f8601a94f19a72ed60b9a"
            },
            "downloads": -1,
            "filename": "sfrmaker-0.11.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2a3f3dad1fc1218651aa47410efd31b5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 159261,
            "upload_time": "2024-01-15T17:07:31",
            "upload_time_iso_8601": "2024-01-15T17:07:31.179531Z",
            "url": "https://files.pythonhosted.org/packages/e4/dd/2710a00fc2660e70bcf305c7a4cf9586d408c488a7a7da76e1d91b82ebbf/sfrmaker-0.11.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "186a8c654854753da74e3c1b2ea411697077bc917190f4d352b33f2f45ad63b2",
                "md5": "5da611098bea6ba44f5a2d3d589aa305",
                "sha256": "16841792c16926eb27954982d73c8af1bc8688556070e3a1a64de9dc4ab6eb64"
            },
            "downloads": -1,
            "filename": "sfrmaker-0.11.2.tar.gz",
            "has_sig": false,
            "md5_digest": "5da611098bea6ba44f5a2d3d589aa305",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 192304,
            "upload_time": "2024-01-15T17:07:32",
            "upload_time_iso_8601": "2024-01-15T17:07:32.496899Z",
            "url": "https://files.pythonhosted.org/packages/18/6a/8c654854753da74e3c1b2ea411697077bc917190f4d352b33f2f45ad63b2/sfrmaker-0.11.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-15 17:07:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "doi-usgs",
    "github_project": "sfrmaker",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "sfrmaker"
}
        
Elapsed time: 0.19087s