main_kpi.py

-"""
-FAIR Quality KPIs
-
-"""
-
-
-def main():
-    print("Hello ;-)")
-    pass
-
-
-if __name__ == "__main__":
-    main()

requirements.txt

-pandas
-tables

test-classes.ipynb

-%% Cell type:code id: tags:
-
-``` python
-# import functions.lego_classes as lego_classes
-from functions.classes import LegoItem
-from functions.classes import LegoComponent
-```
-
-%% Cell type:code id: tags:
-
-``` python
-# Test manually creating some item and components
-
-item1 = LegoItem(1,0.10,10)
-item2 = LegoItem(3,0.30,30)
-item3 = LegoItem(2, 0.2,20)
-
-
-
-component1 = LegoComponent()
-# component1.add_item(item1)
-component2 = LegoComponent(item2)
-
-componentall = LegoComponent([component1,component2]) # This will be saved as items for some reasaon
-# component3 = LegoComponent(item3,component1)
-# component3.add(item2) # Can't really use an item twice
-# component3.add(component2)
-print(componentall.items)
-```
-
-%% Output
-
-    [<functions.lego_classes.LegoComponent object at 0x000002720F4BF7F0>, <functions.lego_classes.LegoComponent object at 0x000002720F4BF790>]
-
-%% Cell type:code id: tags:
-
-``` python
-```
-
-%% Cell type:code id: tags:
-
-``` python
-## Let's test the json stuff
-import json
-# import tkinter as tk
-```
-
-%% Cell type:code id: tags:
-
-``` python
-# First level list handling
-
-def read_json(file_path):
-    with open(file_path, 'r') as f:
-        data = json.load(f)
-    return data
-json_list_data = read_json('example_item_data_list.json')
-# that produces a list, we'd prefer a dict
-
-# Clever way to just create an item for each listed element
-def create_all_items(data):
-    items = []
-    for item_data in data:
-        item_number = item_data.get('item_number')
-        mass = item_data.get('mass')
-        delivery_time = item_data.get('delivery_time')
-        # specific_data = item_data.get('specific_data', {})
-        item = LegoItem(item_number, mass, delivery_time)
-        items.append(item)
-    return items
-
-all_items = create_all_items(json_list_data)
-
-# How to get entries for a specific item
-def get_item_by_number(data, item_number):
-    datasheet = [item for item in data if item['item_number' ] == item_number]
-    return datasheet
-
-sheet1 = get_item_by_number(json_list_data, 2) # this is a list? meh
-
-```
-
-%% Cell type:code id: tags:
-
-``` python
-# vs first level dict handling
-
-with open('example_item_data_dict.json') as json_file:
-    json_dict = json.load(json_file)
-    print(type(json_dict))
-    print(json_dict["1"])
-
-sheet2_from_dict = json_dict["2"]
-# Create an item for this:
-def create_item_from_sheet(dict):
-    item_number = dict["item_number"]
-    mass = dict["mass"]
-    delivery_time =["delivery_time"]
-    item = LegoItem(item_number, mass, delivery_time)
-    return item
-
-itemfromdict = create_item_from_sheet(sheet2_from_dict)
-
-```
-
-%% Output
-
-    <class 'dict'>
-    {'item_number': 1, 'mass': 10, 'delivery_time': 1}

test-classes.py

