hydrodl2 1.3.0__tar.gz

hydrodl2-1.3.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,45 @@
+---
+name: 🐛 Bug Report
+about: Identify a bug or concern
+labels: bug_report
+assignees: leoglonz
+---
+
+<!--
+Welcome! Thanks for helping us improve HydroDL2.
+
+Before creating a new bug report, please confirm one does not already exist for your issue.
+-->
+
+## Problem
+
+### Actual Behavior
+
+<!-- Provide a clear and concise description of the problem or bug that you encountered.
+
+Is this a known issue?
+-->
+
+### Expected Behavior
+
+<!-- What was the expected behavior in this scenario? This will help us identify the source of the issue.
+-->
+
+## Steps to Reproduce
+
+<!-- Detail steps to recreate the issue as best you can. If we can replicate it on our end we can more readily address the core issue.
+
+1.
+2.
+...
+-->
+
+## Proposed Solution (Optional)
+
+<!-- We are certainly open to suggestions if you have ideas about root causes for the issue or bug, particularly if it is nuanced or more complex.
+-->
+
+## Additional Context
+
+<!-- Add any other context or screenshots related to the issue here.
+-->

hydrodl2-1.3.0/.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,29 @@
+---
+name: 📖 Documentation Issue/Suggestion
+about: Report problems with the docs or suggest improvements
+labels: documentation
+assignees: leoglonz
+---
+
+<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.-->
+<!--You can feel free to delete the sections that do not apply.-->
+
+### Problem
+
+<!--
+If you are referencing an existing piece of documentation or example please provide a link.
+
+* I found [...] to be unclear because [...]
+* [...] made me think that [...] when really it should be [...]
+* There is no example showing how to do [...]
+-->
+
+### Suggested Improvement
+
+<!--
+If you have an idea to improve the documentation please suggest it here
+
+* This line should be be changed to say [...]
+* Include a paragraph explaining [...]
+* Add a figure showing [...]
+-->

hydrodl2-1.3.0/.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,34 @@
+---
+name: 🛠️ Enhancement/Feature Request
+about: Suggest an improvement or new feature
+labels: feature_request
+assignees: leoglonz
+---
+
+<!--
+Welcome! Thanks considering a way to improve HydroDL2.
+
+Before creating a new feature request please search the issues for relevant feature requests.
+-->
+
+## Problem
+
+<!-- Provide a clear and concise description of what problem this feature will solve. For example:
+
+* I'm always frustrated when [...] because [...]
+* I would like it if [...] happened when I [...] because [...]
+-->
+
+## Proposed Solution
+
+<!-- Provide a clear and concise description of a way to accomplish what you want. For example:
+
+* Add an option so that when [...]  [...] will happen
+ -->
+
+## Additional context
+
+<!-- Add any other context or screenshots about the feature request here. You can also include links to examples of other programs that have something similar to your request. For example:
+
+* Another project [...] solved this by [...]
+-->

hydrodl2-1.3.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,31 @@
+## Issue Addressed
+
+<!-- Give a brief ~1 sentence overview of the main addition proposed by this pull request.
+-->
+
+## Description
+
+<!-- Describe how you addressed the bug/feature request, what choices you made and why. Changes can be listed as bullet point;
+
+- ...
+- ...
+
+-->
+
+## Type of Change
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Code cleanup/refactor
+- [ ] Documentation update
+
+Other (please specify):
+
+## Checklist
+
+- [ ] Branch is up to date with master
+- [ ] Updated tests or added new tests
+- [ ] Tests & pre-commit hooks pass
+- [ ] Updated documentation (if applicable)
+- [ ] Code follows established style and conventions

hydrodl2-1.3.0/.github/workflows/build-wheels.yaml

@@ -0,0 +1,56 @@
+name: Build and Publish
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:  # Allow manual triggering
+
+jobs:
+  build:
+    name: Build wheel and sdist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6.0.2
+        with:
+          fetch-depth: 0  # Full history for version tags (hatch-vcs needs this)
+
+      - name: Set up Python
+        uses: actions/setup-python@v6.2.0
+        with:
+          python-version: '3.12'
+
+      - name: Install build
+        run: pip install build
+
+      - name: Build wheel and sdist
+        run: python -m build
+
+      - name: Verify wheel
+        run: |
+          pip install --find-links dist hydrodl2
+          python -c "import hydrodl2; print(hydrodl2.__version__)"
+
+      - uses: actions/upload-artifact@v6.0.0
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    name: Publish to PyPI
+    needs: [build]
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for trusted publishing
+
+    steps:
+      - uses: actions/download-artifact@v7.0.0
+        with:
+          name: dist
+          path: dist
+
+      - name: Display artifacts
+        run: ls -lh dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.13.0

