Skip to content

Commit 1b9bbd2

Browse files
linux warning updated
1 parent 64f4b10 commit 1b9bbd2

2 files changed

Lines changed: 48 additions & 12 deletions

File tree

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,11 @@ PICA is structured as a standard Python package. The following instructions are
178178
pip install .
179179
```
180180

181+
To update PICA to the latest version, run the following command in the project directory:
182+
```bash
183+
pip install --upgrade .
184+
```
185+
181186
*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.*
182187

183188
---
@@ -260,18 +265,22 @@ python -B -m pytest --cov=pica --cov-report=term-missing -p no:cacheprovider
260265

261266
### Experimental Linux Instructions
262267

263-
For users who wish to experiment with PICA on Linux, please be aware of the following:
268+
> [!WARNING]
269+
> **Experimental Support:** The following instructions are for experimental purposes only. PICA is not officially supported on Linux (for now), and you will likely encounter functional or UI-related issues.
264270

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`.
271+
For users who wish to experiment with PICA on Linux, please be aware of the following:
269272

270-
2. **Virtual Environment Activation (Linux):**
271-
To activate the virtual environment, use the following command:
272-
```bash
273-
source venv/bin/activate
274-
```
273+
1. **Prerequisites:**
274+
* **Tkinter Dependency:** On Linux, you must ensure `tkinter` is installed, as it is often not included by default.
275+
- On Debian/Ubuntu: `sudo apt-get install python3-tk`
276+
- For other distributions, use your package manager to install `python3-tk`.
277+
* **Virtual Environment Activation:** To activate the virtual environment, use:
278+
```bash
279+
source venv/bin/activate
280+
```
281+
282+
2. **Installation:**
283+
Follow the standard installation steps outlined in the [Getting Started](#getting-started) section. While the commands should run, be aware that the application GUI may not function correctly.
275284

276285
---
277286

docs/User_Manual.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ This approach, however, leads to a considerable degree of code repetition becaus
103103
104104
### 3.2 Getting Started
105105

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

108108
1. **Clone the Repository**
109109
```bash
@@ -113,11 +113,19 @@ PICA is structured as a standard Python package.
113113

114114
2. **Create Virtual Environment & Install**
115115
```bash
116+
# Create and activate a virtual environment
116117
python -m venv venv
117-
# Activate venv (Windows: venv\Scripts\activate, Linux/Mac: source venv/bin/activate)
118+
venv\Scripts\activate
119+
120+
# Install the package and its dependencies
118121
pip install .
119122
```
120123

124+
To update PICA to the latest version, run the following command in the project directory:
125+
```bash
126+
pip install --upgrade .
127+
```
128+
121129
*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.*
122130

123131
### 3.3 Running the Software
@@ -165,6 +173,25 @@ To see the coverage percentage on your local machine, run this command instead:
165173
python -B -m pytest --cov=pica --cov-report=term-missing -p no:cacheprovider
166174
```
167175
176+
#### Experimental Linux Instructions
177+
178+
> [!WARNING]
179+
> **Experimental Support:** The following instructions are for experimental purposes only. PICA is not officially supported on Linux, and you will likely encounter functional or UI-related issues.
180+
181+
For users who wish to experiment with PICA on Linux, please be aware of the following:
182+
183+
1. **Prerequisites:**
184+
* **Tkinter Dependency:** On Linux, you must ensure `tkinter` is installed, as it is often not included by default.
185+
- On Debian/Ubuntu: `sudo apt-get install python3-tk`
186+
- For other distributions, use your package manager to install `python3-tk`.
187+
* **Virtual Environment Activation:** To activate the virtual environment, use:
188+
```bash
189+
source venv/bin/activate
190+
```
191+
192+
2. **Installation:**
193+
Follow the standard installation steps outlined in section [3.2 Getting Started](#32-getting-started). While the commands should run, be aware that the application may not function correctly.
194+
168195
## 4. Safety Precautions
169196
170197
> [!WARNING]

0 commit comments

Comments
 (0)