| Name | hyswap JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Analysis of surface water data. |
| upload_time | 2024-11-22 22:25:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| 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)](https://creativecommons.org/publicdomain/zero/1.0/legalcode). ### 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. |
| keywords |
usgs
water data
analysis
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# hyswap - HYdrologic Surface Water Analysis Package
[](https://owi.usgs.gov/R/packages.html#core)
[](https://code.usgs.gov/water/computational-tools/surface-water-work/hyswap/-/commits/main)
[](https://code.usgs.gov/water/computational-tools/surface-water-work/hyswap/-/commits/main)
[](https://badge.fury.io/py/hyswap)
[](https://img.shields.io/pypi/pyversions/hyswap)
## Overview
`hyswap` (HYdrologic Surface Water Analysis Package), is a Python package which provides a set of functions for manipulating and visualizing USGS water data.
Specifically, a number of functions for calculating statistics (e.g., exceedance probabilities, daily historic percentiles) and generating related plots (e.g., flow duration curves, streamflow duration hydrographs) are available.
These methods are provided in a modular fashion as individual functions, and are designed to give the user flexibility in implementation.
### Project Documentation
For more information, visit the `hyswap` [documentation](https://doi-usgs.github.io/hyswap/).
## Installation
### User Installation via `pip`
One-liner to install `hyswap` via `pip`:
```bash
pip install hyswap
```
*Note:* `hyswap` has 4 dependencies right now, `numpy`, `pandas`, `scipy`, and `matplotlib`, these will be installed automatically when installing the package via `pip`.
### User Installation From Source
To install `hyswap` from source, first you will need to clone the repository.
Next, from the root of the repository, run the following commands in your non-base environment:
```bash
pip install -r requirements.txt
pip install .
```
### Developer Installation
Developer installation should be performed from source.
First you will need to clone the repository.
Next, from the root of the repository, you have two options:
**Option 1: Initiate your own python environment and then `pip install` the required packages**
In a non-base environment, use the `pip` command to install both the `requirements.txt` and the `requirements-dev.txt`. Then run `pip install .` to obtain the source version of `hyswap`.
```bash
pip install -r requirements.txt
pip install -r requirements-dev.txt
pip install .
```
**Option 2: Use the `environment-dev.yml` to initiate a conda/mamba environment and download required packages from `conda-forge` and `pypi`**
If you are a `conda` or `mamba` user, the shell code below will create a development environment called `hyswap-dev-environment`, activate it, and then install `hyswap` into the environment from source. Replace `conda` with `mamba` where appropriate for `mamba` users.
```bash
conda env create -f environment-dev.yml
conda activate hyswap-dev-environment
pip install .
```
### Testing and Building Documentation Locally
To test the code and building and test the documentation locally, you must have cloned the source repository, follow the instructions above for a "developer installation" first.
To test the package locally, run the following command from the root of the repository:
```bash
pytest
```
To build the documentation locally, run the following commands from the root of the repository:
```bash
cd docs
make docs
```
### Running the Linting and Formatting Checks Locally
To run the linting and formatting checks locally, run the following commands from the root of the repository:
```bash
flake8 .
pydocstringformatter .
```
### Running the Example Workflow Notebooks
The example Jupyter (.ipynb) notebooks contain extended use cases of `hyswap` functions. They are displayed in the [documentation pages](https://doi-usgs.github.io/hyswap/examples/index.html#example-workflow-notebooks), or you may download the notebooks from the 'example_notebooks' folder in this repository. The notebooks sometimes utilize additional packages that are not required to run the `hyswap` functions in isolation. You can use the developer installation instructions to create an environment containing all of the required packages to run the notebooks. Don't forget to also ``pip install hyswap`` into your working environment!
## Contributing
See the [contributing guidelines](CONTRIBUTING.md) for more information.
## Citation
Hamshaw, S.D., Hariharan, J., Hinman, E.D., Sleckman, M.J., Stanish, L.F., 2024, hyswap: A USGS software package for hydrologic data analysis, DOI: https://doi.org/10.5066/P13SKXA2
## Questions?
Please send an email to comptools@usgs.gov with 'hyswap' noted somewhere in the subject line.
## License
See the [license](LICENSE.md) for more information.
## Disclaimer
See the [disclaimer](DISCLAIMER.md) for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "hyswap",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "USGS, water data, analysis",
"author": null,
"author_email": "USGS <comptools@usgs.gov>",
"download_url": "https://files.pythonhosted.org/packages/2d/1c/9d080c91785cb97ba57d482b540d2e460864448362b87d066c4c93730324/hyswap-1.0.0.tar.gz",
"platform": null,
"description": "# hyswap - HYdrologic Surface Water Analysis Package\n\n[](https://owi.usgs.gov/R/packages.html#core)\n[](https://code.usgs.gov/water/computational-tools/surface-water-work/hyswap/-/commits/main)\n[](https://code.usgs.gov/water/computational-tools/surface-water-work/hyswap/-/commits/main)\n[](https://badge.fury.io/py/hyswap)\n[](https://img.shields.io/pypi/pyversions/hyswap)\n\n## Overview\n\n`hyswap` (HYdrologic Surface Water Analysis Package), is a Python package which provides a set of functions for manipulating and visualizing USGS water data.\nSpecifically, a number of functions for calculating statistics (e.g., exceedance probabilities, daily historic percentiles) and generating related plots (e.g., flow duration curves, streamflow duration hydrographs) are available.\nThese methods are provided in a modular fashion as individual functions, and are designed to give the user flexibility in implementation.\n\n### Project Documentation\n\nFor more information, visit the `hyswap` [documentation](https://doi-usgs.github.io/hyswap/).\n\n## Installation\n\n### User Installation via `pip`\n\nOne-liner to install `hyswap` via `pip`:\n\n```bash\npip install hyswap\n```\n\n*Note:* `hyswap` has 4 dependencies right now, `numpy`, `pandas`, `scipy`, and `matplotlib`, these will be installed automatically when installing the package via `pip`.\n\n### User Installation From Source\n\nTo install `hyswap` from source, first you will need to clone the repository.\nNext, from the root of the repository, run the following commands in your non-base environment:\n\n```bash\npip install -r requirements.txt\npip install .\n```\n\n### Developer Installation\n\nDeveloper installation should be performed from source.\nFirst you will need to clone the repository.\nNext, from the root of the repository, you have two options:\n\n**Option 1: Initiate your own python environment and then `pip install` the required packages**\n\nIn a non-base environment, use the `pip` command to install both the `requirements.txt` and the `requirements-dev.txt`. Then run `pip install .` to obtain the source version of `hyswap`.\n\n```bash\npip install -r requirements.txt\npip install -r requirements-dev.txt\npip install .\n```\n**Option 2: Use the `environment-dev.yml` to initiate a conda/mamba environment and download required packages from `conda-forge` and `pypi`**\n\nIf you are a `conda` or `mamba` user, the shell code below will create a development environment called `hyswap-dev-environment`, activate it, and then install `hyswap` into the environment from source. Replace `conda` with `mamba` where appropriate for `mamba` users.\n\n```bash\nconda env create -f environment-dev.yml\nconda activate hyswap-dev-environment\npip install .\n```\n\n### Testing and Building Documentation Locally\n\nTo test the code and building and test the documentation locally, you must have cloned the source repository, follow the instructions above for a \"developer installation\" first.\n\nTo test the package locally, run the following command from the root of the repository:\n\n```bash\npytest\n```\n\nTo build the documentation locally, run the following commands from the root of the repository:\n\n```bash\ncd docs\nmake docs\n```\n\n### Running the Linting and Formatting Checks Locally\n\nTo run the linting and formatting checks locally, run the following commands from the root of the repository:\n\n```bash\nflake8 .\npydocstringformatter .\n```\n### Running the Example Workflow Notebooks\n\nThe example Jupyter (.ipynb) notebooks contain extended use cases of `hyswap` functions. They are displayed in the [documentation pages](https://doi-usgs.github.io/hyswap/examples/index.html#example-workflow-notebooks), or you may download the notebooks from the 'example_notebooks' folder in this repository. The notebooks sometimes utilize additional packages that are not required to run the `hyswap` functions in isolation. You can use the developer installation instructions to create an environment containing all of the required packages to run the notebooks. Don't forget to also ``pip install hyswap`` into your working environment! \n\n## Contributing\n\nSee the [contributing guidelines](CONTRIBUTING.md) for more information.\n\n## Citation\n\nHamshaw, S.D., Hariharan, J., Hinman, E.D., Sleckman, M.J., Stanish, L.F., 2024, hyswap: A USGS software package for hydrologic data analysis, DOI: https://doi.org/10.5066/P13SKXA2\n\n## Questions?\n\nPlease send an email to comptools@usgs.gov with 'hyswap' noted somewhere in the subject line.\n\n## License\n\nSee the [license](LICENSE.md) for more information.\n\n## Disclaimer\n\nSee the [disclaimer](DISCLAIMER.md) for more information.\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)](https://creativecommons.org/publicdomain/zero/1.0/legalcode). ### 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. ",
"summary": "Analysis of surface water data.",
"version": "1.0.0",
"project_urls": {
"homepage": "https://code.usgs.gov/water/computational-tools/surface-water-work/hyswap",
"repository": "https://code.usgs.gov/water/computational-tools/surface-water-work/hyswap.git"
},
"split_keywords": [
"usgs",
" water data",
" analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "61159e8acb884edfbef911ea7631f419f9efe9af6909b900365c2910ae122c13",
"md5": "594dc6e9ccb47c612319c53834b4d121",
"sha256": "b3df53eb36eb20db4101dabff2e8d9ac1cf0241985edca137c93c5f9b4be16c9"
},
"downloads": -1,
"filename": "hyswap-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "594dc6e9ccb47c612319c53834b4d121",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 43580,
"upload_time": "2024-11-22T22:25:05",
"upload_time_iso_8601": "2024-11-22T22:25:05.259423Z",
"url": "https://files.pythonhosted.org/packages/61/15/9e8acb884edfbef911ea7631f419f9efe9af6909b900365c2910ae122c13/hyswap-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2d1c9d080c91785cb97ba57d482b540d2e460864448362b87d066c4c93730324",
"md5": "02f1ff72dcd3195a96a27912d151e840",
"sha256": "3e41e3fc993340d3ef3c76850eb0dfffe58646e47bb2de366bff3e885594f882"
},
"downloads": -1,
"filename": "hyswap-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "02f1ff72dcd3195a96a27912d151e840",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2049993,
"upload_time": "2024-11-22T22:25:06",
"upload_time_iso_8601": "2024-11-22T22:25:06.763583Z",
"url": "https://files.pythonhosted.org/packages/2d/1c/9d080c91785cb97ba57d482b540d2e460864448362b87d066c4c93730324/hyswap-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 22:25:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "hyswap"
}
