spectre-core 0.0.21__py3-none-any.whl → 0.0.23__py3-none-any.whl

spectre_core/capture_configs/_pconstraints.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: © 2024 Jimmy Fitzpatrick <jcfitzpatrick12@gmail.com>
+# SPDX-FileCopyrightText: © 2024-2025 Jimmy Fitzpatrick <jcfitzpatrick12@gmail.com>
 # This file is part of SPECTRE
 # SPDX-License-Identifier: GPL-3.0-or-later
 
@@ -7,38 +7,34 @@ from abc import ABC, abstractmethod
 from typing import TypeVar, Optional, Any, Generic
 
 # value type
-VT = TypeVar('VT')
+VT = TypeVar("VT")
+
 
 class BasePConstraint(ABC, Generic[VT]):
     """An abstract base class for an arbitary parameter constraint."""
+
     @abstractmethod
-    def constrain(
-        self, 
-        value: VT
-    ) -> None:
+    def constrain(self, value: VT) -> None:
         """Apply a constraint to the input parameter. Implementations must raise a `ValueError` for
         if the input value fails the constraint.
 
         :param value: The value to be constrained.
         """
-        
-        
-    def __format__(
-        self, 
-        format_spec: str = ""
-    ) -> str:
+
+    def __format__(self, format_spec: str = "") -> str:
         attrs = ", ".join(f"{key}={value!r}" for key, value in vars(self).items())
         return f"{self.__class__.__name__}({attrs})"
 
 
 class Bound(BasePConstraint[float | int]):
     """Bound a numeric parameter value to a some specified interval."""
+
     def __init__(
         self,
         lower_bound: Optional[float | int] = None,
         upper_bound: Optional[float | int] = None,
         strict_lower: bool = False,
-        strict_upper: bool = False
+        strict_upper: bool = False,
     ) -> None:
         """Create an instance of `Bound`.
 
@@ -52,10 +48,7 @@ class Bound(BasePConstraint[float | int]):
         self._strict_lower = strict_lower
         self._strict_upper = strict_upper
 
-    def constrain(
-        self, 
-        value: float | int
-    ) -> None:
+    def constrain(self, value: float | int) -> None:
         """Bound the parameter value to a specified interval.
 
         :param value: The value to be constrained.
@@ -63,28 +56,37 @@ class Bound(BasePConstraint[float | int]):
         """
         if self._lower_bound is not None:
             if self._strict_lower and value <= self._lower_bound:
-                raise ValueError(f"Value must be strictly greater than {self._lower_bound}. "
-                                 f"Got {value}.")
+                raise ValueError(
+                    f"Value must be strictly greater than {self._lower_bound}. "
+                    f"Got {value}."
+                )
             if not self._strict_lower and value < self._lower_bound:
-                raise ValueError(f"Value must be greater than or equal to {self._lower_bound}. "
-                                 f"Got {value}.")
+                raise ValueError(
+                    f"Value must be greater than or equal to {self._lower_bound}. "
+                    f"Got {value}."
+                )
 
         if self._upper_bound is not None:
             if self._strict_upper and value >= self._upper_bound:
-                raise ValueError(f"Value must be strictly less than {self._upper_bound}. "
-                                 f"Got {value}.")
+                raise ValueError(
+                    f"Value must be strictly less than {self._upper_bound}. "
+                    f"Got {value}."
+                )
             if not self._strict_upper and value > self._upper_bound:
-                raise ValueError(f"Value must be less than or equal to {self._upper_bound}. "
-                                 f"Got {value}.")
+                raise ValueError(
+                    f"Value must be less than or equal to {self._upper_bound}. "
+                    f"Got {value}."
+                )
+
 
 # option type
-OT = TypeVar('OT')
+OT = TypeVar("OT")
+
+
 class OneOf(BasePConstraint[OT]):
     """Constrain a parameter value to be one of a pre-defined list of options."""
-    def __init__(
-        self, 
-        options: Optional[list[OT]] = None
-    ) -> None:
+
+    def __init__(self, options: Optional[list[OT]] = None) -> None:
         """Initialise an instance of `OneOf`.
 
         :param options: Input values are required to be one of `options`. If no options are provided,
@@ -92,7 +94,6 @@ class OneOf(BasePConstraint[OT]):
         """
         self._options = options or []
 
-
     def constrain(self, value: OT) -> None:
         """Constrain the input value to be one of a list of pre-defined options.
 
@@ -101,14 +102,12 @@ class OneOf(BasePConstraint[OT]):
         """
         if value not in self._options:
             raise ValueError(f"Value must be one of {self._options}. Got {value}.")
-        
+
 
 class PowerOfTwo(BasePConstraint[int]):
     """Constrain a numeric parameter value to be a power of two."""
-    def constrain(
-        self, 
-        value: int
-    ) -> None:
+
+    def constrain(self, value: int) -> None:
         """Constrain the input value to be a power of two.
 
         :param value: The input value to be constrained.
