From a240d29c6f027c4a7a5e28fcf1b832466e55bc88 Mon Sep 17 00:00:00 2001 From: Tobias Meck <tobias.meck@tu-darmstadt.de> Date: Mon, 23 Oct 2023 00:13:57 +0200 Subject: [PATCH] Update README.md to match current repo structure and task description --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1d2b414..4e59499 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,29 @@ # Lerneinheit FAIRe Qualitäts-KPIs ## Einführung -Siehe Aufgabenstellung in Moodle. +Siehe Skript und Aufgabenstellung in [moodle](https://moodle.tu-darmstadt.de/course/view.php?id=36368§ion=3#tabs-tree-start). ## Materialien -Die Aufgabenstellung im PDF-Format steht in Moodle bereit. - In diesem GitLab Repo finden Sie: -- Package *functions* (`functions/`): Beinhaltet die Module *classes* und *calculation_rules* -- Modul classes (`functions/classes.py`): Werkzeuge zum Aufbau und zur Bearbeitung der LEGO Konstruktionen -- Modul calculation_rules (`functions/calculation_rules.py`): Funktionen zum Berechnen der FAIR Quality KPIs -- Datenblätter (`datasheets/`): Datenblätter ausgewählter LEGO Komponenten im JSON-Format -- Jupyter Notebook (`ausarbeitung.ipynb`): Zur Bearbeitung der Aufgaben und Abgabe. Beinhaltet ein Minimalbeispiel zur Verwendung der Werkzeuge. - +- Package functions (`functions/`): Beinhaltet die Module `classes` und `calculation_rules` +- Modul classes (`functions/classes.py`): Werkzeuge zum Aufbau und zur Bearbeitung der LEGO-Konstruktionen +- Modul calculation_rules (`functions/calculation_rules.py`): Funktionen zum Berechnen der FAIRen +Qualitäts-KPIs +- Python-Hilfsdatei (`functions/__init__.py`): Notwendige Datei für die Erzeugung eines Python-Pakets +- Datenblätter (`datasheets/`): Datenblätter ausgewählter LEGO-Komponenten im JSON-Format +- Teilebibliothek (`LeoCAD/library.bin`): Teilebibliothek für das Programm LeoCAD +- Abbildungsordner (`figures`): Ordner zum Ablegen der LeoCAD-Screenshots +- Beispiel-Notebook (`minimalbeispiel.ipynb`): Einführendes Beispiel zur Verwendung der Werkzeuge +- Ausarbeitungs-Notebook (`ausarbeitung.ipynb`): Vorlage zur Bearbeitung der Aufgaben und Abgabe ## Ausarbeitung Die Ausarbeitung erfolgt im Notebook `ausarbeitung.ipynb`. In diesem ist bereits eine Gliederung vorgegeben. ## Abgabe -Die Abgabe erfolgt über moodle. +Die Abgabe erfolgt über [moodle](https://moodle.tu-darmstadt.de/mod/assign/view.php?id=1249192). Committen und pushen Sie zunächst Ihre Änderungen auf GitLab und laden Sie von dort Ihr gesamtes Repo als .zip-Datei herunter (ein direkter Download vom JupyterHub ist leider nicht möglich). Benennen Sie die .zip-Datei nach dem folgenden Schema: +<p style="text-align: center;"> <Nachname>_<Vorname>_<MATR-NR>_<GRUPPEN-NR>_le_1.zip</p> +Abgaben, die diese Namenskonvention nicht erfüllen, können in der Bewertung nicht berücksichtigt werden. +Laden Sie diese .zip-Datei in moodle hoch. Insbesondere sollten vorhanden sein: +- Jupyter Notebook mit Erklärungen und Darstellungen von LeoCAD +- Python-Funktionen für die Berechnung der KPIs +- Die exportierte(n) JSON-Datei(en) des Fahrzeuges (inkl. der hinzugefügten KPIs) \ No newline at end of file -- GitLab