Skip to content

Commit abe42c5

Browse files
Better installation instruction (#33)
* Create environment.yml * Update README.md description of the dirvers installation and environment.yml * Update README.md * Create test_EITphantom.ipynb * Update installation instructions New info for the driver installation in Windows. yml file for easy environment setup. Complete instruction to set up the environment.
1 parent b0d0998 commit abe42c5

4 files changed

Lines changed: 516 additions & 8 deletions

File tree

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,51 @@ This package offers the serial interface for communication with an EIT device fr
44

55
**WIP** Communication with ISX-3
66

7+
## Installation
8+
9+
### Windows: USB Driver Setup
10+
11+
To communicate with the Sciospec instrument over USB on Windows, you must install the `libusb` driver.
12+
13+
> [!WARNING]
14+
> Installing the `libusb` driver will prevent the Sciospec instrument from working with the official Sciospec software on the selected USB port (`FS` or `HS`).
15+
>
16+
> After installation, the Sciospec software may no longer recognize the device on that port.
17+
>
18+
> To restore the original behavior, you will need to uninstall the driver manually.
19+
> *(This rollback process has not been fully tested.)*
20+
21+
#### Install `libusb` using Zadig
22+
23+
1. Download and install Zadig:
24+
https://zadig.akeo.ie/
25+
26+
2. Connect the Sciospec instrument to your computer.
27+
28+
3. Open Zadig and enable:
29+
Options → List All Devices
30+
31+
4. Select the correct Sciospec USB device from the list.
32+
33+
5. Install the driver:
34+
`libusb-win32 (v1.4.0.0)`
35+
36+
---
37+
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+
51+
752
## Contact
853

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

environment.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: sciopy # This will become the name of your environment
2+
dependencies: # The list of packages to include in your environment
3+
- python=3.10 # You can specify versions
4+
- matplotlib=3.10.8
5+
- numpy=2.2.5
6+
- Pandas=2.3.3
7+
- pyserial=3.5
8+
- setuptools=82.0.1
9+
- tqdm=4.67.3
10+
- pip=26.0.1 # Install pip in your Environment
11+
- pip: # Include pip dependencies last
12+
- pyeit
13+
- pyftdi

examples/test_EITphantom.ipynb

Lines changed: 458 additions & 0 deletions
Large diffs are not rendered by default.

requirements.txt

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)