Erste kurze Doku verfasst.

2025-05-19 11:45:12 +02:00
parent cc40e6ded1
commit 89a88fcc75
12 changed files with 31 additions and 0 deletions
@@ -0,0 +1,31 @@
+# Dokumentation der Funktionsweise einzelner Funktionen und Ausgaben aus `plant.py` bzw. `routing.py`
+
+## Aufbau des Graphen in unterschiedlichen Ausbaustufen
+
+Die nachfolgenden Bilder zeigen den schrittweisen Aufbau des Graphen aus dem System:
+
+1. **Nur Racks**
+
+   ![Graph nur mit Racks](doc\img\plant.py\racks.png)
+
+2. **Racks + Sensoren**
+
+   ![Graph mit Racks und Sensoren](doc\img\plant.py\racks_sensors.png)
+
+3. **Racks + Sensoren + Unterverteiler**
+
+   ![Kompletter Graph mit Racks, Sensoren und Unterverteilern](doc\img\plant.py\racks_sensors_dists.png)
+
+---
+
+## Funktionsweise ausgewählter Funktionen
+
+### Beispiel 1: `join_racks`
+
+Problematik: Racks sind in dxf-Dateien teileweise nicht formschlüssig aneinander angefügt. 
+-> Echte Schnittpunkte sowie "beinahe" Schnittpunkte im Toleranzbereich müssen identifiziert werden und die Kabeltrassen dort verbudnen werden.
+
+![Step 1](doc\img\join_racks\join_racks_1.png)
+![Step 2](doc\img\join_racks\join_racks_2.png)
+![Step 3](doc\img\join_racks\join_racks_3.png)
+![Step 4](doc\img\join_racks\join_racks_4.png)