horiba-sdk 0.3.3__tar.gz → 0.4.0__tar.gz

{horiba_sdk-0.3.3 → horiba_sdk-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: horiba-sdk
-Version: 0.3.3
+Version: 0.4.0
 Summary: 'horiba-sdk' is a package that provides source code for the development with Horiba devices
 Home-page: https://github.com/ThatsTheEnd/horiba-python-sdk
 License: MIT
@@ -18,7 +18,6 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: loguru (>=0.7.2,<0.8.0)
-Requires-Dist: numericalunits (>=1.25,<2.0)
 Requires-Dist: overrides (>=7.4.0,<8.0.0)
 Requires-Dist: pint (>=0.23,<0.24)
 Requires-Dist: psutil (>=5.9.7,<6.0.0)
@@ -47,13 +46,70 @@ Description-Content-Type: text/markdown
 
 </div>
 
+___
+
+⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️
+
+> [!WARNING]  
+> This SDK is under development and not yet released.
+
+> [!IMPORTANT]  
+> For this python code to work, the SDK from Horiba has to be purchased, installed and licensed.
+> The code in this repo and the SDK are under development and not yet released for public use!
+
+⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️
+
+___
+
 **📦 Prerequisites**
 
 * Python `>=3.9`
-* ICL
+* ICL.exe installed as part of the Horiba SDK, licensed and activated
+
+  <details>
+  <summary>To make sure that the USB devices do not get disconnected, uncheck the following boxes in the properties</summary>
+
+  ![generic usb hub properties](docs/source/images/generic_usb_hub_properties.png)
+
+  </details>
 
 ## 🛠️ Usage
 
+<details>
+<summary>Video of the steps below</summary>
+
+![first steps in python](docs/source/images/python_first_steps.gif)
+
+</details>
+
+0. (Optional but recommended) Work in a virtual environment:
+
+   Navigate to the (empty) project folder you want to work and run:
+
+   ```bash
+   python -m venv .
+   ```
+
+   Activate the virtual environment:
+
+   <details>
+   <summary>Windows</summary>
+
+   ```powershell
+   .\Scripts\activate
+   ```
+   </details>
+
+   <details>
+   <summary>Unix</summary>
+
+   ```bash
+   source ./bin/activate
+   ```
+   </details>
+
+   *Note: do deactivate it, simply run `deactivate`.*
+
 
 1. Install the sdk:
 
@@ -68,10 +124,21 @@ Description-Content-Type: text/markdown
    ```
 
 2. Create a file named `center_scan.py` and copy-paste the content of
-   [`examples/asynchronous_examples/center_scan.py`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/feature/publishing/examples/asynchronous_examples/center_scan.py)
+   [`examples/asynchronous_examples/center_scan.py`](examples/asynchronous_examples/center_scan.py)
+
+3. Install the required library for plotting the graph in the example:
+
+   ```bash
+   pip install matplotlib
+   ```
+
+   or install with `Poetry`
 
+   ```bash
+   poetry add matplotlib
+   ```
 
-3. Run the example with:
+4. Run the example with:
 
    ```bash
    python center_scan.py
@@ -79,13 +146,13 @@ Description-Content-Type: text/markdown
 
 ## 👩‍💻 First steps as contributor
 
-### Initialize your code
+### Clone and setup the repo
 
-1. Initialize `git` inside your repo:
+1. Clone the repo:
 
 ```bash
+git clone https://github.com/ThatsTheEnd/horiba-python-sdk.git
 cd horiba-python-sdk
-git init
 ```
 
 2. If you don't have `Poetry` installed run:
@@ -107,14 +174,12 @@ make pre-commit-install
 make codestyle
 ```
 
-5. Upload initial code to GitHub:
+5. To push local changes to the remote repository, run:
 
 ```bash
 git add .
-git commit -m ":tada: Initial commit"
-git branch -M main
-git remote add origin https://github.com/ThatsTheEnd/horiba-python-sdk.git
-git push -u origin main
+git commit -m "feat: add new feature xyz"
+git push
 ```
 
 <!-- ### Set up bots -->
@@ -262,7 +327,37 @@ make mypy
 
 Run `pytest`
 
+Unix:
+
+```bash
+make test
+```
+
+Windows:
+
+```powershell
+poetry run pytest -c pyproject.toml --cov-report=html --cov=horiba_sdk tests/
+```
+
+For the hardware tests run the following:
+
+Windows:
+
+```powershell
+$env:HAS_HARDWARE="true"
+# If you want a remote ICL be used for the tests
+# $env:TEST_ICL_IP="192.168.21.24"
+# $env:TEST_ICL_PORT="1234"
+poetry run pytest -c pyproject.toml --cov-report=html --cov=horiba_sdk tests/
+```
+
+Unix:
+
 ```bash
+HAS_HARDWARE="true"
+# If you want a remote ICL be used for the tests
+# TEST_ICL_IP="192.168.21.24"
+# TEST_ICL_PORT="1234"
 make test
 ```
 

{horiba_sdk-0.3.3 → horiba_sdk-0.4.0}/README.md

@@ -19,13 +19,70 @@
 
 </div>
 
+___
+
+⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️
+
+> [!WARNING]  
+> This SDK is under development and not yet released.
+
+> [!IMPORTANT]  
+> For this python code to work, the SDK from Horiba has to be purchased, installed and licensed.
+> The code in this repo and the SDK are under development and not yet released for public use!
+
+⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️
+
+___
+
 **📦 Prerequisites**
 
 * Python `>=3.9`
-* ICL
+* ICL.exe installed as part of the Horiba SDK, licensed and activated
+
+  <details>
+  <summary>To make sure that the USB devices do not get disconnected, uncheck the following boxes in the properties</summary>
+
+  ![generic usb hub properties](docs/source/images/generic_usb_hub_properties.png)
+
+  </details>
 
 ## 🛠️ Usage
 
+<details>
+<summary>Video of the steps below</summary>
+
+![first steps in python](docs/source/images/python_first_steps.gif)
+
+</details>
+
+0. (Optional but recommended) Work in a virtual environment:
+
+   Navigate to the (empty) project folder you want to work and run:
+
+   ```bash
+   python -m venv .
+   ```
+
+   Activate the virtual environment:
+
+   <details>
+   <summary>Windows</summary>
+
+   ```powershell
+   .\Scripts\activate
+   ```
+   </details>
+
+   <details>
+   <summary>Unix</summary>
+
+   ```bash
+   source ./bin/activate
+   ```
+   </details>
+
+   *Note: do deactivate it, simply run `deactivate`.*
+
 
 1. Install the sdk:
 
@@ -40,10 +97,21 @@
    ```
 
 2. Create a file named `center_scan.py` and copy-paste the content of
-   [`examples/asynchronous_examples/center_scan.py`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/feature/publishing/examples/asynchronous_examples/center_scan.py)
+   [`examples/asynchronous_examples/center_scan.py`](examples/asynchronous_examples/center_scan.py)
+
+3. Install the required library for plotting the graph in the example:
+
+   ```bash
+   pip install matplotlib
+   ```
+
+   or install with `Poetry`
 
+   ```bash
+   poetry add matplotlib
+   ```
 
-3. Run the example with:
+4. Run the example with:
 
    ```bash
    python center_scan.py
@@ -51,13 +119,13 @@
 
 ## 👩‍💻 First steps as contributor
 
-### Initialize your code
+### Clone and setup the repo
 
-1. Initialize `git` inside your repo:
+1. Clone the repo:
 
 ```bash
+git clone https://github.com/ThatsTheEnd/horiba-python-sdk.git
 cd horiba-python-sdk
-git init
 ```
 
 2. If you don't have `Poetry` installed run:
@@ -79,14 +147,12 @@ make pre-commit-install
 make codestyle
 ```
 
-5. Upload initial code to GitHub:
+5. To push local changes to the remote repository, run:
 
 ```bash
 git add .
-git commit -m ":tada: Initial commit"
-git branch -M main
-git remote add origin https://github.com/ThatsTheEnd/horiba-python-sdk.git
-git push -u origin main
+git commit -m "feat: add new feature xyz"
+git push
 ```
 
 <!-- ### Set up bots -->
@@ -234,7 +300,37 @@ make mypy
 
 Run `pytest`
 
+Unix:
+
+```bash
+make test
+```
+
+Windows:
+
+```powershell
+poetry run pytest -c pyproject.toml --cov-report=html --cov=horiba_sdk tests/
+```
+
+For the hardware tests run the following:
+
+Windows:
+
+```powershell
+$env:HAS_HARDWARE="true"
+# If you want a remote ICL be used for the tests
+# $env:TEST_ICL_IP="192.168.21.24"
+# $env:TEST_ICL_PORT="1234"
+poetry run pytest -c pyproject.toml --cov-report=html --cov=horiba_sdk tests/
+```
+
+Unix:
+
 ```bash
+HAS_HARDWARE="true"
+# If you want a remote ICL be used for the tests
+# TEST_ICL_IP="192.168.21.24"
+# TEST_ICL_PORT="1234"
 make test
 ```
 

{horiba_sdk-0.3.3 → horiba_sdk-0.4.0}/horiba_sdk/__init__.py

@@ -4,8 +4,6 @@
 __version__ = '0.2.0'  # It MUST match the version in pyproject.toml file
 from importlib import metadata as importlib_metadata
 
-from pint import UnitRegistry
-
 
 def get_version() -> str:
     try:
@@ -15,5 +13,3 @@ def get_version() -> str:
 
 
 version: str = get_version()
-
-ureg = UnitRegistry()

horiba_sdk-0.4.0/horiba_sdk/core/acquisition_format.py

@@ -0,0 +1,10 @@
+from enum import Enum
+from typing import final
+
+
+@final
+class AcquisitionFormat(Enum):
+    SPECTRA = 0
+    IMAGE = 1
+    CROP = 2
+    FAST_KINETICS = 3

horiba_sdk-0.4.0/horiba_sdk/core/clean_count_mode.py

@@ -0,0 +1,11 @@
+from enum import Enum
+from typing import final
+
+
+@final
+class CleanCountMode(Enum):
+    NEVER = 0
+    FIRST_ONLY = 1
+    BETWEEN_ONLY = 2
+    EACH = 3
+    UNKNOWN = 238

horiba_sdk-0.4.0/horiba_sdk/core/timer_resolution.py

@@ -0,0 +1,12 @@
+from enum import Enum
+from typing import final
+
+
+@final
+class TimerResolution(Enum):
+    """
+    .. note:: The timer resolution value of 1 microsecond is not supported by all CCDs.
+    """
+
+    _1000_MICROSECONDS = 0
+    _1_MICROSECOND = 1

horiba_sdk-0.4.0/horiba_sdk/core/x_axis_conversion_type.py

@@ -0,0 +1,13 @@
+from enum import Enum
+from typing import final
+
+
+@final
+class XAxisConversionType(Enum):
+    """
+    Enumeration of possible XAxisConversionTypes
+    """
+
+    NONE = 0
+    FROM_CCD_FIRMWARE = 1
+    FROM_ICL_SETTINGS_INI = 2

{horiba_sdk-0.3.3 → horiba_sdk-0.4.0}/horiba_sdk/devices/ccd_discovery.py

@@ -1,4 +1,3 @@
-import re
 from typing import Any, final
 
 from loguru import logger
@@ -32,24 +31,23 @@ class ChargeCoupledDevicesDiscovery(AbstractDeviceDiscovery):
         response: Response = await self._communicator.request_with_response(Command('ccd_discover', {}))
         if response.results.get('count', 0) == 0 and error_on_no_device:
             raise Exception('No CCDs connected')
+
         response = await self._communicator.request_with_response(Command('ccd_list', {}))
 
         raw_device_list = response.results
         self._charge_coupled_devices = self._parse_ccds(raw_device_list)
-        logger.info(f'Found {len(self._charge_coupled_devices)} CCD devices: {self._charge_coupled_devices}')
+        logger.info(f'Found {len(self._charge_coupled_devices)} CCD devices')
 
     def _parse_ccds(self, raw_device_list: dict[str, Any]) -> list[ChargeCoupledDevice]:
         detected_ccds: list[ChargeCoupledDevice] = []
-        for key, value in raw_device_list.items():
-            logger.debug(f'Parsing CCD: {key} - {value}')
-            ccd_index: int = int(key.split(':')[0].replace('index', '').strip())
-            ccd_type_match = re.search(r'deviceType: (.*?),', value)
-            if not ccd_type_match:
-                raise Exception(f'Failed to find ccd type "deviceType" in string "{value}"')
-            ccd_type: str = str(ccd_type_match.group(1).strip())
-
-            logger.info(f'Detected CCD: {ccd_type}')
-            detected_ccds.append(ChargeCoupledDevice(ccd_index, self._communicator, self._error_db))
+        for device in raw_device_list['devices']:
+            try:
+                logger.debug(f'Parsing CCD: {device}')
+                ccd = ChargeCoupledDevice(device['index'], self._communicator, self._error_db)
+                logger.info(f'Detected CCD: {device["deviceType"]}')
+                detected_ccds.append(ccd)
+            except Exception as e:
+                logger.error(f'Error while parsing ChargeCoupledDevice: {e}')
 
         return detected_ccds
 

{horiba_sdk-0.3.3 → horiba_sdk-0.4.0}/horiba_sdk/devices/device_manager.py

@@ -63,8 +63,8 @@ class DeviceManager(AbstractDeviceManager):
     def __init__(
         self,
         start_icl: bool = True,
-        websocket_ip: str = '127.0.0.1',
-        websocket_port: str = '25010',
+        icl_ip: str = '127.0.0.1',
+        icl_port: str = '25010',
         enable_binary_messages: bool = True,
     ):
         """
@@ -72,18 +72,16 @@ class DeviceManager(AbstractDeviceManager):
 
         Args:
             start_icl (bool) = True: If True, the ICL software is started and communication is established.
-            websocket_ip (str) = '127.0.0.1': websocket IP
-            websocket_port (str) = '25010': websocket port
+            icl_ip (str) = '127.0.0.1': websocket IP
+            icl_port (str) = '25010': websocket port
             enable_binary_messages (bool) = True: If True, binary messages are enabled.
         """
         super().__init__()
         self._start_icl = start_icl
-        self._icl_communicator: WebsocketCommunicator = WebsocketCommunicator(
-            'ws://' + websocket_ip + ':' + str(websocket_port)
-        )
+        self._icl_communicator: WebsocketCommunicator = WebsocketCommunicator('ws://' + icl_ip + ':' + str(icl_port))
         self._icl_communicator.register_binary_message_callback(self._binary_message_callback)
-        self._icl_websocket_ip: str = websocket_ip
-        self._icl_websocket_port: str = websocket_port
+        self._icl_websocket_ip: str = icl_ip
+        self._icl_websocket_port: str = icl_port
         self._icl_process: Optional[asyncio.subprocess.Process] = None
         self._binary_messages: bool = enable_binary_messages
         self._charge_coupled_devices: list[ChargeCoupledDevice] = []
@@ -109,7 +107,12 @@ class DeviceManager(AbstractDeviceManager):
 
     @override
     async def stop(self) -> None:
-        await self.stop_icl()
+        if self._start_icl:
+            await self.stop_icl()
+            return
+
+        if self._icl_communicator.opened():
+            await self._icl_communicator.close()
 
     async def start_icl(self) -> None:
         """