hydrodl2-1.3.0/.github/workflows/lint.yaml

@@ -0,0 +1,34 @@
+name: Lint
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  lint:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.9', '3.12', '3.13']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6.0.2
+
+      - name: Install uv + Python
+        uses: astral-sh/setup-uv@v7.2.1
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run Ruff check
+        run: uv run ruff check . --config pyproject.toml --output-format=github
+
+      - name: Run Ruff format check
+        run: uv run ruff format . --config pyproject.toml --check

hydrodl2-1.3.0/.github/workflows/pytest.yaml

@@ -0,0 +1,32 @@
+name: Pytests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.9', '3.12', '3.13']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6.0.2
+
+      - name: Install uv + Python
+        uses: astral-sh/setup-uv@v7.2.1
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+
+      - name: Install dependencies
+        run: |
+          uv sync --extra dev
+
+      - name: Run tests
+        run: uv run pytest

hydrodl2-1.3.0/.github/workflows/test-wheels.yaml

@@ -0,0 +1,51 @@
+name: Test Build
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - 'pyproject.toml'
+      - '.github/workflows/build-wheels.yaml'
+      - '.github/workflows/test-wheels.yaml'
+  pull_request:
+    branches: [master]
+    paths:
+      - 'pyproject.toml'
+      - '.github/workflows/build-wheels.yaml'
+      - '.github/workflows/test-wheels.yaml'
+  workflow_dispatch:
+
+jobs:
+  test_build:
+    name: Test build on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - uses: actions/checkout@v6.0.2
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6.2.0
+        with:
+          python-version: '3.12'
+
+      - name: Install build
+        run: pip install build
+
+      - name: Build wheel and sdist
+        run: python -m build
+
+      - name: Install and verify
+        run: |
+          pip install --find-links dist hydrodl2
+          python -c "import hydrodl2; print(hydrodl2.__version__)"
+
+      - uses: actions/upload-artifact@v6.0.0
+        with:
+          name: test-dist-${{ matrix.os }}
+          path: dist/
+          retention-days: 7

hydrodl2-1.3.0/.gitignore

@@ -0,0 +1,169 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+_version.py
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Archived files
+archive/
+
+# UV lock
+uv.lock

hydrodl2-1.3.0/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+        exclude: "mkdocs.*\\.yml$"
+      - id: debug-statements
+      - id: check-toml
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.8
+    hooks:
+      - id: ruff-check
+        types_or: [python, pyi, jupyter]
+        args: [--fix, --config, pyproject.toml]
+      - id: ruff-format
+        types_or: [python, pyi, jupyter]
+        args: [--config, pyproject.toml]
+
+  - repo: https://github.com/kynan/nbstripout
+    rev: 0.8.2
+    hooks:
+      - id: nbstripout
+        types: [jupyter]
+        language_version: python3

hydrodl2-1.3.0/LICENSE

@@ -0,0 +1,31 @@
+Non-Commercial Software License Agreement
+
+By downloading the hydrodl2 software (the “Software”) you agree to
+the following terms of use:
+Copyright (c) 2020, The Pennsylvania State University (“PSU”). All rights reserved.
+
+1. PSU hereby grants to you a perpetual, nonexclusive and worldwide right, privilege and
+license to use, reproduce, modify, display, and create derivative works of Software for all
+non-commercial purposes only. You may not use Software for commercial purposes without
+prior written consent from PSU. Queries regarding commercial licensing should be directed
+to The Office of Technology Management at 814.865.6277 or otminfo@psu.edu.
+2. Neither the name of the copyright holder nor the names of its contributors may be used
+to endorse or promote products derived from this software without specific prior written
+permission.
+3. This software is provided for non-commercial use only.
+4. Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that redistributions must reproduce the above copyright notice, license,
+list of conditions and the following disclaimer in the documentation and/or other materials
+provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS";
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.