rivia 0.1.0__tar.gz

rivia-0.1.0/.gitignore

@@ -0,0 +1,49 @@
+# Root-level development scripts (not part of the package)
+/*.py
+*.xlsm
+*.tmp
+
+# Python build and packaging
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+*.egg
+*.whl
+*.tar.gz
+
+# setuptools-scm generated version file
+src/rivia/_version.py
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Type checking and linting
+.mypy_cache/
+.ruff_cache/
+
+# Virtual environments
+.venv/
+venv/
+
+# Sphinx build output
+docs/_build/
+docs/api/generated/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+Thumbs.db
+.DS_Store
+
+# Project-specific
+archive/
+CLAUDE.md
+.claude

rivia-0.1.0/.readthedocs.yaml

@@ -0,0 +1,21 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+formats:
+  - pdf
+  - epub

rivia-0.1.0/CREDITS

@@ -0,0 +1,22 @@
+Credits and Acknowledgements
+=============================
+
+PyRAS — Gonzalo Peña-Castellanos
+----------------------------------
+Portions of raspy/com/ (_ver400.py, _ver500.py, _ver503.py) are derived
+from PyRAS, a HEC-RAS Python wrapper originally authored by Gonzalo
+Peña-Castellanos.
+
+  Original author : Gonzalo Peña-Castellanos
+  GitHub          : https://github.com/goanpeca
+  Repository      : original repository no longer publicly available
+
+We are grateful for his pioneering work on HEC-RAS COM automation in Python.
+
+ras-commander — William (Bill) Katzenmeyer
+----------------------------------
+The RASMapper result export pipeline in rivia.model and rivia.geo was informed by ideas and
+knowledge shared by Bill, including insights from his ras-commander repository and his direct
+technical guidance on RASMapper's internal algorithm and source code.
+
+We are grateful for his generosity in sharing his expertise.

rivia-0.1.0/LICENSE

@@ -0,0 +1,185 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submit" means any form of electronic, verbal, or
+      written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and added to the
+      Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or a Contribution
+      incorporated within the Work constitutes direct or contributory patent
+      infringement, then any patent licenses granted to You under this
+      License for that Work shall terminate as of the date such litigation
+      is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the
+          License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, and to permit persons to whom the Derivative Works
+      is furnished to do so.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Liability. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may offer such obligations only on
+      Your own behalf and on Your sole responsibility, not on behalf of
+      any other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Gyan Basyal and WEST Consultants, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.

rivia-0.1.0/NOTICE

@@ -0,0 +1,13 @@
+raspy
+Copyright 2025 Gyan Basyal and WEST Consultants, Inc.
+
+This product was developed by Gyan Basyal at WEST Consultants, Inc.
+(https://www.westconsultants.com) and is licensed under the Apache
+License, Version 2.0.
+
+---
+
+This software includes algorithms reverse-engineered from HEC-RAS,
+a hydraulic modeling program developed by the U.S. Army Corps of
+Engineers Hydrologic Engineering Center (HEC), which is in the
+public domain.

rivia-0.1.0/PKG-INFO

@@ -0,0 +1,150 @@
+Metadata-Version: 2.4
+Name: rivia
+Version: 0.1.0
+Summary: A modern Python interface for HEC-RAS Visualization, Information, and Automation
+Author: Gyan Basyal, WEST Consultants, Inc.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/gyanz/rivia
+Project-URL: Repository, https://github.com/gyanz/rivia
+Project-URL: Issues, https://github.com/gyanz/rivia/issues
+Keywords: hec-ras,hydraulics,hydrology,modeling,water-resources
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Hydrology
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: pandas
+Requires-Dist: h5py
+Requires-Dist: pywin32; sys_platform == "win32"
+Requires-Dist: psutil; sys_platform == "win32"
+Requires-Dist: pydantic>=2
+Provides-Extra: geo
+Requires-Dist: geopandas; extra == "geo"
+Requires-Dist: rasterio; extra == "geo"
+Requires-Dist: matplotlib; extra == "geo"
+Requires-Dist: numba; extra == "geo"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.0; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Dynamic: license-file
+
+# RIVIA
+
+**RAS Interface for Visualization, Information, and Automation**
+
+A modern, modular Python library for interacting with [HEC-RAS](https://www.hec.usace.army.mil/software/hec-ras/) hydraulic modeling software.
+
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/)
+[![Platform](https://img.shields.io/badge/platform-Windows-lightgrey.svg)](https://www.hec.usace.army.mil/software/hec-ras/)
+[![Documentation](https://readthedocs.org/projects/rivia/badge/?version=latest)](https://rivia.readthedocs.io/en/latest/)
+
+## Documentation
+
+Full documentation is available at [rivia.readthedocs.io](https://rivia.readthedocs.io).
+
+## Overview
+
+`rivia` provides a clean, Pythonic interface for working with HEC-RAS projects:
+
+- **Control HEC-RAS** via COM automation — open projects, switch plans, run simulations
+- **Read and write** HEC-RAS text input files (`.prj`, `.g*`, `.p*`, `.f*`, `.u*`)
+- **Access HDF5 results** — water surface, velocity, depth, and other outputs
+- **Export rasters** — pixel-perfect RASMapper-equivalent rasters (WSE, depth, velocity, etc.)
+- **Export terrain** — mosaic and modify terrain from HEC-RAS terrain HDF files
+
+## Requirements
+
+- **Windows** — HEC-RAS is Windows-only
+- Python 3.10+
+- HEC-RAS 5.x or later installed
+
+## Installation
+
+```bash
+pip install rivia
+```
+
+With geospatial extras (required for raster export):
+
+```bash
+pip install rivia[geo]
+```
+
+## Quick Example
+
+```python
+from rivia.model import Model
+
+# Open a HEC-RAS project
+model = Model("path/to/project.prj")
+print(model.version)       # e.g. "6.30"
+
+# Switch plans
+model.change_plan(title="Base Condition")
+model.change_plan(short_id="BC")
+model.change_plan(index=0)
+
+# Read HDF results
+area = model.hdf.flow_areas["Perimeter 1"]
+wse_max = area.max_water_surface
+
+# Export a WSE raster
+vrt = model.export_wse(timestep=None, render_mode="sloping")
+print(vrt.path)
+```
+
+## Package Structure
+
+```
+rivia/
+├── com/       # COM interface to run/control HEC-RAS
+├── model/     # Model - primary project interface; read/write text input files, read HDF results
+├── hdf/       # Read HEC-RAS HDF5 geometry and result files
+├── geo/       # Geospatial operations: raster export (geopandas/rasterio)
+└── utils/     # Shared helpers
+```
+
+## Development
+
+```bash
+git clone https://github.com/gyanz/rivia.git
+cd rivia
+pip install -e ".[dev,geo,docs]"
+
+# Run tests
+pytest tests/ -x --tb=short
+
+# Lint
+ruff check src/
+
+# Type check
+mypy src/rivia
+
+# Build docs
+sphinx-build -b html docs docs/_build/html
+```
+
+## License
+
+Copyright 2025 Gyan Basyal and WEST Consultants, Inc.
+
+Licensed under the [Apache License, Version 2.0](LICENSE).

rivia-0.1.0/README.md

@@ -0,0 +1,102 @@
+# RIVIA
+
+**RAS Interface for Visualization, Information, and Automation**
+
+A modern, modular Python library for interacting with [HEC-RAS](https://www.hec.usace.army.mil/software/hec-ras/) hydraulic modeling software.
+
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/)
+[![Platform](https://img.shields.io/badge/platform-Windows-lightgrey.svg)](https://www.hec.usace.army.mil/software/hec-ras/)
+[![Documentation](https://readthedocs.org/projects/rivia/badge/?version=latest)](https://rivia.readthedocs.io/en/latest/)
+
+## Documentation
+
+Full documentation is available at [rivia.readthedocs.io](https://rivia.readthedocs.io).
+
+## Overview
+
+`rivia` provides a clean, Pythonic interface for working with HEC-RAS projects:
+
+- **Control HEC-RAS** via COM automation — open projects, switch plans, run simulations
+- **Read and write** HEC-RAS text input files (`.prj`, `.g*`, `.p*`, `.f*`, `.u*`)
+- **Access HDF5 results** — water surface, velocity, depth, and other outputs
+- **Export rasters** — pixel-perfect RASMapper-equivalent rasters (WSE, depth, velocity, etc.)
+- **Export terrain** — mosaic and modify terrain from HEC-RAS terrain HDF files
+
+## Requirements
+
+- **Windows** — HEC-RAS is Windows-only
+- Python 3.10+
+- HEC-RAS 5.x or later installed
+
+## Installation
+
+```bash
+pip install rivia
+```
+
+With geospatial extras (required for raster export):
+
+```bash
+pip install rivia[geo]
+```
+
+## Quick Example
+
+```python
+from rivia.model import Model
+
+# Open a HEC-RAS project
+model = Model("path/to/project.prj")
+print(model.version)       # e.g. "6.30"
+
+# Switch plans
+model.change_plan(title="Base Condition")
+model.change_plan(short_id="BC")
+model.change_plan(index=0)
+
+# Read HDF results
+area = model.hdf.flow_areas["Perimeter 1"]
+wse_max = area.max_water_surface
+
+# Export a WSE raster
+vrt = model.export_wse(timestep=None, render_mode="sloping")
+print(vrt.path)
+```
+
+## Package Structure
+
+```
+rivia/
+├── com/       # COM interface to run/control HEC-RAS
+├── model/     # Model - primary project interface; read/write text input files, read HDF results
+├── hdf/       # Read HEC-RAS HDF5 geometry and result files
+├── geo/       # Geospatial operations: raster export (geopandas/rasterio)
+└── utils/     # Shared helpers
+```
+
+## Development
+
+```bash
+git clone https://github.com/gyanz/rivia.git
+cd rivia
+pip install -e ".[dev,geo,docs]"
+
+# Run tests
+pytest tests/ -x --tb=short
+
+# Lint
+ruff check src/
+
+# Type check
+mypy src/rivia
+
+# Build docs
+sphinx-build -b html docs docs/_build/html
+```
+
+## License
+
+Copyright 2025 Gyan Basyal and WEST Consultants, Inc.
+
+Licensed under the [Apache License, Version 2.0](LICENSE).

rivia-0.1.0/build_tool.bat

@@ -0,0 +1,4 @@
+cd tools\RasMapperStoreMap
+dotnet build -c Release
+copy bin\Release\net472\RasMapperStoreMap.exe ..\..\src\raspy\bin\
+cd ..\..

rivia-0.1.0/docs/Makefile

@@ -0,0 +1,12 @@
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

rivia-0.1.0/docs/_templates/autosummary/class.rst

@@ -0,0 +1,29 @@
+{{ objname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+   {% for item in methods %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

rivia-0.1.0/docs/_templates/autosummary/module.rst

@@ -0,0 +1,60 @@
+{{ name | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {%- if attributes %}
+   .. rubric:: {{ _('Module Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {%- endblock %}
+
+   {%- block functions %}
+   {%- if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {%- endblock %}
+
+   {%- block classes %}
+   {%- if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {%- endblock %}
+
+   {%- block exceptions %}
+   {%- if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {%- endblock %}
+
+{%- block modules %}
+{%- if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{%- endblock %}

rivia-0.1.0/docs/api/com.rst

@@ -0,0 +1,17 @@
+rivia.com
+=========
+
+COM interface to run and control HEC-RAS. Windows only; requires ``pywin32``.
+
+.. automodule:: rivia.com
+   :members:
+
+.. rubric:: Submodules
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   rivia.com.controller
+   rivia.com.ras
+   rivia.com.registry

rivia-0.1.0/docs/api/geo.rst

@@ -0,0 +1,16 @@
+rivia.geo
+=========
+
+Geospatial operations: mesh interpolation, raster export.
+Requires ``geopandas`` and ``rasterio`` (install with ``pip install rivia[geo]``).
+
+.. automodule:: rivia.geo
+   :members:
+
+.. rubric:: Submodules
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   rivia.geo.raster