src.run_all
===========

.. py:module:: src.run_all

.. autoapi-nested-parse::

   This script runs each module in the Digital Twin using a Sample Polygon.



Functions
---------

.. autoapisummary::

   src.run_all.main
   src.run_all.create_sample_polygon


Module Contents
---------------

.. py:function:: main(selected_polygon_gdf: geopandas.GeoDataFrame, modules_to_parameters: Dict[types.ModuleType, Dict[str, Union[str, int, float, bool, None, enum.Enum]]]) -> None

   Run each module in modules_to_parameters using the selected polygon and the defined parameters for each module's
   main function.

   :param selected_polygon_gdf: A GeoDataFrame representing the selected polygon, i.e., the catchment area.
   :type selected_polygon_gdf: gpd.GeoDataFrame
   :param modules_to_parameters: A dictionary that associates each module with the parameters necessary for its main function, including the
                                 option to set the log level for each module's root logger.
                                 The available logging levels and their corresponding numeric values are:
                                 - LogLevel.CRITICAL (50)
                                 - LogLevel.ERROR (40)
                                 - LogLevel.WARNING (30)
                                 - LogLevel.INFO (20)
                                 - LogLevel.DEBUG (10)
                                 - LogLevel.NOTSET (0)
   :type modules_to_parameters: Dict[ModuleType, Dict[str, Union[str, int, float, bool, None, Enum]]]


.. py:function:: create_sample_polygon() -> geopandas.GeoDataFrame

   Create a sample area of interest polygon for development purposes.
   This sample polygon is rectangular, but has non-whole number edges caused by serialisation rounding errors.
   These deliberate errors are to simulate the production system more accurarately.

   :returns: A GeoDataFrame containing a single rectangular polygon for the area of interest.
   :rtype: gpd.GeoDataFrame