-# import standard libraries
-import json
-import pprint
-
-# import classes from the classes module in functions package
-from functions.classes import LegoComponent
-from functions.classes import LegoAssembly
-from functions.classes import ComponentCategory
-from functions.classes import AggregationLayer
-from functions.classes import KPIEncoder
-from functions.classes import print_assembly_tree
-
-from functions.calculation_rules import kpi_sum
-# Test manually creating some assemblies and components
-
-battery = LegoComponent("nice battery", ComponentCategory.BATTERY, "bat42", 1, 2, 3)
-motor = LegoComponent("motor goes brrr", ComponentCategory.MOTOR, "motor", 1, 2, 3)
-wheel = LegoComponent("much round wheel", ComponentCategory.WHEEL, "round", 1, 2, 3)
-
-
-# Create subassemblies and combine to assembly (currently no parts present for this)
-chassis = LegoAssembly("Chassis", AggregationLayer.ASSEMBLY)
-door1 = LegoAssembly("Door 1", AggregationLayer.SUBASSEMBLY)
-door2 = LegoAssembly("Door 2", AggregationLayer.SUBASSEMBLY)
-chassis.add_assembly(door1)
-chassis.add_assembly(door2)
-chassis.properties
-
-engine = LegoAssembly("Engine", AggregationLayer.ASSEMBLY)
-# Showcase cloning - one motor for each axis?
-engine.add_component(motor.clone())
-
-
-fuel_tank = LegoAssembly("Fuel Tank", AggregationLayer.ASSEMBLY)
-fuel_tank.add_component(battery.clone())
-
-
-wheels = LegoAssembly("Wheels", AggregationLayer.ASSEMBLY)
-for _ in range(4):
-    wheels.add_component(wheel.clone())
-
-
-# Create and assemble the system level car
-car = LegoAssembly("Car", AggregationLayer.SYSTEM)
-car.add_assembly(chassis)
-car.add_assembly(engine)
-car.add_assembly(fuel_tank)
-car.add_assembly(wheels)
-
-
-## Printing
-
-print_assembly_tree(car)
-
-# Dump to json file
-with open("car.json", "w") as fp:
-    json.dump(car.to_dict(), fp, cls=KPIEncoder)
-
-pprint.pprint(car.to_dict())
-pass
-
-
-## Create components from datasheet
-# Need to run the script from datasheets folder first
-# Test loading dicts from datasheet jsons
-
-with open('datasheets/Achsen.json') as json_file:
-    Achsen = json.load(json_file)
-
-print((Achsen["Achse 5 studs"]))
-
-# This is hard to read, prettier please!
-
-pprint.pprint(Achsen)
-
-# Okay I'll use the 5 stud one
-Achse5 = Achsen["Achse 5 studs"] # I'd prefer to call it via "Designnummer"
-print(Achsen["Achse 5 studs"]["Designnummer"])
-
-with open('datasheets/Räder.json') as json_file:
-    Raeder = json.load(json_file)
-# Get me the expensive one
-Radpreis = []
-for key in Raeder: # a list would work easier here than a dict
-    Radpreis.append(Raeder[key]["Preis [Euro]"])
-Radpreis = max(Radpreis)
-for key in Raeder:
-    if Raeder[key]["Preis [Euro]"] == Radpreis:
-        TeuresRad=Raeder[key]
-
-# Also need a frame
-with open('datasheets/Gestell.json') as json_file:
-    Gestelle = json.load(json_file)
-Gestellbeschreibung = "Technic, Brick 1 x 8 with Holes"
-Gestell = Gestelle[Gestellbeschreibung]
-
-# Create Components from these items
-# LegoComponent(name: str, category: ComponentCategory, lego_id: str, cost: float,
-# mass: float, delivery_time: int, layer: AggregationLayer = AggregationLayer.COMPONENT, **properties)
-scooterframe = LegoComponent("running board", ComponentCategory.FRAME,
-                            Gestell["Designnummer"],
-                            Gestell["Preis [Euro]"], Gestell["Gewicht [g]"],
-                            0)
-
-scooterwheel = LegoComponent("Vorderrad", ComponentCategory.WHEEL,
-                            TeuresRad["Designnummer"],
-                            TeuresRad["Preis [Euro]"], TeuresRad["Gewicht [g]"],
-                            0)
-
-# TODO component with copy of dict from json
-# Cloning is necessary because each lego object gets a unique id so you can't use the same part twice
-scooterwheel2 = scooterwheel.clone()
-scooterwheel2.description = "Hinterrad"
-print([scooterwheel.uuid, scooterwheel2.uuid])
-
-
-# Lets Assembly, first the Assembly object, directly add the frame?
-scooter = LegoAssembly("my first scooter", AggregationLayer.SYSTEM)
-scooter.add_component(scooterframe) # only one per call for now
-scooter.add_component(scooterwheel)
-scooter.add_component(scooterwheel2)
-# <Assembly>.add_assembly() works in the same way
-
-# Look at our work:
-print(scooter)
-print(scooter.children())
-
-## First KPI mass should be a sum
-listofmasses= []
-for c in scooter.components:
-    listofmasses.append(c.mass)
-for a in scooter.assemblies:
-    # only checking one layer deep here
-    listofmasses.append(a.mass)
-
-# TODO example with get_component_list
-
-print(listofmasses)
-print(kpi_sum(listofmasses))
-
-print("theend")
\ No newline at end of file