Docs/354 create diagrams

ra2ce/analysis/README.md

@@ -4,8 +4,28 @@ This module contains all protocols and classes related to performing an analysis
 Analyses can be identified as:
 - `direct`: calculating the **damages** to the infrastructure (roads) due to a hazard (e.g. flood),
 - `indirect`: calculating the economical **losses** that are a consequence of the damage to the infrastructure.
+Each analysis should comply to the `AnalysisProtocol`.
 
-## Input and output
-An analysis consumes an `AnalysisInputWrapper`, containing analysis parameters, the graph/network and some additional settings.
+## General class overview
+The following diagram describes the relations between the most relevant entities of the `ra2ce.analysis` (sub-)package.
+
+| ![ra2ce_analysis.jpg](../../docs/_diagrams/ra2ce_analysis.png)| 
+|:--:| 
+| *Ra2ce analysis overview* |
+
+## Configuration
+The analyses can be configured in `analysis.ini` or directly in an `AnalysisConfigData` object.
+
+## Lifecycle
+An analysis is instantiated by the `AnalysisRunner` via the `AnalysisFactory` and added to an `AnalysisCollection`.
+Then the `AnalysisRunner` runs the analyses in the `AnalysisCollection`.
+
+_Add diagram_
+
+## Input/output
+An analysis consumes an `AnalysisInputWrapper`, containing analysis parameters from the configuration, the graph/network and some additional settings.
 The `AnalysisRunner` stores the output of an analysis in an `AnalysisResultWrapper`, containing the analysis result (`GeoDataFrame`) and again the analysis parameters.
-This output can be exported to different formats using the `AnalysisResultWrapperExporter`.
+This output can be exported to different formats using the `AnalysisResultWrapperExporter`.
+
+## Overview of analyses
+_TODO_

ra2ce/network/README.md

@@ -4,9 +4,16 @@ In this package you will find all logic required to load network data from diver
 
 The configuration to be used to load a network is usually an `.ini` file. This file is later represented as a `NetworkConfigData` object that can as well be directly initialized via code (`network_config_data` (sub)package).
 
-The different sources are handled through our own network wrappers (`NetworkWrapperProtocol`) in the `network_wrappers` (sub)package.
+The different sources to generate a network are handled through our own network wrappers (`NetworkWrapperProtocol`) in the `network_wrappers` (sub)package.
 
 
-_TODO_
+## General class overview
+
+The following diagram describes the relations between the most relevant entities of the `ra2ce.network` (sub-)package.
+
+| ![ra2ce_network.jpg](../../docs/_diagrams/ra2ce_network.png)| 
+|:--:| 
+| *Ra2ce network overview* |
+
 Add class diagram
 Add flowchart diagram of loading a diagram