Skip to content

Commit 3b77492

Browse files
Pre-requisites added
1 parent 101d6f7 commit 3b77492

2 files changed

Lines changed: 20 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,19 @@ The system is currently validated with industry-standard hardware, covering a re
133133

134134
---
135135

136+
## Pre-requisites: The VISA Driver "Catch-22"
137+
138+
> [!WARNING]
139+
> **A VISA Backend is Required:** `PyVISA` is a Python wrapper, not a driver. For PICA to communicate with hardware, you **must** install a VISA backend on your system first. If you attempt to run the software on a clean machine without a VISA implementation, it will fail to find the instruments. This is the most common failure point for new instrument control setups.
140+
>
141+
> Choose one of the following:
142+
> - **NI-VISA:** The industry standard from National Instruments. Download and install it from the [NI website](https://www.ni.com/en/support/downloads/drivers/download.ni-visa.html#575764).
143+
> - **PyVISA-py:** A backend written in pure Python that is installed automatically with PICA. It can be used as a fallback but may have limitations compared to vendor-specific drivers like NI-VISA.
144+
>
145+
> **Before proceeding, verify your VISA installation.**
146+
147+
---
148+
136149
## Getting Started
137150

138151
PICA is structured as a standard Python package.

docs/User_Manual.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,13 @@ This approach, however, leads to a considerable degree of code repetition becaus
7878
2. **Dependencies:** Install via `pip install -r requirements.txt`.
7979

8080
> [!WARNING]
81-
> **A VISA Backend is Required:** Before proceeding, ensure you have installed the necessary VISA drivers from your hardware vendor (e.g., NI-VISA, Keysight IO Libraries). PICA uses PyVISA to communicate with instruments, and it will fail silently or with obscure errors if the underlying driver is not installed. This is a very common setup issue.
81+
> **A VISA Backend is Required:** `PyVISA` is a Python wrapper, not a driver. For PICA to communicate with hardware, you **must** install a VISA backend on your system first. If you attempt to run the software on a clean machine without a VISA implementation, it will fail to find the instruments. This is the most common failure point for new instrument control setups.
82+
>
83+
> Choose one of the following:
84+
> - **NI-VISA:** The industry standard from National Instruments. Download and install it from the [NI website](https://www.ni.com/en/support/downloads/drivers/download.ni-visa.html#575764).
85+
> - **PyVISA-py:** A backend written in pure Python that is installed automatically with PICA. It can be used as a fallback but may have limitations compared to vendor-specific drivers like NI-VISA.
86+
>
87+
> **Before proceeding, verify your VISA installation.**
8288
8389
### 3.2 Installation Procedure
8490
```bash

0 commit comments

Comments
 (0)