Skip to content

Commit 99e745d

Browse files
JacobTh98JacobTh98
authored
V1dev (#34)
* readme update * reworked * unit tests * unit tests * rework and linting * readme * linted * updated tests * ISX3 prep * info for operating system * v1 * updated docs
1 parent abe42c5 commit 99e745d

26 files changed

Lines changed: 2425 additions & 1590 deletions

‎.github/workflows/tests.yml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Tests
2+
3+
on:
4+
push:
5+
pull_request:
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
11+
jobs:
12+
test:
13+
name: Python ${{ matrix.python-version }}
14+
runs-on: ubuntu-latest
15+
strategy:
16+
fail-fast: false
17+
matrix:
18+
python-version: ["3.9", "3.10", "3.11", "3.12"]
19+
20+
steps:
21+
- name: Check out repository
22+
uses: actions/checkout@v5
23+
24+
- name: Set up Python ${{ matrix.python-version }}
25+
uses: actions/setup-python@v6
26+
with:
27+
python-version: ${{ matrix.python-version }}
28+
cache: pip
29+
30+
- name: Install package and test dependencies
31+
run: |
32+
python -m pip install --upgrade pip
33+
python -m pip install --editable ".[test]"
34+
35+
- name: Run static checks
36+
run: ruff check sciopy tests
37+
38+
- name: Run tests
39+
run: python -m pytest
40+
41+
build:
42+
name: Build distributions
43+
runs-on: ubuntu-latest
44+
steps:
45+
- name: Check out repository
46+
uses: actions/checkout@v5
47+
48+
- name: Set up Python
49+
uses: actions/setup-python@v6
50+
with:
51+
python-version: "3.12"
52+
cache: pip
53+
54+
- name: Install build frontend
55+
run: python -m pip install --upgrade build
56+
57+
- name: Build source and wheel distributions
58+
run: python -m build

‎README.md‎

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
This package offers the serial interface for communication with an EIT device from ScioSpec. Commands can be written serially and the system response can be read out. With the current version, it is possible to start and stop measurements with defined burst counts and to read out the measurement data. In addition, the measurement data is packed into a data class for better further processing.
44

5-
**WIP** Communication with ISX-3
6-
75
## Installation
86

97
### Windows: USB Driver Setup
@@ -18,6 +16,19 @@ To communicate with the Sciospec instrument over USB on Windows, you must instal
1816
> To restore the original behavior, you will need to uninstall the driver manually.
1917
> *(This rollback process has not been fully tested.)*
2018
19+
20+
### Linux/Unix Platforms
21+
22+
Clone the repository, then create and activate the Conda environment:
23+
24+
```bash
25+
conda create --file environment.yml
26+
conda activate sciopy
27+
pip install -e .
28+
```
29+
30+
- FTDI Driver installation: https://www.ftdichip.com/old2020/Drivers/D2XX.htm
31+
2132
#### Install `libusb` using Zadig
2233

2334
1. Download and install Zadig:
@@ -35,26 +46,17 @@ To communicate with the Sciospec instrument over USB on Windows, you must instal
3546

3647
---
3748

38-
### All Platforms
39-
40-
Clone the repository, then create and activate the Conda environment:
41-
42-
```bash
43-
conda create --file environment.yml
44-
conda activate sciopy
45-
pip install -e .
46-
```
47-
48-
49-
50-
5149

5250
## Contact
5351

5452
If you have any ideas or other suggestions, please don't hesitate to contact me.
5553

5654
Email: jacob.thoenes@uni-rostock.de
5755

56+
> [!TIP]
57+
> I developed and tested this package on an Ubuntu/Linux system. If you encounter errors or issues on other operating systems and find a solution, you are welcome to contribute it to this repository.
58+
>
59+
> Thank you!
60+
5861
___
5962

60-
- FTDI Driver installation: https://www.ftdichip.com/old2020/Drivers/D2XX.htm

‎docs/_autosummary/sciopy.EIT_16_32_64_128.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,18 @@
2525
~EIT_16_32_64_128.SoftwareReset
2626
~EIT_16_32_64_128.StartStopMeasurement
2727
~EIT_16_32_64_128.SystemMessageCallback
28-
~EIT_16_32_64_128.SystemMessageCallback_usb_fs
29-
~EIT_16_32_64_128.SystemMessageCallback_usb_hs
3028
~EIT_16_32_64_128.__init__
3129
~EIT_16_32_64_128.connect_device_FS
3230
~EIT_16_32_64_128.connect_device_HS
3331
~EIT_16_32_64_128.disconnect_device
3432
~EIT_16_32_64_128.get_data_as_matrix
3533
~EIT_16_32_64_128.init_channel_group
34+
~EIT_16_32_64_128.read_message
35+
~EIT_16_32_64_128.send_message
3636
~EIT_16_32_64_128.update_BurstCount
37+
~EIT_16_32_64_128.update_ExcitationFrequency
3738
~EIT_16_32_64_128.update_FrameRate
39+
~EIT_16_32_64_128.update_measurement_mode
3840
~EIT_16_32_64_128.write_command_string
3941

4042

‎docs/_autosummary/sciopy.ISX_3.rst‎

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,63 @@
1313

1414
.. autosummary::
1515

16-
~ISX_3.Action
16+
~ISX_3.AbortDCBias
17+
~ISX_3.AcknowledgeCompensation
18+
~ISX_3.AddFrequencyList
19+
~ISX_3.AddFrequencyPoint
20+
~ISX_3.ClearFE_Settings
21+
~ISX_3.GetARMFirmwareID
22+
~ISX_3.GetDCBias
1723
~ISX_3.GetDeviceID
24+
~ISX_3.GetEthernetConfiguration
1825
~ISX_3.GetExtensionPortChannel
1926
~ISX_3.GetExtensionPortModule
2027
~ISX_3.GetFE_Settings
28+
~ISX_3.GetFPGAFirmwareID
2129
~ISX_3.GetFPGAfirmwareID
30+
~ISX_3.GetFrequencyCount
31+
~ISX_3.GetFrequencyList
32+
~ISX_3.GetFrequencyPoint
2233
~ISX_3.GetOptions
2334
~ISX_3.GetSetup
2435
~ISX_3.GetSyncTime
36+
~ISX_3.InitSetup
37+
~ISX_3.LoadSetup
38+
~ISX_3.ResetCompensationData
2539
~ISX_3.ResetSystem
40+
~ISX_3.SaveSettings
41+
~ISX_3.SaveSetup
42+
~ISX_3.SetAmplitude
43+
~ISX_3.SetCompensationData
44+
~ISX_3.SetCompensationLoad
45+
~ISX_3.SetDCBias
46+
~ISX_3.SetDCBiasValue
47+
~ISX_3.SetEthernetConfiguration
2648
~ISX_3.SetExtensionPortChannel
2749
~ISX_3.SetFE_Settings
2850
~ISX_3.SetMeasurementSetup
2951
~ISX_3.SetOptions
30-
~ISX_3.SetSetup
3152
~ISX_3.SetSyncTime
53+
~ISX_3.SetTCPWatchdog
54+
~ISX_3.SoftwareReset
55+
~ISX_3.StartCompensation
3256
~ISX_3.StartMeasure
57+
~ISX_3.StartStopMeasurement
58+
~ISX_3.StopMeasure
3359
~ISX_3.SystemMessageCallback
3460
~ISX_3.__init__
61+
~ISX_3.build_frame
62+
~ISX_3.connect_device_FS
3563
~ISX_3.connect_device_USB2
64+
~ISX_3.decode_frame
65+
~ISX_3.describe_frame
66+
~ISX_3.disconnect_device
3667
~ISX_3.disconnect_device_USB2
68+
~ISX_3.parse_received_bytes
69+
~ISX_3.read_message
70+
~ISX_3.send_command
71+
~ISX_3.send_message
72+
~ISX_3.setup_as_dict
3773
~ISX_3.write_command_string
3874

3975

‎docs/_autosummary/sciopy.com_util.rst‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,9 @@
99
.. autosummary::
1010

1111
available_serial_ports
12-
bytesarray_to_byteslist
13-
bytesarray_to_float
14-
bytesarray_to_int
1512
clTbt_dp
1613
clTbt_sp
17-
del_hex_in_list
1814
parse_single_frame
1915
reshape_full_message_in_bursts
20-
single_hex_to_int
2116
split_bursts_in_frames
2217

‎docs/_autosummary/sciopy.sciopy_dataclasses.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
.. autosummary::
1010

11+
EITFrame
1112
EisMeasurementSetup
1213
EitMeasurementSetup
1314
PreperationConfig

0 commit comments

Comments
 (0)