shepherd-core 2023.11.1__py3-none-any.whl → 2024.4.1__py3-none-any.whl

shepherd_core/__init__.py

@@ -4,6 +4,7 @@ Provides classes for storing and retrieving sampled IV data to/from
 HDF5 files.
 
 """
+
 from .data_models.base.calibration import Calc_t
 from .data_models.base.calibration import CalibrationCape
 from .data_models.base.calibration import CalibrationEmulator
@@ -12,7 +13,7 @@ from .data_models.base.calibration import CalibrationPair
 from .data_models.base.calibration import CalibrationSeries
 from .data_models.base.timezone import local_now
 from .data_models.base.timezone import local_tz
-from .data_models.task import Compression
+from .data_models.task.emulation import Compression
 from .inventory import Inventory
 from .logger import get_verbose_level
 from .logger import increase_verbose_level
@@ -22,7 +23,7 @@ from .testbed_client.client import TestbedClient
 from .testbed_client.client import tb_client
 from .writer import Writer
 
-__version__ = "2023.11.1"
+__version__ = "2024.04.1"
 
 __all__ = [
     "Reader",

shepherd_core/data_models/base/calibration.py

@@ -165,7 +165,7 @@ class CapeData(ShpModel):
     `See<https://github.com/beagleboard/beaglebone-black/wiki/System-Reference-Manual#824_EEPROM_Data_Format>`_
     """
 
-    header: conbytes(max_length=4) = b"\xAA\x55\x33\xEE"
+    header: conbytes(max_length=4) = b"\xaa\x55\x33\xee"
     eeprom_revision: constr(max_length=2) = "A2"
     board_name: constr(max_length=32) = "BeagleBone SHEPHERD2 Cape"
     version: constr(max_length=4) = "24B0"
@@ -207,6 +207,7 @@ class CalibrationCape(ShpModel):
             cape: data can be supplied
         Returns:
             CalibrationCape object with extracted calibration data.
+
         """
         dv = cls().model_dump(include={"harvester", "emulator"})
         lw = list(dict_generator(dv))
@@ -225,6 +226,7 @@ class CalibrationCape(ShpModel):
         Returns
         -------
             Byte string representation of calibration values.
+
         """
         lw = list(dict_generator(self.model_dump(include={"harvester", "emulator"})))
         values = [walk[-1] for walk in lw]

shepherd_core/data_models/base/content.py

@@ -1,7 +1,10 @@
 import hashlib
 from datetime import datetime
 from typing import Optional
+from typing import Union
+from uuid import uuid4
 
+from pydantic import UUID4
 from pydantic import Field
 from pydantic import StringConstraints
 from pydantic import model_validator
@@ -14,34 +17,34 @@ from .timezone import local_now
 # constr -> to_lower=True, max_length=16, regex=r"^[\w]+$"
 # ⤷ Regex = AlphaNum
 IdInt = Annotated[int, Field(ge=0, lt=2**128)]
-NameStr = Annotated[
-    str, StringConstraints(max_length=32, pattern=r'^[^<>:;,?"*|\/\\]+$')
-]
+NameStr = Annotated[str, StringConstraints(max_length=32, pattern=r"^[^<>:;,?\"\*|\/\\]+$")]
 # ⤷ Regex = FileSystem-Compatible ASCII
 SafeStr = Annotated[str, StringConstraints(pattern=r"^[ -~]+$")]
 # ⤷ Regex = All Printable ASCII-Characters with Space
 
 
 def id_default() -> int:
+    # note: IdInt has space for 128 bit, so 128/4 = 32 hex-chars
     time_stamp = str(local_now()).encode("utf-8")
-    time_hash = hashlib.sha3_224(time_stamp).hexdigest()[-16:]
+    time_hash = hashlib.sha3_224(time_stamp).hexdigest()[-32:]
     return int(time_hash, 16)
 
 
 class ContentModel(ShpModel):
     # General Properties
