Skip to content

Commit 9bf770d

Browse files
moved linux section
1 parent 378bd59 commit 9bf770d

1 file changed

Lines changed: 34 additions & 32 deletions

File tree

README.md

Lines changed: 34 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -156,40 +156,11 @@ A screencast demonstrating the high resistance IV module is available at [this l
156156
>
157157
> **Before proceeding, verify your VISA installation.**
158158
159-
---
160-
161-
## System Requirements & Compatibility
162-
163-
**Supported Platform:** Windows 10 / 11
164-
**Architecture:** x86_64
165-
166-
> [!IMPORTANT]
167-
> **Windows Only**
168-
> PICA is currently designed and validated exclusively for Windows environments.
169-
> Linux and macOS are **not currently supported** due to dependencies on Windows-specific GUI libraries and font rendering.
170-
> Attempting to run this software on non-Windows platforms may result in crashes or UI failures. Linux support is experimental for now.
171-
172-
---
173-
174-
## Software Dependencies
175-
176-
### Linux Users: Tkinter Dependency
177-
178-
If you are running PICA on Linux, you need to ensure that `tkinter` is installed on your system. `tkinter` is a standard Python interface to the Tk GUI toolkit, and it is often not included by default in minimal Python installations.
179-
180-
To install `tkinter` on Debian/Ubuntu-based distributions, use the following command:
181-
182-
```bash
183-
sudo apt-get install python3-tk
184-
```
185-
186-
For other Linux distributions, please consult your package manager's documentation for the equivalent command to install `python3-tk` or `tkinter`.
187-
188-
---
159+
---
189160

190161
## Getting Started
191162

192-
PICA is structured as a standard Python package.
163+
PICA is structured as a standard Python package. The following instructions are for the supported Windows platform.
193164

194165
1. **Clone the Repository**
195166
```bash
@@ -199,13 +170,18 @@ PICA is structured as a standard Python package.
199170

200171
2. **Create Virtual Environment & Install**
201172
```bash
173+
# Create and activate a virtual environment
202174
python -m venv venv
203-
# Activate venv (Windows: venv\Scripts\activate, Linux/Mac: source venv/bin/activate)
175+
venv\Scripts\activate
176+
177+
# Install the package and its dependencies
204178
pip install .
205179
```
206180

207181
*Note: Ensure you have the NI-VISA drivers installed on your host machine to allow [`PyVISA`](https://github.com/pyvisa/pyvisa) to communicate with the hardware.*
208182

183+
---
184+
209185
## Running the Software
210186

211187
1. **Graphical Launcher (Recommended)**
@@ -232,6 +208,17 @@ PICA is structured as a standard Python package.
232208
>
233209
> We **strongly recommend** new users utilize the PICA GUI for the most complete and supported experience.
234210

211+
## System Requirements & Compatibility
212+
213+
**Supported Platform:** Windows 10 / 11
214+
**Architecture:** x86_64
215+
216+
> [!IMPORTANT]
217+
> **Windows Only**
218+
> PICA is currently designed and validated exclusively for Windows environments.
219+
> Linux and macOS are **not currently supported** due to dependencies on Windows-specific GUI libraries and font rendering.
220+
> Attempting to run this software on non-Windows platforms may result in crashes or UI failures. Linux support is experimental for now.
221+
235222
## Example Usage: Running a Measurement
236223

237224
Upon launching PICA (`pica-gui`), select your desired measurement module from the main dashboard. Each module opens as a unified interface divided into two primary sections:
@@ -271,6 +258,21 @@ To see the coverage percentage on your local machine, run this command instead:
271258
python -B -m pytest --cov=pica --cov-report=term-missing -p no:cacheprovider
272259
```
273260

261+
### Experimental Linux Instructions
262+
263+
For users who wish to experiment with PICA on Linux, please be aware of the following:
264+
265+
1. **Tkinter Dependency (Linux):**
266+
On Linux, you must ensure `tkinter` is installed. It is often not included by default.
267+
- On Debian/Ubuntu: `sudo apt-get install python3-tk`
268+
- For other distributions, use your package manager to install `python3-tk`.
269+
270+
2. **Virtual Environment Activation (Linux):**
271+
To activate the virtual environment, use the following command:
272+
```bash
273+
source venv/bin/activate
274+
```
275+
274276
---
275277

276278
## Project History

0 commit comments

Comments
 (0)