"Formulieren Sie eine oder mehrere Forschungsfrage zu der Lerneinheit:"
"Formulieren Sie eine oder mehrere Forschungsfragen zu der Lerneinheit:"
]
},
{
...
...
@@ -39,8 +38,8 @@
"id": "531d890a",
"metadata": {},
"source": [
"### Hypothese\n",
"Formulieren Sie eine Hypothese zu diesem ersten Versuch:"
"### Versuchsziel\n",
"Formulieren Sie ein Versuchsziel für diesen ersten Versuch:"
]
},
{
...
...
@@ -64,7 +63,8 @@
"- Es muss sich durch den elektrischen Antrieb fortbewegen können. \n",
"- Die Verwendung eines Getriebes zwischen Motor und Antriebsachse(n) ist verpflichtend. \n",
"- Die Farbe von mindestens einem Teil soll sich von der in LeoCAD hinterlegten Standardfarbe unterscheiden.\n",
"- Es sind nur die gegebenen LEGO-Teile zu verwenden."
"- Es sind nur die LEGO-Teile zu verwenden, welche sich in den JSON-Dateien bzw. in\n",
"der zur Verfügung gestellten Teilebibliothek befinden."
]
},
{
...
...
@@ -72,7 +72,7 @@
"id": "0ebba2d8",
"metadata": {},
"source": [
"Fügen Sie eine Abbildung des fertigen Autos in LeoCAD hinzu (*Hinweise: Ein Bild lässt sich mit \\!\\[Bildbeschreibung](Pfad_zum_Bild) hinzufügen. Achten Sie darauf, das Bild später auch in Git hinzuzufügen*):\n"
"Fügen Sie eine Abbildung des fertigen Autos in LeoCAD hinzu (*Hinweise: Ein Bild lässt sich mit \\!\\[Bildbeschreibung](/Pfad/zum/Bild) hinzufügen. Achten Sie darauf, das Bild später auch in Git hinzuzufügen*):\n"
]
},
{
...
...
@@ -100,7 +100,7 @@
"id": "e622f83b",
"metadata": {},
"source": [
"Bauen Sie das Fahrzeug nun in unserem Software-Framework zusammen. Insanziieren Sie die LEGO-Teile und lesen Sie dabei auch die Eigenschaften ein. Ergänzen Sie zusätzliche Eigenschaften, wie z.B. die Farbe. Referenzieren Sie die Teile aufeinander und erstellen Sie auf diese Weise sinnvolle Bauteile, Baugruppen und das\n",
"Bauen Sie das Fahrzeug nun in unserem Software-Framework zusammen. Instanziieren Sie die LEGO-Teile und lesen Sie dabei auch die Eigenschaften ein. Ergänzen Sie zusätzliche Eigenschaften, wie z.B. die Farbe. Referenzieren Sie die Teile aufeinander und erstellen Sie auf diese Weise sinnvolle Bauteile, Baugruppen und das\n",
"Gesamtsystem. Nutzen Sie die hierfür bereitgestellten Klassendefinitionen und Methoden. Achten Sie auf eine gute Code-Dokumentation. Sie können sich für die Bearbeitung an den zur Verfügung gestellten Code-Zellen orientieren, können hiervon jedoch auch abweichen.\n",
"\n",
"*Hinweise: Achten Sie auf die Unterschiede zum Minimalbeispiel. Eine direkte Kopie ist nicht möglich. Achten Sie außerdem darauf, ein Teil (eindeutig identifiziert durch seine UUID) nicht an mehreren Stellen zu verbauen*"
...
...
@@ -108,17 +108,30 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 1,
"id": "690da270",
"metadata": {},
"outputs": [],
"source": [
"import json\n",
"import pprint\n",
"from functions import calculation_rules\n",
"from functions.classes import *"
]
},
{
"cell_type": "code",
"execution_count": 2,
"id": "ccaf3043",
"metadata": {},
"outputs": [],
"source": [
"# initialize componentens"
"# initialize components"
]
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 3,
"id": "36f981df",
"metadata": {},
"outputs": [],
...
...
@@ -128,7 +141,7 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 4,
"id": "da2d141c",
"metadata": {},
"outputs": [],
...
...
@@ -187,7 +200,7 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 5,
"id": "59eabafc",
"metadata": {},
"outputs": [],
...
...
@@ -197,7 +210,7 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 6,
"id": "c774b381",
"metadata": {},
"outputs": [],
...
...
@@ -210,12 +223,12 @@
"id": "b89e8fb9",
"metadata": {},
"source": [
"Exportieren Sie schließlich ihr entworfenes Fahrzeug inklusive der entwickelten KPI:"
"Exportieren Sie schließlich Ihr entworfenes Fahrzeug inklusive der entwickelten KPIs:"
]
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 7,
"id": "d518275f",
"metadata": {},
"outputs": [],
...
...
@@ -236,7 +249,7 @@
"id": "f8a2e1b0",
"metadata": {},
"source": [
"### Hypothese"
"### Versuchsziel"
]
},
{
...
...
@@ -254,7 +267,7 @@
"id": "f4c620ee",
"metadata": {},
"source": [
"Formulieren Sie eine Hypothese zu diesem Versuch:"
"Formulieren Sie ein Versuchsziel für diesen Versuch. Beschreiben Sie unter anderem, welche Verbesserung Sie vornehmen möchten:"
]
},
{
...
...
@@ -263,20 +276,6 @@
"metadata": {},
"source": []
},
{
"cell_type": "markdown",
"id": "3cef0828",
"metadata": {},
"source": [
"Beschreiben Sie, welche Verbesserung Sie vornehmen:"
]
},
{
"cell_type": "markdown",
"id": "00c9d739",
"metadata": {},
"source": []
},
{
"cell_type": "markdown",
"id": "73c454f2",
...
...
@@ -323,17 +322,17 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 8,
"id": "c35de753",
"metadata": {},
"outputs": [],
"source": [
"# initialize componentens"
"# initialize components"
]
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 9,
"id": "0b7336fb",
"metadata": {},
"outputs": [],
...
...
@@ -343,7 +342,7 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 10,
"id": "fb445ea0",
"metadata": {},
"outputs": [],
...
...
@@ -357,12 +356,12 @@
"metadata": {},
"source": [
"### Analyse\n",
"Bestimmen Sie die KPIs des zweiten Fahrzeuges"
"Bestimmen Sie die KPIs des zweiten Fahrzeugs"
]
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 11,
"id": "762a1e93",
"metadata": {},
"outputs": [],
...
...
@@ -372,7 +371,7 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 12,
"id": "1ed67328",
"metadata": {},
"outputs": [],
...
...
@@ -385,12 +384,12 @@
"id": "0f11b370",
"metadata": {},
"source": [
"Exportieren Sie ihr Fahrzeug inklusive der KPIs:"
"Exportieren Sie Ihr Fahrzeug inklusive der KPIs:"
]
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 13,
"id": "05d9d6f7",
"metadata": {},
"outputs": [],
...
...
@@ -403,7 +402,7 @@
"id": "e413cd84",
"metadata": {},
"source": [
"## Bewertung\n",
"## Diskussion\n",
"### Ergebnisse\n",
"Stellen Sie die entwickelten KPIs beider Fahrzeuge gegenüber und wählen Sie hierfür unter anderem eine geeignete\n",
"grafische Darstellung. Stellen Sie dabei insbesondere sicher, dass die Datengrundlage ersichtlich ist. Halten Sie\n",
...
...
@@ -412,7 +411,7 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 14,
"id": "b0f93e22",
"metadata": {},
"outputs": [],
...
...
@@ -425,7 +424,7 @@
"id": "6044de27",
"metadata": {},
"source": [
"Interpretieren Sie ihre Ergebnisse. Vergleichen Sie die KPIs ihrer Autos. Konnten Sie ihre gewünschte Verbesserung erzielen? Welche Schlüsse ziehen Sie aus den Ergebnissen für die Qualität der beiden\n",
"Interpretieren Sie Ihre Ergebnisse. Vergleichen Sie die KPIs Ihrer Autos. Konnten Sie Ihre gewünschte Verbesserung erzielen? Welche Schlüsse ziehen Sie aus den Ergebnissen für die Qualität der beiden\n",
"Fahrzeuge?"
]
},
...
...
@@ -440,7 +439,7 @@
"id": "4f117169",
"metadata": {},
"source": [
"Diskutieren Sie, inwieweit Ihre entickelten KPIs die im Skript erläuterten FAIR-Prinzipien erfüllen:"
"Diskutieren Sie, inwieweit Ihre entwickelten KPIs die im Skript erläuterten FAIR-Prinzipien erfüllen:"
]
},
{
...
...
@@ -449,6 +448,14 @@
"metadata": {},
"source": []
},
{
"cell_type": "markdown",
"id": "bfed164a",
"metadata": {},
"source": [
"## Fazit"
]
},
{
"cell_type": "markdown",
"id": "5d440f87",
...
...
@@ -481,7 +488,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.0"
"version": "3.9.13"
},
"varInspector": {
"cols": {
...
...
%% Cell type:markdown id:c9328cd1 tags:
# FAIRe Qualitäts-KPIs
Name:
Autor:
Datum:
%% Cell type:markdown id:1c5d41dc tags:
## Forschungsfrage
Formulieren Sie eine oder mehrere Forschungsfrage zu der Lerneinheit:
Formulieren Sie eine oder mehrere Forschungsfragen zu der Lerneinheit:
%% Cell type:markdown id:14e306b5 tags:
%% Cell type:markdown id:de070039 tags:
## Erstes Fahrzeug
%% Cell type:markdown id:531d890a tags:
### Hypothese
Formulieren Sie eine Hypothese zu diesem ersten Versuch:
### Versuchsziel
Formulieren Sie ein Versuchsziel für diesen ersten Versuch:
%% Cell type:markdown id:30ddd8dc tags:
%% Cell type:markdown id:50dd9ff3 tags:
### Versuchsaufbau
Bauen Sie ein erstes Fahrzeug aus den gegebenen LEGO-Teilen in der CAD-Software LeoCAD auf.
Hierbei gelten die folgenden Rahmenbedingungen:
- Das Fahrzeug muss aus Baugruppen, Bauteilen und Komponenten bestehen.
- Es muss mindestens vier Räder besitzen
- Es muss sich durch den elektrischen Antrieb fortbewegen können.
- Die Verwendung eines Getriebes zwischen Motor und Antriebsachse(n) ist verpflichtend.
- Die Farbe von mindestens einem Teil soll sich von der in LeoCAD hinterlegten Standardfarbe unterscheiden.
- Es sind nur die gegebenen LEGO-Teile zu verwenden.
- Es sind nur die LEGO-Teile zu verwenden, welche sich in den JSON-Dateien bzw. in
der zur Verfügung gestellten Teilebibliothek befinden.
%% Cell type:markdown id:0ebba2d8 tags:
Fügen Sie eine Abbildung des fertigen Autos in LeoCAD hinzu (*Hinweise: Ein Bild lässt sich mit \!\[Bildbeschreibung](Pfad_zum_Bild) hinzufügen. Achten Sie darauf, das Bild später auch in Git hinzuzufügen*):
Fügen Sie eine Abbildung des fertigen Autos in LeoCAD hinzu (*Hinweise: Ein Bild lässt sich mit \!\[Bildbeschreibung](/Pfad/zum/Bild) hinzufügen. Achten Sie darauf, das Bild später auch in Git hinzuzufügen*):
%% Cell type:markdown id:935c200c tags:
%% Cell type:markdown id:05a8eb21 tags:
Beschreiben Sie kurz und präzise Ihr Fahrzeug:
%% Cell type:markdown id:df7f1d01 tags:
%% Cell type:markdown id:e622f83b tags:
Bauen Sie das Fahrzeug nun in unserem Software-Framework zusammen. Insanziieren Sie die LEGO-Teile und lesen Sie dabei auch die Eigenschaften ein. Ergänzen Sie zusätzliche Eigenschaften, wie z.B. die Farbe. Referenzieren Sie die Teile aufeinander und erstellen Sie auf diese Weise sinnvolle Bauteile, Baugruppen und das
Bauen Sie das Fahrzeug nun in unserem Software-Framework zusammen. Instanziieren Sie die LEGO-Teile und lesen Sie dabei auch die Eigenschaften ein. Ergänzen Sie zusätzliche Eigenschaften, wie z.B. die Farbe. Referenzieren Sie die Teile aufeinander und erstellen Sie auf diese Weise sinnvolle Bauteile, Baugruppen und das
Gesamtsystem. Nutzen Sie die hierfür bereitgestellten Klassendefinitionen und Methoden. Achten Sie auf eine gute Code-Dokumentation. Sie können sich für die Bearbeitung an den zur Verfügung gestellten Code-Zellen orientieren, können hiervon jedoch auch abweichen.
*Hinweise: Achten Sie auf die Unterschiede zum Minimalbeispiel. Eine direkte Kopie ist nicht möglich. Achten Sie außerdem darauf, ein Teil (eindeutig identifiziert durch seine UUID) nicht an mehreren Stellen zu verbauen*
%% Cell type:code id:690da270 tags:
``` python
importjson
importpprint
fromfunctionsimportcalculation_rules
fromfunctions.classesimport*
```
%% Cell type:code id:ccaf3043 tags:
``` python
# initialize componentens
# initialize components
```
%% Cell type:code id:36f981df tags:
``` python
# set properties
```
%% Cell type:code id:da2d141c tags:
``` python
# aggregate components
```
%% Cell type:markdown id:c1fef7f0 tags:
### Analyse
Bestimmen Sie die Qualität Ihres Fahrzeugs mittels KPIs.
Die Qualität des Fahrzeugs ist mit mindestens einem KPI je Qualitätsdimension (Aufwand, Verfügbarkeit, Akzeptanz) zu bestimmen. Enwickeln Sie zunächst sinnvolle KPIs, welche mit den gegebenen Daten umsetzbar sind. Halten Sie die Berechnungsvorschriften im Jupyter Notebook fest. Implementieren Sie deren Berechnung für das Gesamtsystem "Fahrzeug" mittels einzelner Funktionen im Skript `calculation_rules`. Sie können zusätzlich Ihre Methoden auch auf die niedrigeren Aggregationsebenen anwenden.
%% Cell type:markdown id:d5f02096 tags:
Beschreiben Sie den jeweiligen KPI und geben Sie seine Berechnungsvorschrift an:
%% Cell type:markdown id:a793bce8 tags:
$$
a = \frac{b}{c} + d
$$
%% Cell type:markdown id:9a21b4ac tags:
%% Cell type:markdown id:e300a005 tags:
%% Cell type:markdown id:2aad773a tags:
Halten Sie die berechneten Werte für die KPIs im Notebook
fest:
%% Cell type:code id:59eabafc tags:
``` python
# calculate the KPIs for your car
```
%% Cell type:code id:c774b381 tags:
``` python
# print your KPIs
```
%% Cell type:markdown id:b89e8fb9 tags:
Exportieren Sie schließlich ihr entworfenes Fahrzeug inklusive der entwickelten KPI:
Exportieren Sie schließlich Ihr entworfenes Fahrzeug inklusive der entwickelten KPIs:
%% Cell type:code id:d518275f tags:
``` python
# export car and its properties
```
%% Cell type:markdown id:89c75440 tags:
## Zweites Fahrzeug
%% Cell type:markdown id:f8a2e1b0 tags:
### Hypothese
### Versuchsziel
%% Cell type:markdown id:80407e7f tags:
Setzen Sie sich ein Ziel, welche Qualitätsdimensionen in einem zweiten Fahrzeug verbessert werden sollen und bauen
Sie darauf aufbauend ein zweites Fahrzeug aus den gegebenen LEGO-Teilen auf.
Die Anforderungen an das Fahrzeug sind identisch zum ersten. Wählen Sie die Einzelteile und deren Zusammenspiel entsprechend Ihrer Zielstellung aus.
%% Cell type:markdown id:f4c620ee tags:
Formulieren Sie eine Hypothese zu diesem Versuch:
Formulieren Sie ein Versuchsziel für diesen Versuch. Beschreiben Sie unter anderem, welche Verbesserung Sie vornehmen möchten:
%% Cell type:markdown id:e3dc7e29 tags:
%% Cell type:markdown id:3cef0828 tags:
Beschreiben Sie, welche Verbesserung Sie vornehmen:
%% Cell type:markdown id:00c9d739 tags:
%% Cell type:markdown id:73c454f2 tags:
### Versuchsaufbau
%% Cell type:markdown id:2b381a60 tags:
Fügen Sie eine Abbildung des fertigen Autos in LeoCAD hinzu:
%% Cell type:markdown id:2b6e7f12 tags:
%% Cell type:markdown id:23c19009 tags:
Beschreiben Sie kurz und präzise den Aufbau des zweiten Fahrzeugs:
%% Cell type:markdown id:a08bf9cf tags:
%% Cell type:markdown id:14011b6f tags:
Erstellen Sie das Fahrzeug in unserem Softwareframework:
%% Cell type:code id:c35de753 tags:
``` python
# initialize componentens
# initialize components
```
%% Cell type:code id:0b7336fb tags:
``` python
# set properties
```
%% Cell type:code id:fb445ea0 tags:
``` python
# aggregate components
```
%% Cell type:markdown id:89e54480 tags:
### Analyse
Bestimmen Sie die KPIs des zweiten Fahrzeuges
Bestimmen Sie die KPIs des zweiten Fahrzeugs
%% Cell type:code id:762a1e93 tags:
``` python
# calculate the KPIs for your car
```
%% Cell type:code id:1ed67328 tags:
``` python
# print your KPIs
```
%% Cell type:markdown id:0f11b370 tags:
Exportieren Sie ihr Fahrzeug inklusive der KPIs:
Exportieren Sie Ihr Fahrzeug inklusive der KPIs:
%% Cell type:code id:05d9d6f7 tags:
``` python
# export car and its properties
```
%% Cell type:markdown id:e413cd84 tags:
## Bewertung
## Diskussion
### Ergebnisse
Stellen Sie die entwickelten KPIs beider Fahrzeuge gegenüber und wählen Sie hierfür unter anderem eine geeignete
grafische Darstellung. Stellen Sie dabei insbesondere sicher, dass die Datengrundlage ersichtlich ist. Halten Sie
auch die Plotbefehle im Notebook fest:
%% Cell type:code id:b0f93e22 tags:
``` python
# plot the data, save diagramm as svg-file
```
%% Cell type:markdown id:6044de27 tags:
Interpretieren Sie ihre Ergebnisse. Vergleichen Sie die KPIs ihrer Autos. Konnten Sie ihre gewünschte Verbesserung erzielen? Welche Schlüsse ziehen Sie aus den Ergebnissen für die Qualität der beiden
Interpretieren Sie Ihre Ergebnisse. Vergleichen Sie die KPIs Ihrer Autos. Konnten Sie Ihre gewünschte Verbesserung erzielen? Welche Schlüsse ziehen Sie aus den Ergebnissen für die Qualität der beiden
Fahrzeuge?
%% Cell type:markdown id:0ca884b1 tags:
%% Cell type:markdown id:4f117169 tags:
Diskutieren Sie, inwieweit Ihre entickelten KPIs die im Skript erläuterten FAIR-Prinzipien erfüllen:
Diskutieren Sie, inwieweit Ihre entwickelten KPIs die im Skript erläuterten FAIR-Prinzipien erfüllen:
%% Cell type:markdown id:f8ed82d2 tags:
%% Cell type:markdown id:bfed164a tags:
## Fazit
%% Cell type:markdown id:5d440f87 tags:
Ziehen Sie ein persönliches Fazit. Was haben Sie Neues gelernt?
"FAIR Quality KPIs schaffen eine transparente und nachvollziehbare Entscheidungsgrundlage. In dieser Lerneinheit sollen sie die Methodik erlernen, indem sie LEGOAutos zusammenbauen, deren Quality KPIs bestimmen und miteinander vergleichen.\n",
"FAIRe Qualitäts-KPIs schaffen eine transparente und nachvollziehbare Entscheidungsgrundlage. In dieser Lerneinheit sollen sie die Methodik erlernen, indem sie LEGO-Autos zusammenbauen, deren Quality KPIs bestimmen und miteinander vergleichen.\n",
"\n",
"### Werkzeug für den Zusammenbau\n",
"Der Zusammenbau der Autos erfolgt virtuell. Als Werkzeug steht Ihnen das Modul `classes` zur Verfügung. In diesem sind unterschiedliche Klassen und Methoden implementiert (Objektorientierung). Sie erzeugen jeweils Objekte der Klassen. Ein Objekt ist dabei die virtuelle Abbildung eines realen Bauteiles. Die Eigenschaften des Bauteiles werden über die Eigenschaften des Objektes abgebildet.\n",
...
...
@@ -46,7 +46,7 @@
"metadata": {},
"source": [
"#### Versuchsaufbau:\n",
"Die folgende Abbildung zeugt den Versuchsaufbau für das Tretrollerbeispiel in LeoCAD. Die transparenten Bauteile Sind dabei nicht Teil des hier erläuterten Zusammenbaus, können aber mit dem zur Verfügung gestellten Baukasten ergänzt werden:"
"Die folgende Abbildung zeigt den Versuchsaufbau des Minimalbeispiels in LeoCAD. Die transparenten Bauteile sind dabei nicht Teil des hier erläuterten Zusammenbaus, können aber mit dem zur Verfügung gestellten Baukasten ergänzt werden:"
]
},
{
...
...
@@ -65,14 +65,14 @@
"source": [
"### Modul classes\n",
"Enthält `LegoComponent, LegoAssembly, AggregationLayer, KPIEncoder` und die Funktion `print_assembly_tree`. \n",
"`LegoComponent` bildet einzelne Komponenten ab, während `LegoAssembly` zusammengesetzte Aggregationsebenen abdeckt, also Bauteil, Baugruppe und System. Zur Unterscheidung dient die Klasse Aggregationlayer, diese ist für `LegoComponent` immer `Component` (Komponente), muss für `LegoAssembly` entsprechend auf `SYSTEM`(System) , `ASSEMBLY`(Baugruppe) oder `SUBASSEMBLY`(Bauteil) gesetzt werden.\n",
"`LegoComponent` bildet einzelne Komponenten ab, während `LegoAssembly` zusammengesetzte Aggregationsebenen abdeckt, also Bauteil, Baugruppe und System. Zur Unterscheidung dient die Klasse `AggregationLayer`, diese ist für `LegoComponent` immer `Component` (Komponente), muss für `LegoAssembly` entsprechend auf `SYSTEM`(System) , `ASSEMBLY`(Baugruppe) oder `SUBASSEMBLY`(Bauteil) gesetzt werden.\n",
"\n",
"Wir bauen aus Achse, Rahmen und Reifen einen Tretroller zusammen."
"[LegoComponent scooter frame [a90b291e-696c-41c7-b9b8-43d34724b460], LegoComponent front wheel [b03ce5b5-9c6c-4315-a67b-902c729c3d7b], LegoComponent front axle [64771daf-733a-4a2a-8520-9fa94259e50e], LegoComponent back wheel [8fcb7db9-6fec-4e70-b274-0c4fe403550b], LegoComponent back axle [2ce57b96-64b8-48b1-aac8-b0731adaa93b]]\n"
]
}
],
"source": [
"# Look at the assembly\n",
"\n",
"# We can get all LegoComponents from this assembly.\n",
"# Without parameter 'max_depth' only direct children will be listed.\n",
"scooter.get_component_list(5)"
"# If parameter 'max_depth' is set to 0, only direct children will be listed:\n",
"# If it is set to -1 (default), all LegoComponents are listed:\n",
"print(scooter.get_component_list())"
]
},
{
...
...
@@ -236,15 +293,23 @@
"source": [
"### Modul calculation_rules\n",
"\n",
"Um für unser System \"Tretroller\" ein KPI für das Gesamtgewicht zu erzeugen, wurde in `functions.calculation_rules` die Funktion `kpi_sum` definiert. Zusammen mit den Hilfsfunktionen der Klasse können wir nun das KPI Gewicht für das System hinzufügen. Die Massen der einzelnen Komponenten sind in den Datenblättern unter `mass [g]` enthalten."
"Um für unser System \"Tretroller\" einen KPI zu erzeugen, wird die Masse des Systems betrachtet. Die Masse der einzelnen Komponenten ist in den Datenblättern unter `mass [g]` enthalten."
"# Each part created has a unique identifier (the long number in [])\n",
"# Don't try add the identical part again."
"# Don't try to add the identical part again."
]
}
],
...
...
@@ -370,7 +479,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.0"
"version": "3.9.13"
},
"varInspector": {
"cols": {
...
...
%% Cell type:markdown id:c9328cd1 tags:
# FAIRe Qualitäts-KPI
# FAIRe Qualitäts-KPIs
%% Cell type:markdown id:2ee8746d tags:
## Einführung
FAIR Quality KPIs schaffen eine transparente und nachvollziehbare Entscheidungsgrundlage. In dieser Lerneinheit sollen sie die Methodik erlernen, indem sie LEGOAutos zusammenbauen, deren Quality KPIs bestimmen und miteinander vergleichen.
FAIRe Qualitäts-KPIs schaffen eine transparente und nachvollziehbare Entscheidungsgrundlage. In dieser Lerneinheit sollen sie die Methodik erlernen, indem sie LEGO-Autos zusammenbauen, deren Quality KPIs bestimmen und miteinander vergleichen.
### Werkzeug für den Zusammenbau
Der Zusammenbau der Autos erfolgt virtuell. Als Werkzeug steht Ihnen das Modul `classes` zur Verfügung. In diesem sind unterschiedliche Klassen und Methoden implementiert (Objektorientierung). Sie erzeugen jeweils Objekte der Klassen. Ein Objekt ist dabei die virtuelle Abbildung eines realen Bauteiles. Die Eigenschaften des Bauteiles werden über die Eigenschaften des Objektes abgebildet.
### Berechnung der Quality KPIs
KPIs (Key Performance Indikatoren) sind Kenngrößen des Systems. Sie werden über Berechnungsvorschriften bestimmt. Diese Berechnungsvorschriften sind von Ihnen als python-Funktionen im Modul `calculation_rules` zu implementieren.
### Datenblätter
Für den Zusammenbau stehen Ihnen verschiedene Bauteile in unterschiedlichen Ausführungen zur Verfügung. Sie nutzen die Datenblätter, die als `json-Dateien` zur Verfügung gestellt werden, um Ihre Autos zusammenzubauen.
%% Cell type:markdown id:1c702114 tags:
## Eigene Module und Minimalbeispiel
Für die Ausarbeitung nutzen wir zwei eigene Module (Python-Dateien), die im Ordner `functions` gespeichert sind.
Das Modul `calculation_rules` erweitern Sie während der Ausarbeitung. Um die Änderungen zu nutzen, müssen Sie das Notebook neu starten.
Im Modul `classes` befinden sich die komplette Klassen und Funktionen zur Verwendung.
Mit einem Minimalbeispiel wird Ihnen gezeigt, wie sie die Module nutzen.
%% Cell type:markdown id:670118b3 tags:
#### Versuchsaufbau:
Die folgende Abbildung zeugt den Versuchsaufbau für das Tretrollerbeispiel in LeoCAD. Die transparenten Bauteile Sind dabei nicht Teil des hier erläuterten Zusammenbaus, können aber mit dem zur Verfügung gestellten Baukasten ergänzt werden:
Die folgende Abbildung zeigt den Versuchsaufbau des Minimalbeispiels in LeoCAD. Die transparenten Bauteile sind dabei nicht Teil des hier erläuterten Zusammenbaus, können aber mit dem zur Verfügung gestellten Baukasten ergänzt werden:
%% Cell type:markdown id:2f969ed9 tags:

%% Cell type:markdown id:6d3310be tags:
### Modul classes
Enthält `LegoComponent, LegoAssembly, AggregationLayer, KPIEncoder` und die Funktion `print_assembly_tree`.
`LegoComponent` bildet einzelne Komponenten ab, während `LegoAssembly` zusammengesetzte Aggregationsebenen abdeckt, also Bauteil, Baugruppe und System. Zur Unterscheidung dient die Klasse Aggregationlayer, diese ist für `LegoComponent` immer `Component` (Komponente), muss für `LegoAssembly` entsprechend auf `SYSTEM`(System) , `ASSEMBLY`(Baugruppe) oder `SUBASSEMBLY`(Bauteil) gesetzt werden.
`LegoComponent` bildet einzelne Komponenten ab, während `LegoAssembly` zusammengesetzte Aggregationsebenen abdeckt, also Bauteil, Baugruppe und System. Zur Unterscheidung dient die Klasse `AggregationLayer`, diese ist für `LegoComponent` immer `Component` (Komponente), muss für `LegoAssembly` entsprechend auf `SYSTEM`(System) , `ASSEMBLY`(Baugruppe) oder `SUBASSEMBLY`(Bauteil) gesetzt werden.
Wir bauen aus Achse, Rahmen und Reifen einen Tretroller zusammen.
%% Cell type:code id:b2778dee tags:
``` python
# import modules
importjson
importpprint
fromfunctionsimportcalculation_rules
# Importing all modules one by one to provide an overview
# The next commented line would provide the same result in one line
# from functions.classes import *
fromfunctions.classesimportLegoComponent
fromfunctions.classesimportLegoAssembly
fromfunctions.classesimportAggregationLayer
fromfunctions.classesimportKPIEncoder
fromfunctions.classesimportprint_assembly_tree
# When you are writing code yourself later, you might want to copy
# these imports to avoid rerunning the full notebook after restart
```
%% Cell type:code id:0b1f9aff tags:
``` python
# Create the wheels and axles as single components first
# Look up the specific item you want from the provided json files,
[LegoComponent scooter frame [a90b291e-696c-41c7-b9b8-43d34724b460], LegoComponent front wheel [b03ce5b5-9c6c-4315-a67b-902c729c3d7b], LegoComponent front axle [64771daf-733a-4a2a-8520-9fa94259e50e], LegoComponent back wheel [8fcb7db9-6fec-4e70-b274-0c4fe403550b], LegoComponent back axle [2ce57b96-64b8-48b1-aac8-b0731adaa93b]]
%% Cell type:markdown id:001f1c77 tags:
### Modul calculation_rules
Um für unser System "Tretroller" ein KPI für das Gesamtgewicht zu erzeugen, wurde in `functions.calculation_rules` die Funktion `kpi_sum` definiert. Zusammen mit den Hilfsfunktionen der Klasse können wir nun das KPI Gewicht für das System hinzufügen. Die Massen der einzelnen Komponenten sind in den Datenblättern unter `mass [g]` enthalten.
Um für unser System "Tretroller" einen KPI zu erzeugen, wird die Masse des Systems betrachtet. Die Masse der einzelnen Komponenten ist in den Datenblättern unter `mass [g]` enthalten.
In dieser exportierten json-Datei ('scooter.json') sind die Werte maschinen- und menschenlesbar hinterlegt.
Zusammen mit der Berechnungsvorschrift in `calculation_rules` ist auch die Entstehung des KPI nachvollziehbar und wiederverwendbar dokumentiert und damit 'FAIR'.