From 1ebda98a0bca91cfd9bb70fb7b10e13171cd0e78 Mon Sep 17 00:00:00 2001 From: jupfi Date: Mon, 29 Apr 2024 19:40:37 +0200 Subject: [PATCH] Linting. --- .../__init__.py | 1 + .../controller.py | 20 +++++++++--- src/nqrduck_spectrometer_simulator/model.py | 31 +++++++++++-------- .../simulator.py | 4 ++- src/nqrduck_spectrometer_simulator/view.py | 8 ++++- 5 files changed, 45 insertions(+), 19 deletions(-) diff --git a/src/nqrduck_spectrometer_simulator/__init__.py b/src/nqrduck_spectrometer_simulator/__init__.py index e69de29..ff9f2b7 100644 --- a/src/nqrduck_spectrometer_simulator/__init__.py +++ b/src/nqrduck_spectrometer_simulator/__init__.py @@ -0,0 +1 @@ +"""Init file for the nqrduck_spectrometer_simulator package.""" \ No newline at end of file diff --git a/src/nqrduck_spectrometer_simulator/controller.py b/src/nqrduck_spectrometer_simulator/controller.py index f5f6d2f..f462a8f 100644 --- a/src/nqrduck_spectrometer_simulator/controller.py +++ b/src/nqrduck_spectrometer_simulator/controller.py @@ -1,3 +1,5 @@ +"""The controller module for the simulator spectrometer.""" + import logging import numpy as np from nqrduck_spectrometer.base_spectrometer_controller import BaseSpectrometerController @@ -11,11 +13,15 @@ logger = logging.getLogger(__name__) class SimulatorController(BaseSpectrometerController): + """The controller class for the nqrduck simulator module.""" + def __init__(self, module): + """Initializes the SimulatorController.""" super().__init__(module) def start_measurement(self): """This method is called when the start_measurement signal is received from the core. + It will becalled if the simulator is the active spectrometer. This will start the simulation based on the settings and the pulse sequence. """ @@ -31,11 +37,12 @@ class SimulatorController(BaseSpectrometerController): except ValueError: logger.warning("Could not translate pulse sequence") self.module.nqrduck_signal.emit( - "measurement_error", "Could not translate pulse sequence. Did you configure one?" + "measurement_error", + "Could not translate pulse sequence. Did you configure one?", ) return - simulation = self.get_simulation(sample, pulse_array) + simulation = self.get_simulation(sample, pulse_array) result = simulation.simulate() @@ -206,7 +213,7 @@ class SimulatorController(BaseSpectrometerController): """ model = self.module.model - noise = float(model.get_setting_by_name(model.NOISE).value) + # noise = float(model.get_setting_by_name(model.NOISE).value) simulation = Simulation( sample=sample, pulse=pulse_array, @@ -276,7 +283,7 @@ class SimulatorController(BaseSpectrometerController): events = self.module.model.pulse_programmer.model.pulse_sequence.events previous_events_duration = 0 - offset = 0 + # offset = 0 rx_duration = 0 for event in events: logger.debug("Event %s has parameters: %s", event.name, event.parameters) @@ -306,7 +313,11 @@ class SimulatorController(BaseSpectrometerController): def set_frequency(self, value: str) -> None: """This method is called when the set_frequency signal is received from the core. + For the simulator this just prints a warning that the simulator is selected. + + Args: + value (str) : The new frequency in MHz. """ logger.debug("Setting frequency to: %s", value) try: @@ -321,6 +332,7 @@ class SimulatorController(BaseSpectrometerController): def set_averages(self, value: str) -> None: """This method is called when the set_averages signal is received from the core. + It sets the averages in the model used for the simulation. Args: diff --git a/src/nqrduck_spectrometer_simulator/model.py b/src/nqrduck_spectrometer_simulator/model.py index 83be325..d74e2f8 100644 --- a/src/nqrduck_spectrometer_simulator/model.py +++ b/src/nqrduck_spectrometer_simulator/model.py @@ -1,3 +1,5 @@ +"""The model module for the simulator spectrometer.""" + import logging from nqrduck_spectrometer.base_spectrometer_model import BaseSpectrometerModel from nqrduck_spectrometer.pulseparameters import TXPulse, RXReadout @@ -11,6 +13,8 @@ logger = logging.getLogger(__name__) class SimulatorModel(BaseSpectrometerModel): + """Model class for the simulator spectrometer.""" + # Simulation settings NUMBER_POINTS = "N. simulation points" NUMBER_ISOCHROMATS = "N. of isochromats" @@ -61,6 +65,7 @@ class SimulatorModel(BaseSpectrometerModel): RX = "RX" def __init__(self, module): + """Initializes the SimulatorModel.""" super().__init__(module) # Simulation settings @@ -161,9 +166,7 @@ class SimulatorModel(BaseSpectrometerModel): "The power output capability of the power amplifier, determines the strength of pulses that can be generated.", min_value=0.1, ) - self.add_setting( - power_amplifier_power_setting, self.HARDWARE - ) + self.add_setting(power_amplifier_power_setting, self.HARDWARE) gain_setting = FloatSetting( self.GAIN, @@ -171,9 +174,7 @@ class SimulatorModel(BaseSpectrometerModel): "The amplification factor of the receiver chain, impacting the final measured signal amplitude.", min_value=0.1, ) - self.add_setting( - gain_setting, self.HARDWARE - ) + self.add_setting(gain_setting, self.HARDWARE) temperature_setting = FloatSetting( self.TEMPERATURE, @@ -245,9 +246,7 @@ class SimulatorModel(BaseSpectrometerModel): "The resonant frequency of the observed transition.", min_value=1e5, ) - self.add_setting( - resonant_frequency_setting, self.SAMPLE - ) + self.add_setting(resonant_frequency_setting, self.SAMPLE) gamma_setting = FloatSetting( self.GAMMA, @@ -263,7 +262,6 @@ class SimulatorModel(BaseSpectrometerModel): 9 / 2, "The nuclear spin of the sample’s nuclei.", min_value=0, - ) self.add_setting(nuclear_spin_setting, self.SAMPLE) @@ -325,7 +323,7 @@ class SimulatorModel(BaseSpectrometerModel): self.add_pulse_parameter_option(self.RX, RXReadout) self.averages = 1 - self.target_frequency = 100e6 + self.target_frequency = 100e6 # Try to load the pulse programmer module try: @@ -339,6 +337,10 @@ class SimulatorModel(BaseSpectrometerModel): @property def averages(self): + """The number of averages used for the simulation. + + More averages improve the signal-to-noise ratio of the simulated signal. + """ return self._averages @averages.setter @@ -347,9 +349,12 @@ class SimulatorModel(BaseSpectrometerModel): @property def target_frequency(self): + """The target frequency for the simulation. + + Doesn't do anything at the moment. + """ return self._target_frequency - + @target_frequency.setter def target_frequency(self, value): self._target_frequency = value - diff --git a/src/nqrduck_spectrometer_simulator/simulator.py b/src/nqrduck_spectrometer_simulator/simulator.py index 1a88510..84d7936 100644 --- a/src/nqrduck_spectrometer_simulator/simulator.py +++ b/src/nqrduck_spectrometer_simulator/simulator.py @@ -1,6 +1,8 @@ +"""Creation of the Simulator Spectrometer.""" + from nqrduck_spectrometer.base_spectrometer import BaseSpectrometer from .model import SimulatorModel from .view import SimulatorView from .controller import SimulatorController -Simulator = BaseSpectrometer(SimulatorModel, SimulatorView, SimulatorController) \ No newline at end of file +Simulator = BaseSpectrometer(SimulatorModel, SimulatorView, SimulatorController) diff --git a/src/nqrduck_spectrometer_simulator/view.py b/src/nqrduck_spectrometer_simulator/view.py index 74c4e8d..9ba62d3 100644 --- a/src/nqrduck_spectrometer_simulator/view.py +++ b/src/nqrduck_spectrometer_simulator/view.py @@ -1,7 +1,13 @@ +"""The View class for the simulator module.""" + from nqrduck_spectrometer.base_spectrometer_view import BaseSpectrometerView + class SimulatorView(BaseSpectrometerView): + """The View class for the simulator module.""" + def __init__(self, module): + """Initializes the SimulatorView.""" super().__init__(module) # This automatically generates the settings widget based on the settings in the model - self.widget = self.load_settings_ui() \ No newline at end of file + self.widget = self.load_settings_ui()