pyhnhtools
==========

Open-source Python library for hydraulic and hydrologic analysis.

.. image:: https://img.shields.io/github/license/YOUR-USERNAME/pyhnhtools
   :target: https://github.com/YOUR-USERNAME/pyhnhtools
   :alt: License

.. image:: https://readthedocs.org/projects/pyhnhtools/badge/?version=latest
   :target: https://pyhnhtools.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

**pyhnhtools** provides tools for water resource engineering analysis including:

- **Standard Step 1D Solver** - Steady-state reach profile analysis
- **Culvert Analysis** - Inlet and outlet flow calculations
- **PyQt5 GUI** - Interactive graphical interface for model setup and visualization
- **Cross-section Processing** - Geometry parsing and manipulation
- **HEC-RAS Integration** - Import and export model compatibility

Quick Start
-----------

Install via pip:

.. code-block:: bash

   pip install pyhnhtools

Load and run a model:

.. code-block:: python

   from pyhnhtools import load_input, run_backwater
   
   # Load a model
   model = load_input('model.json')
   
   # Run the solver
   results = run_backwater(model)
   
   # Access results
   print(results.profile)

Or launch the GUI:

.. code-block:: bash

   python -m pyhnhtools.gui.app

Table of Contents
-----------------

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   getting_started/installation
   getting_started/quick_start
   getting_started/gui_tutorial

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   user_guide/architecture
   user_guide/std_step_1d
   user_guide/culverts
   user_guide/file_formats

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/core
   api/adapters
   api/gui

.. toctree::
   :maxdepth: 2
   :caption: Developer Guide

   developer/contributing
   developer/module_integration
   developer/templates

.. toctree::
   :maxdepth: 1
   :caption: Project

   License <license>
   GitHub <https://github.com/YOUR-USERNAME/pyhnhtools>