Started function to convert units of vessel capability specs - not working yet

Author: mattEhall

famodel/irma/irma.py

@@ -87,7 +87,46 @@ def loadYAMLtoDict(info, already_dict=False):
 #def applyState():
 
 
-
+def unifyUnits(d):
+    '''Converts any capability specification/metric in supported non-SI units
+    to be in SI units. Converts the key names as well.'''
+    
+    # >>> not working yet <<<
+    
+    
+    # load conversion data from YAML (eventually may want to store this in a class)
+    with open('spec_conversions.yaml') as file:
+        data = yaml.load(file, Loader=yaml.FullLoader)
+    
+    keys1 = []
+    facts = []  # conversion factors
+    keys2 = []
+    
+    for line in data:
+        keys1.append(line[0])
+        facts.append(line[1])
+        keys2.append(line[2])
+        
+    # >>> dcopy = deepcopy(d)
+    
+    for asset in d.values():  # loop through each asset's dict
+        for capability in asset['capabilities'].values():
+            for key, val in capability.items():  # look at each capability metric
+                try:
+                    i = keys1.index(key)  # find if key is on the list to convert
+                    
+                    
+                    if keys2[i] in capability.keys():
+                        raise Exception(f"Specification '{keys2[i]}' already exists")
+                    
+                    capability[keys2[i]] = val * facts[i]  # create a new SI entry
+                    
+                    breakpoint()
+                    
+                    del capability[keys1[i]]  # remove the original?
+                    
+                except:
+                    print('not found')
 
 
 class Scenario():
@@ -105,6 +144,7 @@ def __init__(self):
         vessels = loadYAMLtoDict('vessels.yaml', already_dict=True)
         objects = loadYAMLtoDict('objects.yaml', already_dict=True)
 
+        #unifyUnits(vessels)  # (function doesn't work yet!) <<<
 
         # ----- Validate internal cross references -----
 

famodel/irma/spec_conversions.yaml

@@ -0,0 +1,19 @@
+# This file specifies optional capability specification keys that can be used
+# to support inputs in common industry units rather than SI units.
+
+# format:   key name with common unit, conversation factor from common->SI, fundamental key name (SI unit),  
+- [ area_sqf            , 0.092903 , area              ]
+- [ max_load_t          , 9806.7   , max_load          ]
+- [ volume_cf           , 0.028317 , volume            ]
+- [ max_line_pull_t     , 9806.7   , max_line_pull     ]  # continuous line pull [t]
+- [ brake_load_t        , 9806.7   , brake_load        ]  # static brake holding load [t]
+- [ speed_mpm           , 0.01667  , speed             ]  # payout/haul speed [m/min] -> m/s
+- [ max_force_t         , 9806.7   , max_force         ]  # bollard pull [t]
+- [ capacity_t          , 9806.7   , capacity          ]  # SWL at specified radius [t]
+- [ hook_height_ft      , 0.3048   , hook_height       ]  # max hook height [m]
+- [ towing_pin_rating_t , 9806.7   , towing_pin_rating ]  # rating of towing pins [t] (optional)
+- [ power_kW            , 1000.0   , power             ]  # W
+- [ pressure_bar        , 1e5      , pressure          ]  # Pa
+- [ weight_t            , 9806.7   , weight            ]  # N or should this be mass in kg?
+- [ centrifugal_force_kN, 1000.0   , centrifugal_force ]
+- [ torque_kNm          , 1000.0   , torque            ]