Anforderungen

RoboCube¶

Die Vorbedingungen dieses Projekts sind neben einer aktuellen Python Umgebung (~3.7) folgende installierte Pakete:

• opencv ~4.2
• numpy ~1.17
• scipy ~1.4
• sklearn ~0.23

Diese drei Bibliotheken sind Python Pakete, welche sich im Python Package Index befinden und somit direkt über pip installieren lassen.

Außerdem wird die RoboDK Software in Version v4.2.3.15578 (2020-03-29) vorausgesetzt.

Betriebssystem¶

Dadurch, dass als Hauptentwicklungssprache python verwendet wurde, ist eine hohe Kompatibilität gegeben. Die drei Betriebssysteme Linux (Ubuntu), macOS und Windows werden unterstützt zur Simulation unterstützt. Sowohl unter Windows als auch mit macOS wurden die Algorithmen ebenfalls in Verbindung mit dem Echtweltroboter getestet.

Dokumentation¶

Zum Erstellen der Dokumentation wurde ebenfalls python verwendet, um aus den MarkDown Dateien eine übersichtliche Website zu generieren. Die benötigten Pakete sind:

• mkdocs ~1.1
• mkdocstrings ~0.12
• pytkdocs ~0.7
• mkdocs-material ~5.5
• python-markdown-math ~0.7

Befehle¶

Vor dem Erstellen der Dokumentation sollte in robodk_config.py die Konstante DOCUMENTATION_BUILDING_WORK_AROUND auf True gesetzt werden, um zu verhindern, das RoboDK beim Generieren der Dokumentation gestartet wird. Hierbei wird das RoboDKInterface auf None gesetzt, was eine Ausführung des eigentlichen Programms verhindert. Ist die Ausführung des Programms erwünscht, sollte die oben genannte Konstante auf False gesetzt werden.

Zum Erstellen der Dokumentation gibt es hauptsächlich folgende zwei Befehle:

• mkdocs serve - Startet einen Server, der eine automatisch aktualisierte Version der Dokumentation bereitstellt.
• mkdocs build - Baut die Dokumentation einmalig und legt diese im ./site Verzeichnis ab. Gegebenenfalls ist hierfür use_directory_urls in der Konfigurationsdatei auf false zu setzen.

Die Konfiguration liegt in der Datei mkdocs.yml und kann dort nach Belieben angepasst werden.