@@ -121,13 +120,14 @@ class PowerOfTwo(BasePConstraint[int]):
 @dataclass(frozen=True)
 class EnforceSign:
     """Enforce the sign of some value.
-    
+
     :ivar positive: Enforce the value to be strictly positive.
     :ivar negative: Enforce the value to be strictly negative.
     :ivar non_negative: Enforce the value to be zero or positive.
     :ivar non_positive: Enforce the value to be zero or negative.
     """
-    positive       = Bound(lower_bound=0, strict_lower=True)
-    negative       = Bound(upper_bound=0, strict_upper=True)
-    non_negative   = Bound(lower_bound=0, strict_lower=False)
-    non_positive   = Bound(upper_bound=0, strict_upper=False)
+
+    positive = Bound(lower_bound=0, strict_lower=True)
+    negative = Bound(upper_bound=0, strict_upper=True)
+    non_negative = Bound(lower_bound=0, strict_lower=False)
+    non_positive = Bound(upper_bound=0, strict_upper=False)

spectre_core/capture_configs/_pnames.py

@@ -1,52 +1,54 @@
-# SPDX-FileCopyrightText: © 2024 Jimmy Fitzpatrick <jcfitzpatrick12@gmail.com>
+# SPDX-FileCopyrightText: © 2024-2025 Jimmy Fitzpatrick <jcfitzpatrick12@gmail.com>
 # This file is part of SPECTRE
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from enum import Enum
 
+
 class PName(Enum):
     """A `spectre` capture config parameter name.
-    
+
     Each `PName` has an associated base parameter template which can be fetched
     using:
-    
+
     `get_base_ptemplate`
-    
+
     All parameters and parameter templates must take on some name in `PName`.
     To introduce a new parameter/parameter template, you need to create a new `PName`
     constant.
     """
-    CENTER_FREQUENCY     = "center_frequency"
-    MIN_FREQUENCY        = "min_frequency"
-    MAX_FREQUENCY        = "max_frequency"
-    FREQUENCY_STEP       = "frequency_step"
-    FREQUENCY            = "frequency"
-    BANDWIDTH            = "bandwidth"
-    SAMPLE_RATE          = "sample_rate"
-    IF_GAIN              = "if_gain"
-    RF_GAIN              = "rf_gain"
-    AMPLITUDE            = "amplitude"
-    TIME_RESOLUTION      = "time_resolution"
+
+    CENTER_FREQUENCY = "center_frequency"
+    MIN_FREQUENCY = "min_frequency"
+    MAX_FREQUENCY = "max_frequency"
+    FREQUENCY_STEP = "frequency_step"
+    FREQUENCY = "frequency"
+    BANDWIDTH = "bandwidth"
+    SAMPLE_RATE = "sample_rate"
+    IF_GAIN = "if_gain"
+    RF_GAIN = "rf_gain"
+    AMPLITUDE = "amplitude"
+    TIME_RESOLUTION = "time_resolution"
     FREQUENCY_RESOLUTION = "frequency_resolution"
-    TIME_RANGE           = "time_range"
-    BATCH_SIZE           = "batch_size"
-    WINDOW_TYPE          = "window_type"
-    WINDOW_HOP           = "window_hop"
-    WINDOW_SIZE          = "window_size"
-    EVENT_HANDLER_KEY    = "event_handler_key"
-    WATCH_EXTENSION      = "watch_extension"
-    BATCH_KEY            = "batch_key"
-    SAMPLES_PER_STEP     = "samples_per_step"
+    TIME_RANGE = "time_range"
+    BATCH_SIZE = "batch_size"
+    WINDOW_TYPE = "window_type"
+    WINDOW_HOP = "window_hop"
+    WINDOW_SIZE = "window_size"
+    EVENT_HANDLER_KEY = "event_handler_key"
+    WATCH_EXTENSION = "watch_extension"
+    BATCH_KEY = "batch_key"
+    SAMPLES_PER_STEP = "samples_per_step"
     MIN_SAMPLES_PER_STEP = "min_samples_per_step"
     MAX_SAMPLES_PER_STEP = "max_samples_per_step"
-    STEP_INCREMENT       = "step_increment"
-    ORIGIN               = "origin"
-    TELESCOPE            = "telescope"
-    INSTRUMENT           = "instrument"
-    OBJECT               = "object"
-    OBS_LAT              = "obs_lat"
-    OBS_LON              = "obs_lon"
-    OBS_ALT              = "obs_alt"
-    GAIN                 = "gain"
-    MASTER_CLOCK_RATE    = "master_clock_rate"
-    WIRE_FORMAT          = "wire_format"
+    STEP_INCREMENT = "step_increment"
+    ORIGIN = "origin"
+    TELESCOPE = "telescope"
+    INSTRUMENT = "instrument"
+    OBJECT = "object"
+    OBS_LAT = "obs_lat"
+    OBS_LON = "obs_lon"
+    OBS_ALT = "obs_alt"
+    GAIN = "gain"
+    MASTER_CLOCK_RATE = "master_clock_rate"
+    WIRE_FORMAT = "wire_format"