fix: separate units/slots

Author: jaydesl

docs/attributes/slots.md

@@ -70,17 +70,19 @@ has these fields:
 
 `units`{ #units }
 
-:   **Optional**-*obj (see subkeys below)*<br>
+:   **Optional**-*[Units](units.md)*<br>
     Values related to the slot measurement units
 
 
 `default_value`{ #default-value }
 
 :   **Optional**-*number | null*<br>
-    default value for in-slot, if null then the value for the in-slot needs
-    to be set/fed at a later point in time.
+    default value for in-slot, if null then the value for the in-slot
+    needs to be set/fed at a later point in time.
 
-    Default value must not be set for out-slots!
+    !!! warning
+        
+        Default value must not be set for out-slots!
 
 
 

docs/attributes/units.md

@@ -15,23 +15,58 @@ has these fields:
 `unit`{ #unit }
 
 :   **Optional**-*string*<br>
-    
+    human readable unit symbol, here N for Newton
+
+
+    === "Example"
+        ``` yaml     
+        N
+        ```
 
 
 `exponent`{ #exponent }
 
-:   **Optional**-*integer[]*<br>
-    
+:   **Optional**-*number[]*<br>
+    7-tuple of integer-valued exponents*- Ordered list of SI base units
+
+    - 1st entry: Length - meter (m)
+    - 2nd entry: Time - second (s)
+    - 3rd entry: Amount of substance - mole (mol)
+    - 4th entry: Electric current - ampere (A)
+    - 5th entry: Temperature - kelvin (K)
+    - 6th entry: Luminous intensity - candela (cd)
+    - 7th entry: Mass - kilogram (kg)
+      
+    !!! note "Explanation"
+
+        the exponents reference the above SI base units in the
+        corresponding order to describe the unit w.r.t. the base SI units,
+        the entries [1, -2, 0, 0, 0, 0, 1] thus denote m s⁻² kg, i.e., Newton
+
 
 
 `offset`{ #offset }
 
-:   **Optional**-*integer*<br>
-    
+:   **Optional**-*number*<br>
+    default value is 0*- allows to offset the values by adding a constant,
+    e.g., Celsius is offset by 273.15 relative to Kelvin (C + 273.15 = K).
+    !!! warning
+
+        For absolute temperatures only! For temperature
+        *differences*, this must be omitted!
+
 
 
 `scale`{ #scale }
 
-:   **Optional**-*integer*<br>
-    
+:   **Optional**-*number*<br>
+    default value is 1*- allows to scale the values into base units,
+    e.g., 1e-3 to describe mm (millimeters) in terms of m (meters)
+
+
+
+    === "Example"
+        ``` yaml     
+        1
+        ```
 

docs/custom_definitions/slots.yaml

@@ -1,9 +1,11 @@
 default_value:
   description: |
-    default value for in-slot, if null then the value for the in-slot needs
-    to be set/fed at a later point in time.
-
-    Default value must not be set for out-slots!
+    default value for in-slot, if null then the value for the in-slot
+    needs to be set/fed at a later point in time.
+    
+    !!! warning
+        
+        Default value must not be set for out-slots!
   type: number | null
 dimensions:
   description: dimension of inputs to in-slot, array of dimensions for matrices /
@@ -14,17 +16,6 @@ dimension_names:
   description: 'optional list of concise names of each tensor dimension to indicate
     expected contents, e.g., "dimension_names": ["batch", "channels", "width", "height"]'
   type: array of strings matching length of dimension | null
-exponents:
-  description: 'Ordered list of SI base units<br>          1st entry: Length - meter
-    (m)<br>          2nd entry: Time - second (s)<br>          3rd entry: Amount of
-    substance - mole (mol)<br>          4th entry: Electric current - ampere (A)<br>          5th
-    entry: Temperature - kelvin (K)<br>          6th entry: Luminous intensity - candela
-    (cd)<br>          7th entry: Mass - kilogram (kg)<br><br>Explanation: the exponents
-    reference the above SI base units in the corresponding order to describe the unit
-    w.r.t. the base SI units, the entries [1, -2, 0, 0, 0, 0, 1] thus denote m s⁻²
-    kg, i.e., Newton'
-  example: '[1, -2, 0, 0, 0, 0, 1]'
-  type: array, 7-tuple of integer-valued exponents
 is_continuous:
   description: flag to indicate whether slot values are integer or real numbers
   example:
@@ -39,25 +30,11 @@ name:
   description: Human-readable identifier
   example: Force at Boundary Condition 1
   type: string
-name_of_unit:
-  description: human readable unit symbol, here N for Newton
-  example: N
-  type: string
-offset:
-  description: allows to offset the values by adding a constant, e.g., Celsius is
-    offset by 273.15 relative to Kelvin (C + 273.15 = K).<br>For absolute temperatures
-    only! For temperature *differences*, this must be omitted!
-  type: number, default value is 0
 ranges:
   description: 'valid range of values (2-tuple array minimum maximum values OR array
     of discrete valid scalars).<br>If a valid range is not known a-priori: null /
     omitted'
   type: array | null
-scale_factor:
-  description: allows to scale the values into base units, e.g., 1e-3 to describe
-    mm (millimeters) in terms of m (meters)
-  example: 1
-  type: number, default value is 1
 units:
   description: Values related to the slot measurement units
-  type: obj (see subkeys below)
+  type: "[Units](units.md)"

docs/custom_definitions/units.yaml

@@ -0,0 +1,40 @@
+unit:
+  description: human readable unit symbol, here N for Newton
+  type: string
+  example: N
+
+exponent:
+  description: |
+    7-tuple of integer-valued exponents*- Ordered list of SI base units
+
+    - 1st entry: Length - meter (m)
+    - 2nd entry: Time - second (s)
+    - 3rd entry: Amount of substance - mole (mol)
+    - 4th entry: Electric current - ampere (A)
+    - 5th entry: Temperature - kelvin (K)
+    - 6th entry: Luminous intensity - candela (cd)
+    - 7th entry: Mass - kilogram (kg)
+      
+    !!! note "Explanation"
+
+        the exponents reference the above SI base units in the
+        corresponding order to describe the unit w.r.t. the base SI units,
+        the entries [1, -2, 0, 0, 0, 0, 1] thus denote m s⁻² kg, i.e., Newton
+  type: number[]
+
+offset:
+  description: |
+    default value is 0*- allows to offset the values by adding a constant,
+    e.g., Celsius is offset by 273.15 relative to Kelvin (C + 273.15 = K).
+    !!! warning
+    
+        For absolute temperatures only! For temperature
+        *differences*, this must be omitted!
+  type: number
+
+scale:
+  description: |
+    default value is 1*- allows to scale the values into base units,
+    e.g., 1e-3 to describe mm (millimeters) in terms of m (meters)
+  type: number
+  example: 1

mkdocs.yml

@@ -40,6 +40,7 @@ nav:
       - Model:
           - Model: attributes/model/index.md
           - Slots: attributes/slots.md
+          - Units: attributes/units.md
       - Behaviour:
           - Behaviour (M + A): attributes/ma_pair/index.md
       - Data: