Improved markdown on experimental tests

piel/experimental/measurements.py

@@ -0,0 +1,9 @@
+def compose_measurement_from_experiment_instance():
+    """
+    This function is meant to be run after the measurements have been collected and the data exists within the measurement directories.
+    Each experiment instance should correspond to a list of measurement configurations, ie the specific set of measurements
+     that are required at each directory generated for the experimental instance. Hence, for this function to work properly,
+     it is required to have a mapping between experiment configuration types and measurement classes accordingly.
+     The mapping will be between a given MeasurementConfiguration type and a Measurement class which has the references
+     of the data containers accordingly.
+    """

piel/experimental/types/__init__.py

@@ -10,7 +10,6 @@
 from .device import (
     Device,
     DeviceConfiguration,
-    DeviceMeasurementConfiguration,
     MeasurementDevice,
 )
 
@@ -22,12 +21,15 @@
 from .frequency import (
     VNA,
     VNAConfiguration,
-    VNAMeasurement,
+)
+
+from .measurements.core import MeasurementConfiguration
+
+from .measurements.frequency import (
     VNASParameterMeasurementConfiguration,
     VNAPowerSweepMeasurementConfiguration,
 )
 
-
 from .measurements.propagation import (
     PropagationDelayMeasurement,
     PropagationDelayMeasurementSweep,
@@ -38,6 +40,8 @@
     PropagationDelayMeasurementSweepData,
 )
 
+from .measurements.generic import MeasurementTypes
+
 from .time import (
     Oscilloscope,
     OscilloscopeConfiguration,

piel/experimental/types/device.py

@@ -5,15 +5,7 @@
 
 from typing import Optional
 from ...types import PielBaseModel, PhysicalComponent, PathTypes
-
-
-class DeviceMeasurementConfiguration(PielBaseModel):
-    """
-    Standard definition for a measurement configuration.
-    """
-
-    name: Optional[str] = None
-    parent_directory: Optional[PathTypes] = None
+from .measurements.core import MeasurementConfiguration
 
 
 class DeviceMeasurement(PielBaseModel):
@@ -38,7 +30,7 @@ class Device(PhysicalComponent):
 
 
 class MeasurementDevice(Device):
-    measurement: Optional[DeviceMeasurementConfiguration] = None
+    measurement: Optional[MeasurementConfiguration] = None
     """
     Contains the measurement information.
     """

piel/experimental/types/experiment.py

@@ -1,5 +1,6 @@
 from typing import Optional
 from ...types import Instance, ComponentTypes, ConnectionTypes
+from .measurements.generic import MeasurementTypes
 
 
 class ExperimentInstance(Instance):
@@ -44,6 +45,8 @@ class ExperimentInstance(Instance):
     The date the experiment was measured.
     """
 
+    measurement_configuration_list: list[MeasurementTypes] = None
+
 
 class Experiment(Instance):
     name: str

piel/experimental/types/frequency.py

@@ -1,21 +1,10 @@
 from typing import Optional
-from ...types import PathTypes, PhysicalPort
+from ...types import PhysicalPort
 from .device import (
-    DeviceMeasurementConfiguration,
     DeviceConfiguration,
     Device,
 )
-
-
-class VNASParameterMeasurementConfiguration(DeviceMeasurementConfiguration):
-    frequency_range_Hz: tuple[float, float] = None
-    sweep_points: int = None
-    test_port_power_dBm: float = None
-
-
-class VNAPowerSweepMeasurementConfiguration(DeviceMeasurementConfiguration):
-    base_frequency_Hz: float = None
-    power_range_dBm: tuple[float, float] = None
+from .measurements.generic import FrequencyMeasurementConfigurationTypes
 
 
 class VNAConfiguration(DeviceConfiguration):
@@ -25,9 +14,7 @@ class VNAConfiguration(DeviceConfiguration):
     """
 
     calibration_setting_name: Optional[str] = None
-    measurement_configuration: (
-        VNASParameterMeasurementConfiguration | VNAPowerSweepMeasurementConfiguration
-    ) = None
+    measurement_configuration: FrequencyMeasurementConfigurationTypes = None
 
 
 class VNA(Device):
@@ -47,11 +34,3 @@ class VNA(Device):
     """
     Defaults to a two-port VNA, defined as PORT1 and PORT2.
     """
-
-
-class VNAMeasurement(DeviceMeasurementConfiguration):
-    """
-    Standard definition for a collection of files that are part of a VNA measurement.
-    """
-
-    spectrum_file: PathTypes

piel/experimental/types/measurements/core.py

@@ -0,0 +1,11 @@
+from ....types import PielBaseModel, PathTypes
+
+
+class MeasurementConfiguration(PielBaseModel):
+    """
+    Standard definition for a measurement configuration.
+    """
+
+    name: str = None
+    parent_directory: PathTypes = None
+    measurement_type: str = None

piel/experimental/types/measurements/frequency.py

@@ -0,0 +1,21 @@
+from ....types import PathTypes
+from .core import MeasurementConfiguration
+
+
+class VNASParameterMeasurementConfiguration(MeasurementConfiguration):
+    frequency_range_Hz: tuple[float, float] = None
+    sweep_points: int = None
+    test_port_power_dBm: float = None
+
+
+class VNAPowerSweepMeasurementConfiguration(MeasurementConfiguration):
+    base_frequency_Hz: float = None
+    power_range_dBm: tuple[float, float] = None
+
+
+class VNAMeasurement:
+    """
+    Standard definition for a collection of files that are part of a VNA measurement.
+    """
+
+    spectrum_file: PathTypes

piel/experimental/types/measurements/generic.py

@@ -0,0 +1,11 @@
+from .frequency import (
+    VNASParameterMeasurementConfiguration,
+    VNAPowerSweepMeasurementConfiguration,
+)
+from .propagation import PropagationDelayMeasurement
+
+FrequencyMeasurementConfigurationTypes = (
+    VNASParameterMeasurementConfiguration | VNAPowerSweepMeasurementConfiguration
+)
+MeasurementConfigurationTypes = FrequencyMeasurementConfigurationTypes
+MeasurementTypes = PropagationDelayMeasurement

piel/experimental/types/measurements/map.py

@@ -0,0 +1 @@
+configuration_to_measurement_map = {}

piel/experimental/types/measurements/propagation.py

@@ -1,6 +1,10 @@
 from ....types import Instance, PathTypes
 from ..device import DeviceMeasurement
-from ..experiment import ExperimentInstance
+from .core import MeasurementConfiguration
+
+
+class PropagationDelayMeasurementConfiguration(MeasurementConfiguration):
+    pass
 
 
 class PropagationDelayMeasurement(DeviceMeasurement):
@@ -10,7 +14,7 @@ class PropagationDelayMeasurement(DeviceMeasurement):
     This configuration requires a device waveform, a measurement file and a reference waveform as per a propagation delay measurement.
     TODO add link to the documentation of the propagation delay measurement.
     """
-    experiment_instance: ExperimentInstance
+
     dut_waveform_prefix: PathTypes
     reference_waveform_prefix: PathTypes
     measurement_file_prefix: PathTypes
@@ -21,4 +25,5 @@ class PropagationDelayMeasurementSweep(Instance):
     This class is used to define a collection of PropagationDelayFileCollection that are part of a sweep of a parameter
     as defined within each PropagationDelayFileCollection.
     """
+
     measurements: list[PropagationDelayMeasurement]