Skip to content

Commit fa9abda

Browse files
windows warning added
1 parent b326f95 commit fa9abda

File tree

3 files changed

+28
-8
lines changed

3 files changed

+28
-8
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,20 @@ A screencast demonstrating the high resistance IV module is available at [this l
158158
159159
---
160160

161-
## System Requirements
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
162175

163176
### Linux Users: Tkinter Dependency
164177

docs/User_Manual.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,19 @@ This approach, however, leads to a considerable degree of code repetition becaus
7676
## 3. Installation & Setup
7777

7878
### 3.1 System Prerequisites
79+
80+
#### System Requirements & Compatibility
81+
82+
**Supported Platform:** Windows 10 / 11
83+
**Architecture:** x86_64
84+
85+
> [!IMPORTANT]
86+
> **Windows Only**
87+
> PICA is currently designed and validated exclusively for Windows environments.
88+
> Linux and macOS are **not currently supported** due to dependencies on Windows-specific GUI libraries and font rendering.
89+
> Attempting to run this software on non-Windows platforms may result in crashes or UI failures. Linux support is experimental for now.
90+
91+
#### Software Dependencies
7992
1. **Python 3.10+**: The core execution environment.
8093
2. **Dependencies:** Install via `pip install -r requirements.txt`.
8194

@@ -105,9 +118,6 @@ PICA is structured as a standard Python package.
105118
pip install .
106119
```
107120

108-
> **Linux Users: Tkinter Dependency**
109-
> If you are running PICA on Linux, you may need to install `tkinter`, as it is not always included in default Python installations. To install it on Debian/Ubuntu, run: `sudo apt-get install python3-tk`. For other distributions, consult your package manager.
110-
111121
*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.*
112122

113123
### 3.3 Running the Software

setup.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,11 @@
33
import os
44
import shutil
55

6-
# --- Configuration ---
7-
# Get the directory where setup.py is located
6+
87
SETUP_DIR = os.path.dirname(os.path.abspath(__file__))
98
PICA_PKG_DIR = 'pica'
109

11-
# Define files to be copied, relative to the project root
1210
DATA_FILES_TO_COPY = {
13-
# Destination subdir in package: list of source files
1411
'': [
1512
'README.md',
1613
'LICENSE',

0 commit comments

Comments
 (0)