hotfix: updated pdoc and (c) year

KCL-BMEIS · Jun 26, 2024 · ad13de4 · ad13de4
1 parent 75cbe61
commit ad13de4
Show file tree

Hide file tree

Showing 33 changed files with 35 additions and 35 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/setup.cfg b/setup.cfg
@@ -55,7 +55,7 @@ dev =
  mypy == 1.6.1
  types-setuptools == 67.8.0.0
 doc =
- pdoc == 8.0.1
+ pdoc == 14.5.1
 examples =
  matplotlib >= 3.5.0
 

diff --git a/src/spectrumdevice/__init__.py b/src/spectrumdevice/__init__.py
@@ -58,7 +58,7 @@
 """
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from .measurement import Measurement

diff --git a/src/spectrumdevice/devices/__init__.py b/src/spectrumdevice/devices/__init__.py
@@ -1,5 +1,5 @@
 """Provides classes for connecting to and controlling real and mock Spectrum digitiser cards and StarHubs."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
diff --git a/src/spectrumdevice/devices/abstract_device/__init__.py b/src/spectrumdevice/devices/abstract_device/__init__.py
@@ -1,7 +1,7 @@
 """" Defines interfaces and partially implemented abstract classes containing code common to all Spectrum devices"""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from spectrumdevice.devices.abstract_device.abstract_spectrum_card import AbstractSpectrumCard

diff --git a/src/spectrumdevice/devices/abstract_device/abstract_spectrum_card.py b/src/spectrumdevice/devices/abstract_device/abstract_spectrum_card.py
@@ -2,7 +2,7 @@
 Hubs, which are aggregates of multiple cards)."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 import logging

