.. project documentation master file, created by
   sphinx-quickstart on Mon Sep  1 09:55:46 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to SafeRoad's Documentation
======================================

**SafeRoad** is an open-source Python library designed to monitor the structural condition of the road network by providing tools for data analysis and visualisation. 
It aims to assist researchers, policymakers, and developers in understanding and mitigating structural safety issues of road networks.
**SafeRoad** is built with a focus on usability, performance, and extensibility. It uses modern Python libraries such as `duckdb`_, 
`shapely`_, `matplotlib`_ and `contextily`_ to provide a robust framework for road network safety analysis.

You can access the relavant paper from `here`_.

.. _here: https://doi.org/10.1177/14759217211045912
.. _duckdb: https://duckdb.org/
.. _shapely: https://shapely.readthedocs.io/en/stable/
.. _matplotlib: https://matplotlib.org/
.. _contextily: https://contextily.readthedocs.io/en/latest/

Summary
-------
SafeRoad offers a comprehensive suite of features, including:

- Data preprocessing tools for cleaning and organizing road and Multi-Temporal dataset.
- Visualisation utilities to generate insightful charts and graphs.
- Statistical analysis methods to identify trends and patterns.
- Extensible APIs for integrating with other applications.

The library is modular, user-friendly, and well-documented, making it suitable for both beginners and experts in the field of structural safety.



.. toctree::
   :maxdepth: 2
   :caption: Contents:

   api/modules