.. UrbanSurge documentation master file, created by
   sphinx-quickstart on Tue Nov 26 12:11:09 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to UrbanSurge's documentation!
======================================

.. toctree::
   :maxdepth: 2

   usage
   api


.. :caption:: Contents:

**UrbanSurge** is a Python library for stormwater system health monitoring developed in the Albertson Lab at Cornell University.
The library provides a streamlined way to manage all aspects of a smart stormwater system including:

* Collection and management of sensor data.
* Tools for data-driven analysis of sensor data.
* EPA SWMM automation.
* Model-based fault detection using the digital twin.

Check out the :doc:`usage` section for further information, including how to
:ref:`install <installation>` the project.


.. note::

   This project is under active development.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`