diff --git a/src/spectrumdevice/devices/abstract_device/abstract_spectrum_channel.py b/src/spectrumdevice/devices/abstract_device/abstract_spectrum_channel.py
@@ -3,7 +3,7 @@
 from typing import Any, TypeVar, Generic
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from spectrumdevice.devices.abstract_device.channel_interfaces import (

diff --git a/src/spectrumdevice/devices/abstract_device/abstract_spectrum_device.py b/src/spectrumdevice/devices/abstract_device/abstract_spectrum_device.py
@@ -1,7 +1,7 @@
 """Defines a part-implemented abstract superclass for all Spectrum devices."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from abc import ABC

diff --git a/src/spectrumdevice/devices/abstract_device/abstract_spectrum_hub.py b/src/spectrumdevice/devices/abstract_device/abstract_spectrum_hub.py
@@ -2,7 +2,7 @@
 Spectrum cards)."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from abc import ABC

diff --git a/src/spectrumdevice/devices/abstract_device/channel_interfaces.py b/src/spectrumdevice/devices/abstract_device/channel_interfaces.py
@@ -1,7 +1,7 @@
 """Defines a common public interface for controlling all Spectrum devices and their channels."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from abc import ABC, abstractmethod

diff --git a/src/spectrumdevice/devices/digitiser/__init__.py b/src/spectrumdevice/devices/digitiser/__init__.py
@@ -1,7 +1,7 @@
 """ Provides classes for controlling Spectrum digitiser cards and hubs."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from spectrumdevice.devices.digitiser.digitiser_card import SpectrumDigitiserCard

diff --git a/src/spectrumdevice/devices/digitiser/abstract_spectrum_digitiser.py b/src/spectrumdevice/devices/digitiser/abstract_spectrum_digitiser.py
@@ -1,7 +1,7 @@
 """Defines a part-implemented abstract superclass for all Spectrum digitiser devices."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from abc import ABC

diff --git a/src/spectrumdevice/devices/digitiser/digitiser_card.py b/src/spectrumdevice/devices/digitiser/digitiser_card.py
@@ -1,7 +1,7 @@
 """Provides a concrete class for controlling an individual Spectrum digitiser card."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 import datetime
 import logging

diff --git a/src/spectrumdevice/devices/digitiser/digitiser_channel.py b/src/spectrumdevice/devices/digitiser/digitiser_channel.py
@@ -2,7 +2,7 @@
 from typing import Any
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from numpy import ndarray

diff --git a/src/spectrumdevice/devices/digitiser/digitiser_interface.py b/src/spectrumdevice/devices/digitiser/digitiser_interface.py
@@ -1,7 +1,7 @@
 """Defines public interfaces for controlling Spectrum digitiser devices and their channels."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from abc import ABC, abstractmethod
@@ -93,11 +93,11 @@ def configure_acquisition(self, settings: AcquisitionSettings) -> None:
         raise NotImplementedError()
 
     @abstractmethod
-    def execute_standard_single_acquisition(self) -> Measurement:
+    def execute_standard_single_acquisition(self, raw: bool = False) -> Measurement:
         raise NotImplementedError()
 
     @abstractmethod
-    def execute_finite_fifo_acquisition(self, num_measurements: int) -> List[Measurement]:
+    def execute_finite_fifo_acquisition(self, num_measurements: int, raw: bool = False) -> List[Measurement]:
         raise NotImplementedError()
 
     @abstractmethod

diff --git a/src/spectrumdevice/devices/digitiser/digitiser_star_hub.py b/src/spectrumdevice/devices/digitiser/digitiser_star_hub.py
@@ -1,7 +1,7 @@
 """Provides a concrete class for controlling Spectrum digitiser StarHubs."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 import datetime
 from threading import Thread

diff --git a/src/spectrumdevice/devices/mocks/__init__.py b/src/spectrumdevice/devices/mocks/__init__.py
@@ -1,7 +1,7 @@
 """Provides Mock spectrum device classes for testing software when no drivers or hardware are present."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 import logging

diff --git a/src/spectrumdevice/devices/mocks/mock_abstract_devices.py b/src/spectrumdevice/devices/mocks/mock_abstract_devices.py
@@ -1,7 +1,7 @@
 """Provides mock abstracts classes containing code common to all mock classes."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from abc import ABC

diff --git a/src/spectrumdevice/devices/mocks/mock_waveform_source.py b/src/spectrumdevice/devices/mocks/mock_waveform_source.py
@@ -1,7 +1,7 @@
 """Provides a class for generating acquired data within mock devices."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from abc import ABC, abstractmethod

diff --git a/src/spectrumdevice/devices/mocks/timestamps.py b/src/spectrumdevice/devices/mocks/timestamps.py
@@ -1,7 +1,7 @@
 """Provides a mock timestamping class."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 import datetime

diff --git a/src/spectrumdevice/devices/spectrum_timestamper.py b/src/spectrumdevice/devices/spectrum_timestamper.py
@@ -1,7 +1,7 @@
 """Provides a class for controlling the timestamping functionality of a Spectrum device."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 import struct

diff --git a/src/spectrumdevice/exceptions.py b/src/spectrumdevice/exceptions.py
@@ -5,7 +5,7 @@
 
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 

diff --git a/src/spectrumdevice/settings/__init__.py b/src/spectrumdevice/settings/__init__.py
@@ -2,7 +2,7 @@
 hardware and interpreting responses received from hardware."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from dataclasses import dataclass

diff --git a/src/spectrumdevice/settings/card_features.py b/src/spectrumdevice/settings/card_features.py
@@ -2,7 +2,7 @@
 decoding the received values into lists of features."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from enum import Enum

diff --git a/src/spectrumdevice/settings/channel.py b/src/spectrumdevice/settings/channel.py
@@ -2,7 +2,7 @@
 accessing the commands used to set vertical range and offset of each channel of a device."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from enum import Enum

diff --git a/src/spectrumdevice/settings/device_modes.py b/src/spectrumdevice/settings/device_modes.py
@@ -1,7 +1,7 @@
 """Provides Enums defining the possible acquisition and clock modes of a spectrum device."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from enum import Enum

diff --git a/src/spectrumdevice/settings/io_lines.py b/src/spectrumdevice/settings/io_lines.py
@@ -3,7 +3,7 @@
 when queried about its supported IO line modes."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from dataclasses import dataclass

diff --git a/src/spectrumdevice/settings/status.py b/src/spectrumdevice/settings/status.py
@@ -3,7 +3,7 @@
 function for decoding the integer value received by a card when queried about its status."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from enum import Enum

diff --git a/src/spectrumdevice/settings/transfer_buffer.py b/src/spectrumdevice/settings/transfer_buffer.py
@@ -4,7 +4,7 @@
 from abc import ABC, abstractmethod
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 from copy import copy
 from ctypes import c_void_p

diff --git a/src/spectrumdevice/settings/triggering.py b/src/spectrumdevice/settings/triggering.py
@@ -3,7 +3,7 @@
 received by a device when queried about its enabled trigger sources."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 from enum import Enum

diff --git a/src/spectrumdevice/spectrum_wrapper/__init__.py b/src/spectrumdevice/spectrum_wrapper/__init__.py
@@ -1,7 +1,7 @@
 """Provides Pythonic functions for communicating with Spectrum hardware. The functions wrap the C-style Spectrum API."""
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 import logging

diff --git a/src/spectrumdevice/spectrum_wrapper/error_handler.py b/src/spectrumdevice/spectrum_wrapper/error_handler.py
@@ -1,6 +1,6 @@
 """Defines an error handling wrapper function for wrapping calls to the Spectrum API."""
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 import logging

diff --git a/src/spectrumdevice/spectrum_wrapper/mock_pyspcm.py b/src/spectrumdevice/spectrum_wrapper/mock_pyspcm.py
@@ -6,7 +6,7 @@
 """
 
 # Christian Baker, King's College London
-# Copyright (c) 2021 School of Biomedical Engineering & Imaging Sciences, King's College London
+# Copyright (c) 2024 School of Biomedical Engineering & Imaging Sciences, King's College London
 # Licensed under the MIT. You may obtain a copy at https://opensource.org/licenses/MIT.
 
 import platform