pybfs 0.1.1__tar.gz

pybfs-0.1.1/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 BYU Hydroinformatics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

pybfs-0.1.1/MANIFEST.in

@@ -0,0 +1,16 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include docs *
+global-exclude __pycache__
+global-exclude *.py[co]
+
+# Keep sdists lean: exclude large calibration artifacts, datasets, and notebooks
+prune bfs
+prune notebooks
+prune refs
+
+exclude *.csv
+exclude *.png
+exclude *.pdf
+

pybfs-0.1.1/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.1
+Name: pybfs
+Version: 0.1.1
+Summary: Python Baseflow Separation - A physically-based baseflow separation algorithm for hydrological analysis
+Author: BYU Hydroinformatics
+License: MIT
+Project-URL: Homepage, https://github.com/BYU-Hydroinformatics/pybfs
+Project-URL: Documentation, https://github.com/BYU-Hydroinformatics/pybfs
+Project-URL: Repository, https://github.com/BYU-Hydroinformatics/pybfs
+Project-URL: Issues, https://github.com/BYU-Hydroinformatics/pybfs/issues
+Keywords: hydrology,baseflow,baseflow separation,streamflow,groundwater
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Provides-Extra: docs
+License-File: LICENSE
+
+# PyBFS
+
+PyBFS - Python Baseflow Separation
+
+A Python implementation of physically-based Baseflow Separation algorithms for hydrological analysis. PyBFS uses a coupled surface-subsurface reservoir model to separate total streamflow into surface flow, baseflow, and direct runoff components.
+
+## Features
+
+- Physically-based baseflow separation using coupled reservoir models
+- Forecast baseflow using initial conditions
+- Comprehensive visualization tools
+- Well-documented API with NumPy-style docstrings
+
+## Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install pybfs
+```
+
+### From source
+
+```bash
+git clone https://github.com/BYU-Hydroinformatics/pybfs.git
+cd pybfs
+pip install .
+```
+
+### Development installation
+
+```bash
+git clone https://github.com/BYU-Hydroinformatics/pybfs.git
+cd pybfs
+pip install -e .
+```
+
+## Quick Start
+
+```python
+import pandas as pd
+from pybfs import get_values_for_site, base_table, PyBFS, plot_baseflow_simulation
+
+# Load streamflow data
+streamflow_data = pd.read_csv('streamflow.csv')
+
+# Load site parameters
+params_df = pd.read_csv('site_parameters.csv')
+
+# Get parameters for specific site
+site_number = 2312200
+basin_char, gw_hyd, flow = get_values_for_site(params_df, site_number)
+
+# Extract parameters
+area, lb, x1, wb, por = basin_char[0], basin_char[1], basin_char[2], basin_char[3], basin_char[4]
+alpha, beta, ks, kb, kz = gw_hyd[0], gw_hyd[1], gw_hyd[2], gw_hyd[3], gw_hyd[4]
+
+# Generate baseflow table
+SBT = base_table(lb, x1, wb, beta, kb, streamflow_data, por)
+
+# Run PyBFS baseflow separation
+result = PyBFS(streamflow_data, SBT, basin_char, gw_hyd, flow)
+
+# Visualize results
+plot_baseflow_simulation(streamflow_data, result)
+```
+
+## Requirements
+
+- Python 3.7 or higher
+- numpy >= 1.19.0
+- pandas >= 1.1.0
+- matplotlib >= 3.3.0
+
+## Documentation
+
+Full documentation is available at: [Documentation](https://github.com/BYU-Hydroinformatics/pybfs)
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](docs/contributing.md) for guidelines.
+
+## Citation
+
+If you use PyBFS in your research, please cite:
+
+```
+PyBFS - Python Baseflow Separation
+BYU Hydroinformatics
+https://github.com/BYU-Hydroinformatics/pybfs
+```
+
+## Support
+
+For issues, questions, or contributions, please visit: https://github.com/BYU-Hydroinformatics/pybfs/issues

pybfs-0.1.1/README.md

@@ -0,0 +1,99 @@
+# PyBFS
+
+PyBFS - Python Baseflow Separation
+
+A Python implementation of physically-based Baseflow Separation algorithms for hydrological analysis. PyBFS uses a coupled surface-subsurface reservoir model to separate total streamflow into surface flow, baseflow, and direct runoff components.
+
+## Features
+
+- Physically-based baseflow separation using coupled reservoir models
+- Forecast baseflow using initial conditions
+- Comprehensive visualization tools
+- Well-documented API with NumPy-style docstrings
+
+## Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install pybfs
+```
+
+### From source
+
+```bash
+git clone https://github.com/BYU-Hydroinformatics/pybfs.git
+cd pybfs
+pip install .
+```
+
+### Development installation
+
+```bash
+git clone https://github.com/BYU-Hydroinformatics/pybfs.git
+cd pybfs
+pip install -e .
+```
+
+## Quick Start
+
+```python
+import pandas as pd
+from pybfs import get_values_for_site, base_table, PyBFS, plot_baseflow_simulation
+
+# Load streamflow data
+streamflow_data = pd.read_csv('streamflow.csv')
+
+# Load site parameters
+params_df = pd.read_csv('site_parameters.csv')
+
+# Get parameters for specific site
+site_number = 2312200
+basin_char, gw_hyd, flow = get_values_for_site(params_df, site_number)
+
+# Extract parameters
+area, lb, x1, wb, por = basin_char[0], basin_char[1], basin_char[2], basin_char[3], basin_char[4]
+alpha, beta, ks, kb, kz = gw_hyd[0], gw_hyd[1], gw_hyd[2], gw_hyd[3], gw_hyd[4]
+
+# Generate baseflow table
+SBT = base_table(lb, x1, wb, beta, kb, streamflow_data, por)
+
+# Run PyBFS baseflow separation
+result = PyBFS(streamflow_data, SBT, basin_char, gw_hyd, flow)
+
+# Visualize results
+plot_baseflow_simulation(streamflow_data, result)
+```
+
+## Requirements
+
+- Python 3.7 or higher
+- numpy >= 1.19.0
+- pandas >= 1.1.0
+- matplotlib >= 3.3.0
+
+## Documentation
+
+Full documentation is available at: [Documentation](https://github.com/BYU-Hydroinformatics/pybfs)
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](docs/contributing.md) for guidelines.
+
+## Citation
+
+If you use PyBFS in your research, please cite:
+
+```
+PyBFS - Python Baseflow Separation
+BYU Hydroinformatics
+https://github.com/BYU-Hydroinformatics/pybfs
+```
+
+## Support
+
+For issues, questions, or contributions, please visit: https://github.com/BYU-Hydroinformatics/pybfs/issues

pybfs-0.1.1/docs/api/reference.md

@@ -0,0 +1,6 @@
+# API Reference
+
+::: pybfs
+    handler: python
+    rendering:
+      show_root_toc_entry: false