-    id: IdInt = Field(  # noqa: A003
+    # id: UUID4 = Field(  # TODO: db-migration - temp fix for documentation
+    id: Union[UUID4, int] = Field(
         description="Unique ID",
-        default_factory=id_default,
+        default_factory=uuid4,
     )
     name: NameStr
-    description: Annotated[
-        Optional[SafeStr], Field(description="Required when public")
-    ] = None
+    description: Annotated[Optional[SafeStr], Field(description="Required when public")] = None
     comment: Optional[SafeStr] = None
     created: datetime = Field(default_factory=datetime.now)
+    updated_last: datetime = Field(default_factory=datetime.now)
 
     # Ownership & Access
+    # TODO: remove owner & group, only needed for DB
     owner: NameStr
     group: Annotated[NameStr, Field(description="University or Subgroup")]
     visible2group: bool = False
@@ -57,7 +60,6 @@ class ContentModel(ShpModel):
         is_visible = self.visible2group or self.visible2all
         if is_visible and self.description is None:
             raise ValueError(
-                "Public instances require a description "
-                "(check visible2*- and description-field)"
+                "Public instances require a description (check visible2*- and description-field)"
             )
         return self

shepherd_core/data_models/base/shepherd.py

@@ -7,6 +7,7 @@ from typing import Any
 from typing import Generator
 from typing import Optional
 from typing import Union
+from uuid import UUID
 
 import yaml
 from pydantic import BaseModel
@@ -27,9 +28,7 @@ def path2str(
 
 
 def time2int(dumper: Dumper, data: timedelta) -> ScalarNode:
-    return dumper.represent_scalar(
-        "tag:yaml.org,2002:int", str(int(data.total_seconds()))
-    )
+    return dumper.represent_scalar("tag:yaml.org,2002:int", str(int(data.total_seconds())))
 
 
 def generic2str(dumper: Dumper, data: Any) -> ScalarNode:
@@ -41,6 +40,7 @@ yaml.add_representer(pathlib.WindowsPath, path2str, SafeDumper)
 yaml.add_representer(pathlib.Path, path2str, SafeDumper)
 yaml.add_representer(timedelta, time2int, SafeDumper)
 yaml.add_representer(IPv4Address, generic2str, SafeDumper)
+yaml.add_representer(UUID, generic2str, SafeDumper)
 
 
 class ShpModel(BaseModel):
@@ -109,9 +109,7 @@ class ShpModel(BaseModel):
     def schema_to_file(cls, path: Union[str, Path]) -> None:
         """Store schema to yaml (for frontend-generators)"""
         model_dict = cls.model_json_schema()
-        model_yaml = yaml.safe_dump(
-            model_dict, default_flow_style=False, sort_keys=False
-        )
+        model_yaml = yaml.safe_dump(model_dict, default_flow_style=False, sort_keys=False)
         with Path(path).resolve().with_suffix(".yaml").open("w") as f:
             f.write(model_yaml)
 

shepherd_core/data_models/content/energy_environment.py

@@ -13,7 +13,7 @@ class EnergyDType(str, Enum):
     ivsample = "ivsample"
     ivsamples = "ivsample"
     ivcurve = "ivcurve"
-    ivcurves = "ivcurve"
+    ivcurves = "ivcurve"  # a stream could also be called iv-surface
     isc_voc = "isc_voc"
 
 

shepherd_core/data_models/content/virtual_harvester.py

@@ -76,7 +76,7 @@ class VirtualHarvesterConfig(ContentModel, title="Config for the Harvester"):
         logger.debug("VHrv-Inheritances: %s", chain)
 
         # post corrections -> should be in separate validator
-        cal = CalibrationHarvester()  # todo: as argument?
+        cal = CalibrationHarvester()  # TODO: as argument?
         c_limit = values.get("current_limit_uA", 50_000)  # cls.current_limit_uA)
         values["current_limit_uA"] = max(10**6 * cal.adc_C_Hrv.raw_to_si(4), c_limit)
 

shepherd_core/data_models/content/virtual_source.py

@@ -25,12 +25,13 @@ class VirtualSourceConfig(ContentModel, title="Config for the virtual Source"):
     for supplying the Target Node during the experiment.
     If not already done, the energy will be harvested and then converted.
     The converter-stage is software defined and offers:
-      buck-boost-combinations,
-      a simple diode + resistor and
-      an intermediate buffer capacitor.
-      TODO: I,V,R should be in regular unit (V, A, Ohm)
+    - buck-boost-combinations,
+    - a simple diode + resistor and
+    - an intermediate buffer capacitor.
     """
 
+    # TODO: I,V,R should be in regular unit (V, A, Ohm)
+
     # General Metadata & Ownership -> ContentModel
 
     enable_boost: bool = False
@@ -123,14 +124,17 @@ class VirtualSourceConfig(ContentModel, title="Config for the virtual Source"):
         only has simpler formula, second enabling when V_Cap >= V_out
 
         Math behind this calculation:
-        Energy-Change Storage Cap   ->  E_new = E_old - E_output
-        with Energy of a Cap 	    -> 	E_x = C_x * V_x^2 / 2
-        combine formulas 		    ->
-                    C_store * V_store_new^2 / 2 = C_store * V_store_old^2 / 2 - C_out * V_out^2 / 2
-        convert formula to V_new 	->	V_store_new^2 = V_store_old^2 - (C_out / C_store) * V_out^2
-        convert into dV	 	        ->	dV = V_store_new - V_store_old
-        in case of V_cap = V_out 	-> 	dV = V_store_old * (sqrt(1 - C_out / C_store) - 1)
-        -> dV values will be reversed (negated), because dV is always negative (Voltage drop)
+
+        - Energy-Change Storage Cap ->  E_new = E_old - E_output
+        - with Energy of a Cap 	    -> 	E_x = C_x * V_x^2 / 2
+        - combine formulas 		    ->  C_store * V_store_new^2 / 2 =
+          C_store * V_store_old^2 / 2 - C_out * V_out^2 / 2
+        - convert formula to V_new 	->	V_store_new^2 =
+          V_store_old^2 - (C_out / C_store) * V_out^2
+        - convert into dV	 	        ->	dV = V_store_new - V_store_old
+        - in case of V_cap = V_out 	-> 	dV = V_store_old * (sqrt(1 - C_out / C_store) - 1)
+
+        Note: dV values will be reversed (negated), because dV is always negative (Voltage drop)
         """
         values = {}
         if self.C_intermediate_uF > 0 and self.C_output_uF > 0:
@@ -153,15 +157,9 @@ class VirtualSourceConfig(ContentModel, title="Config for the virtual Source"):
             dV_output_imed_low_mV = 0
 
         # protect from complex solutions (non valid input combinations)
-        if not (
-            isinstance(dV_output_en_thrs_mV, (int, float))
-            and (dV_output_en_thrs_mV >= 0)
-        ):
+        if not (isinstance(dV_output_en_thrs_mV, (int, float)) and (dV_output_en_thrs_mV >= 0)):
             dV_output_en_thrs_mV = 0
-        if not (
-            isinstance(dV_output_imed_low_mV, (int, float))
-            and (dV_output_imed_low_mV >= 0)
-        ):
+        if not (isinstance(dV_output_imed_low_mV, (int, float)) and (dV_output_imed_low_mV >= 0)):
             logger.warning("VSrc: C_output shouldn't be larger than C_intermediate")
             dV_output_imed_low_mV = 0
 
@@ -171,9 +169,7 @@ class VirtualSourceConfig(ContentModel, title="Config for the virtual Source"):
 
             if self.V_intermediate_enable_threshold_mV > V_pre_output_mV:
                 values["dV_enable_output_mV"] = dV_output_en_thrs_mV
-                values[
-                    "V_enable_output_threshold_mV"
-                ] = self.V_intermediate_enable_threshold_mV
+                values["V_enable_output_threshold_mV"] = self.V_intermediate_enable_threshold_mV
 
             else:
                 values["dV_enable_output_mV"] = dV_output_imed_low_mV
@@ -182,26 +178,21 @@ class VirtualSourceConfig(ContentModel, title="Config for the virtual Source"):
                 )
 
             if self.V_intermediate_disable_threshold_mV > V_pre_output_mV:
-                values[
-                    "V_disable_output_threshold_mV"
-                ] = self.V_intermediate_disable_threshold_mV
+                values["V_disable_output_threshold_mV"] = self.V_intermediate_disable_threshold_mV
             else:
                 values["V_disable_output_threshold_mV"] = V_pre_output_mV
 
         else:
             values["dV_enable_output_mV"] = dV_output_en_thrs_mV
-            values[
-                "V_enable_output_threshold_mV"
-            ] = self.V_intermediate_enable_threshold_mV
-            values[
-                "V_disable_output_threshold_mV"
-            ] = self.V_intermediate_disable_threshold_mV
+            values["V_enable_output_threshold_mV"] = self.V_intermediate_enable_threshold_mV
+            values["V_disable_output_threshold_mV"] = self.V_intermediate_disable_threshold_mV
         return values
 
     def calc_converter_mode(self, *, log_intermediate_node: bool) -> int:
         """Assembles bitmask from discrete values
+
         log_intermediate_node: record / log virtual intermediate (cap-)voltage and
-                            -current (out) instead of output-voltage and -current
+        -current (out) instead of output-voltage and -current
         """
         enable_storage = self.C_intermediate_uF > 0
         enable_boost = self.enable_boost and enable_storage
@@ -286,9 +277,7 @@ class ConverterPRUConfig(ShpModel):
         states = data.calc_internal_states()
         return cls(
             # General
-            converter_mode=data.calc_converter_mode(
-                log_intermediate_node=log_intermediate_node
-            ),
+            converter_mode=data.calc_converter_mode(log_intermediate_node=log_intermediate_node),
             interval_startup_delay_drain_n=round(
                 data.interval_startup_delay_drain_ms * samplerate_sps_default * 1e-3
             ),
@@ -299,26 +288,16 @@ class ConverterPRUConfig(ShpModel):
             Constant_us_per_nF_n28=data.calc_cap_constant_us_per_nF_n28(),
             V_intermediate_init_uV=round(data.V_intermediate_init_mV * 1e3),
             I_intermediate_leak_nA=round(data.I_intermediate_leak_nA),
-            V_enable_output_threshold_uV=round(
-                states["V_enable_output_threshold_mV"] * 1e3
-            ),
-            V_disable_output_threshold_uV=round(
-                states["V_disable_output_threshold_mV"] * 1e3
-            ),
+            V_enable_output_threshold_uV=round(states["V_enable_output_threshold_mV"] * 1e3),
+            V_disable_output_threshold_uV=round(states["V_disable_output_threshold_mV"] * 1e3),
             dV_enable_output_uV=round(states["dV_enable_output_mV"] * 1e3),
             interval_check_thresholds_n=round(
                 data.interval_check_thresholds_ms * samplerate_sps_default * 1e-3
             ),
-            V_pwr_good_enable_threshold_uV=round(
-                data.V_pwr_good_enable_threshold_mV * 1e3
-            ),
-            V_pwr_good_disable_threshold_uV=round(
-                data.V_pwr_good_disable_threshold_mV * 1e3
-            ),
+            V_pwr_good_enable_threshold_uV=round(data.V_pwr_good_enable_threshold_mV * 1e3),
+            V_pwr_good_disable_threshold_uV=round(data.V_pwr_good_disable_threshold_mV * 1e3),
             immediate_pwr_good_signal=data.immediate_pwr_good_signal,
-            V_output_log_gpio_threshold_uV=round(
-                data.V_output_log_gpio_threshold_mV * 1e3
-            ),
+            V_output_log_gpio_threshold_uV=round(data.V_output_log_gpio_threshold_mV * 1e3),
             # Boost-Converter
             V_input_boost_threshold_uV=round(data.V_input_boost_threshold_mV * 1e3),
             V_intermediate_max_uV=round(data.V_intermediate_max_mV * 1e3),
@@ -330,8 +309,7 @@ class ConverterPRUConfig(ShpModel):
             LUT_input_I_min_log2_nA=data.LUT_input_I_min_log2_nA,
             LUT_output_I_min_log2_nA=data.LUT_output_I_min_log2_nA,
             LUT_inp_efficiency_n8=[
-                [min(255, round(256 * ival)) for ival in il]
-                for il in data.LUT_input_efficiency
+                [min(255, round(256 * ival)) for ival in il] for il in data.LUT_input_efficiency
             ],
             LUT_out_inv_efficiency_n4=[
                 min((2**14), round((2**4) / value)) if (value > 0) else int(2**14)

shepherd_core/data_models/experiment/experiment.py

@@ -2,8 +2,10 @@ from datetime import datetime
 from datetime import timedelta
 from typing import List
 from typing import Optional
+from typing import Union
+from uuid import uuid4
 
-from pydantic import EmailStr
+from pydantic import UUID4
 from pydantic import Field
 from pydantic import model_validator
 from typing_extensions import Annotated
@@ -12,7 +14,6 @@ from typing_extensions import Self
 from ..base.content import IdInt
 from ..base.content import NameStr
 from ..base.content import SafeStr
-from ..base.content import id_default
 from ..base.shepherd import ShpModel
 from ..testbed.target import Target
 from ..testbed.testbed import Testbed
@@ -26,11 +27,10 @@ class Experiment(ShpModel, title="Config of an Experiment"):
     """
 
     # General Properties
-    id: IdInt = Field(  # noqa: A003
-        description="Unique ID",
-        default_factory=id_default,
-    )
+    # id: UUID4 ... # TODO db-migration - temp fix for documentation
+    id: Union[UUID4, int] = Field(default_factory=uuid4)
     # ⤷ TODO: automatic ID is problematic for identification by hash
+
     name: NameStr
     description: Annotated[
         Optional[SafeStr], Field(description="Required for public instances")
@@ -38,12 +38,12 @@ class Experiment(ShpModel, title="Config of an Experiment"):
     comment: Optional[SafeStr] = None
     created: datetime = Field(default_factory=datetime.now)
 
-    # Ownership & Access, TODO
-    owner_id: Optional[IdInt] = 5472  # UUID?
+    # Ownership & Access
+    owner_id: Optional[IdInt] = None
 
     # feedback
-    email_results: Optional[EmailStr] = None
-    # ⤷ TODO: can be bool, as its linked to account
+    email_results: bool = False
+
     sys_logging: SystemLogging = SystemLogging(dmesg=True, ptp=True, shepherd=True)
 
     # schedule
@@ -80,9 +80,7 @@ class Experiment(ShpModel, title="Config of an Experiment"):
         if len(target_ids) > len(set(target_ids)):
             raise ValueError("Target-ID used more than once in Experiment!")
         if len(target_ids) > len(set(custom_ids)):
-            raise ValueError(
-                "Custom Target-ID are faulty (some form of id-collisions)!"
-            )
+            raise ValueError("Custom Target-ID are faulty (some form of id-collisions)!")
 
     @staticmethod
     def validate_observers(configs: List[TargetConfig]) -> None:
@@ -92,8 +90,7 @@ class Experiment(ShpModel, title="Config of an Experiment"):
         obs_ids = [testbed.get_observer(_id).id for _id in target_ids]
         if len(target_ids) > len(set(obs_ids)):
             raise ValueError(
-                "Observer used more than once in Experiment "
-                "-> only 1 target per observer!"
+                "Observer used more than once in Experiment -> only 1 target per observer!"
             )
 
     def get_target_ids(self) -> list:
@@ -104,6 +101,4 @@ class Experiment(ShpModel, title="Config of an Experiment"):
             if target_id in _config.target_IDs:
                 return _config
         # gets already caught in target_config - but keep:
-        raise ValueError(
-            f"Target-ID {target_id} was not found in Experiment '{self.name}'"
-        )
+        raise ValueError(f"Target-ID {target_id} was not found in Experiment '{self.name}'")

shepherd_core/data_models/experiment/observer_features.py

@@ -43,9 +43,7 @@ class PowerTracing(ShpModel, title="Config for Power-Tracing"):
 
         discard_all = self.discard_current and self.discard_voltage
         if not self.calculate_power and discard_all:
-            raise ValueError(
-                "Error in config -> tracing enabled, but output gets discarded"
-            )
+            raise ValueError("Error in config -> tracing enabled, but output gets discarded")
         if self.calculate_power:
             raise ValueError("postprocessing not implemented ATM")
         return self
@@ -59,9 +57,7 @@ class GpioTracing(ShpModel, title="Config for GPIO-Tracing"):
     # initial recording
     mask: Annotated[int, Field(ge=0, lt=2**10)] = 0b11_1111_1111  # all
     # ⤷ TODO: custom mask not implemented in PRU, ATM
-    gpios: Optional[
-        Annotated[List[GPIO], Field(min_length=1, max_length=10)]
-    ] = None  # = all
+    gpios: Optional[Annotated[List[GPIO], Field(min_length=1, max_length=10)]] = None  # = all
     # ⤷ TODO: list of GPIO to build mask, one of both should be internal / computed field
 
     # time
@@ -70,7 +66,7 @@ class GpioTracing(ShpModel, title="Config for GPIO-Tracing"):
 
     # post-processing,
     uart_decode: bool = False
-    # todo: quickfix - uart-log currently done online in userspace
+    # TODO: quickfix - uart-log currently done online in userspace
     # NOTE: gpio-tracing currently shows rather big - but rare - "blind" windows (~1-4us)
     uart_pin: GPIO = GPIO(name="GPIO8")
     uart_baudrate: Annotated[int, Field(ge=2_400, le=921_600)] = 115_200
@@ -108,9 +104,7 @@ class GpioEvent(ShpModel, title="Config for a GPIO-Event"):
     @model_validator(mode="after")
     def post_validation(self) -> Self:
         if not self.gpio.user_controllable():
-            raise ValueError(
-                f"GPIO '{self.gpio.name}' in actuation-event not controllable by user"
-            )
+            raise ValueError(f"GPIO '{self.gpio.name}' in actuation-event not controllable by user")
         return self
 
     def get_events(self) -> np.ndarray:
@@ -119,11 +113,10 @@ class GpioEvent(ShpModel, title="Config for a GPIO-Event"):
 
 
 class GpioActuation(ShpModel, title="Config for GPIO-Actuation"):
-    """Configuration for a GPIO-Actuation-Sequence
-    TODO: not implemented ATM:
-        - decide if pru control sys-gpio or
-        - reverses pru-gpio (preferred if possible)
-    """
+    """Configuration for a GPIO-Actuation-Sequence"""
+
+    # TODO: not implemented ATM - decide if pru control sys-gpio or
+    # TODO: not implemented ATM - reverses pru-gpio (preferred if possible)
 
     events: Annotated[List[GpioEvent], Field(min_length=1, max_length=1024)]
 
@@ -138,6 +131,7 @@ class SystemLogging(ShpModel, title="Config for System-Logging"):
     ptp: bool = True
     shepherd: bool = True
     # TODO: rename to kernel, timesync, sheep
+    # TODO: add utilization as option
 
 
 # TODO: some more interaction would be good

shepherd_core/data_models/experiment/target_config.py

@@ -22,18 +22,14 @@ class TargetConfig(ShpModel, title="Target Config"):
     """Configuration for Target Nodes (DuT)"""
 
     target_IDs: Annotated[List[IdInt], Field(min_length=1, max_length=128)]
-    custom_IDs: Optional[
-        Annotated[List[IdInt16], Field(min_length=1, max_length=128)]
-    ] = None
+    custom_IDs: Optional[Annotated[List[IdInt16], Field(min_length=1, max_length=128)]] = None
     # ⤷ will replace 'const uint16_t SHEPHERD_NODE_ID' in firmware
     #   if no custom ID is provided, the original ID of target is used
 
     energy_env: EnergyEnvironment  # alias: input
     virtual_source: VirtualSourceConfig = VirtualSourceConfig(name="neutral")
     target_delays: Optional[
-        Annotated[
-            List[Annotated[int, Field(ge=0)]], Field(min_length=1, max_length=128)
-        ]
+        Annotated[List[Annotated[int, Field(ge=0)]], Field(min_length=1, max_length=128)]
     ] = None
     # ⤷ individual starting times -> allows to use the same environment
     # TODO: delays not used ATM
@@ -48,9 +44,7 @@ class TargetConfig(ShpModel, title="Target Config"):
     @model_validator(mode="after")
     def post_validation(self) -> Self:
         if not self.energy_env.valid:
-            raise ValueError(
-                f"EnergyEnv '{self.energy_env.name}' for target must be valid"
-            )
+            raise ValueError(f"EnergyEnv '{self.energy_env.name}' for target must be valid")
         for _id in self.target_IDs:
             target = Target(id=_id)
             for mcu_num in [1, 2]:
@@ -78,8 +72,7 @@ class TargetConfig(ShpModel, title="Target Config"):
         t_ids = self.target_IDs
         if c_ids is not None and (len(set(c_ids)) < len(set(t_ids))):
             raise ValueError(
-                f"Provided custom IDs {c_ids} not enough "
-                f"to cover target range {t_ids}"
+                f"Provided custom IDs {c_ids} not enough to cover target range {t_ids}"
             )
         # TODO: if custom ids present, firmware must be ELF
         return self

shepherd_core/data_models/task/__init__.py

@@ -32,9 +32,7 @@ __all__ = [
 ]
 
 
-def prepare_task(
-    config: Union[ShpModel, Path, str], observer: Optional[str] = None
-) -> Wrapper:
+def prepare_task(config: Union[ShpModel, Path, str], observer: Optional[str] = None) -> Wrapper:
     """- Opens file (from Path or str of Path)
     - wraps task-model
     - and if it's an TestbedTasks it will extract the correct ObserverTask
@@ -88,9 +86,7 @@ def extract_tasks(shp_wrap: Wrapper, *, no_task_sets: bool = True) -> List[ShpMo
         content = [ProgrammingTask(**shp_wrap.parameters)]
     elif shp_wrap.datatype == TestbedTasks.__name__:
         if no_task_sets:
-            raise ValueError(
-                "Model in Wrapper was TestbedTasks -> Task-Sets not allowed!"
-            )
+            raise ValueError("Model in Wrapper was TestbedTasks -> Task-Sets not allowed!")
         content = [TestbedTasks(**shp_wrap.parameters)]
     else:
         raise ValueError("Extractor had unknown task: %s", shp_wrap.datatype)

shepherd_core/data_models/task/emulation.py

@@ -29,8 +29,9 @@ class Compression(str, Enum):
     lzf = "lzf"  # not native hdf5
     gzip1 = 1  # higher compr & load
     gzip = 1
-    default = 1
+    default = "lzf"
     null = None
+    # NOTE: changed to lzf as BBB needs every straw it can get
 
 
 compressions_allowed: list = [None, "lzf", 1]
@@ -52,8 +53,7 @@ class EmulationTask(ShpModel):
     force_overwrite: bool = False
     # ⤷ Overwrite existing file
     output_compression: Optional[Compression] = Compression.default
-    # ⤷ should be 1 (level 1 gzip), lzf, or None (order of recommendation)
-
+    # ⤷ should be lzf, 1 (gzip level 1) or None (order of recommendation)
     time_start: Optional[datetime] = None
     # timestamp or unix epoch time, None = ASAP
     duration: Optional[timedelta] = None
@@ -98,9 +98,7 @@ class EmulationTask(ShpModel):
         # convert & add local timezone-data
         has_time = values.get("time_start") is not None
         if has_time and isinstance(values["time_start"], (int, float)):
-            values["time_start"] = datetime.fromtimestamp(
-                values["time_start"], tz=local_tz()
-            )
+            values["time_start"] = datetime.fromtimestamp(values["time_start"], tz=local_tz())
         if has_time and isinstance(values["time_start"], str):
             values["time_start"] = datetime.fromisoformat(values["time_start"])
         if has_time and values["time_start"].tzinfo is None:
@@ -123,18 +121,14 @@ class EmulationTask(ShpModel):
             "main",
             "buffer",
         }:
-            raise ValueError(
-                "Voltage Aux must be in float (0 - 4.5) or string 'main' / 'mid'."
-            )
+            raise ValueError("Voltage Aux must be in float (0 - 4.5) or string 'main' / 'mid'.")
         if self.gpio_actuation is not None:
             raise ValueError("GPIO Actuation not yet implemented!")
         return self
 
     @classmethod
     @validate_call
-    def from_xp(
-        cls, xp: Experiment, tb: Testbed, tgt_id: IdInt, root_path: Path
-    ) -> Self:
+    def from_xp(cls, xp: Experiment, tb: Testbed, tgt_id: IdInt, root_path: Path) -> Self:
         obs = tb.get_observer(tgt_id)
         tgt_cfg = xp.get_target_config(tgt_id)
 
@@ -144,8 +138,7 @@ class EmulationTask(ShpModel):
             time_start=copy.copy(xp.time_start),
             duration=xp.duration,
             abort_on_error=xp.abort_on_error,
-            enable_io=(tgt_cfg.gpio_tracing is not None)
-            or (tgt_cfg.gpio_actuation is not None),
+            enable_io=(tgt_cfg.gpio_tracing is not None) or (tgt_cfg.gpio_actuation is not None),
             io_port=obs.get_target_port(tgt_id),
             pwr_port=obs.get_target_port(tgt_id),
             virtual_source=tgt_cfg.virtual_source,

shepherd_core/data_models/task/firmware_mod.py

@@ -40,9 +40,7 @@ class FirmwareModTask(ShpModel):
             FirmwareDType.base64_hex,
             FirmwareDType.path_hex,
         }:
-            logger.warning(
-                "Firmware is scheduled to get custom-ID but is not in elf-format"
-            )
+            logger.warning("Firmware is scheduled to get custom-ID but is not in elf-format")
         return self
 
     @classmethod

shepherd_core/data_models/task/harvest.py

@@ -60,9 +60,7 @@ class HarvestTask(ShpModel):
         # convert & add local timezone-data, TODO: used twice, refactor
         has_time = values.get("time_start") is not None
         if has_time and isinstance(values["time_start"], (int, float)):
-            values["time_start"] = datetime.fromtimestamp(
-                values["time_start"], tz=local_tz()
-            )
+            values["time_start"] = datetime.fromtimestamp(values["time_start"], tz=local_tz())
         if has_time and isinstance(values["time_start"], str):
             values["time_start"] = datetime.fromisoformat(values["time_start"])
         if has_time and values["time_start"].tzinfo is None:

shepherd_core/data_models/task/observer_tasks.py

@@ -21,7 +21,7 @@ class ObserverTasks(ShpModel):
     """Collection of tasks for selected observer included in experiment"""
 
     observer: NameStr
-    owner_id: IdInt
+    owner_id: Optional[IdInt]  # TODO: set to optional for now, shouldn't be
 
     # PRE PROCESS
     time_prep: datetime  # TODO: should be optional