Skip to content

Commit 2830e77

Browse files
Troubleshooting added
1 parent 3b77492 commit 2830e77

2 files changed

Lines changed: 55 additions & 9 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,29 @@ PICA is structured as a standard Python package.
179179
pica-cli
180180
```
181181

182+
---
183+
## Common Issues & Troubleshooting
184+
185+
This section covers the most common issues encountered when using PICA.
186+
187+
### 1. VISA Timeout Error or Resource Not Found
188+
189+
This is the most frequent issue and usually indicates a problem with the connection between the computer and the instrument. Follow these steps to resolve it:
190+
191+
1. **Check Physical Connections:** Ensure all cables (GPIB, USB, Ethernet) are securely connected to both the instrument and the computer.
192+
2. **Use the VISA Scanner:** Run the **VISA Instrument Scanner** utility from the PICA launcher.
193+
* If the instrument appears in the list, the connection is working. Note the correct VISA address.
194+
* If the instrument does **not** appear, PICA cannot see it. Proceed to the next steps.
195+
3. **Power Cycle the Instrument:** Turn the instrument off, wait a few seconds, and turn it back on. This can often resolve temporary communication hangs.
196+
4. **Restart the Computer:** If the problem persists, a full restart can resolve driver or backend issues.
197+
* Shut down the computer completely, leaving the instrument turned off.
198+
* Start the computer.
199+
* Once the system is fully booted, run the PICA VISA scanner.
200+
* Turn on the instrument.
201+
5. **Check Drivers and Communication Mode:**
202+
* Ensure you have the correct VISA backend installed (see [Pre-requisites](#pre-requisites-the-visa-driver-catch-22)).
203+
* If using a different communication interface (e.g., switching from GPIB to USB), verify that the necessary drivers are installed and that the instrument is configured for that mode.
204+
182205
---
183206
## Running Tests
184207

docs/User_Manual.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,11 @@
2626
* [High Voltage Poling](#56-high-voltage-poling)
2727
* [Dielectric Spectroscopy](#57-dielectric-spectroscopy)
2828
* [Standalone Temperature Utilities](#58-standalone-temperature-utilities)
29-
6. [Technical Reference](#6-technical-reference)
30-
7. [Citation & Funding](#7-citation--funding)
31-
8. [Future Development](#8-future-development)
32-
9. [Appendix A: Project File Structure](#9-appendix-a-project-file-structure)
29+
6. [Common Issues & Troubleshooting](#6-common-issues--troubleshooting)
30+
7. [Technical Reference](#7-technical-reference)
31+
8. [Citation & Funding](#8-citation--funding)
32+
9. [Future Development](#9-future-development)
33+
10. [Appendix A: Project File Structure](#10-appendix-a-project-file-structure)
3334

3435
<hr />
3536

@@ -121,7 +122,29 @@ pip install -r requirements-dev.txt
121122
> [!WARNING]
122123
> **Safety Instructions:** Always switch off the instrument and verify that the output current, voltage, and any other relevant parameters are set to zero before modifying the connections to the Device Under Test (DUT). Failure to follow appropriate safety procedures may result in electric shock or other hazards. Adopt a safety-first approach at all times, and ensure that all instrument parameters remain within the specified safe operating limits defined either by the instrument manufacturer or by your measurement setup.
123124
124-
## 4\. Core Utilities
125+
## 6\. Common Issues & Troubleshooting
126+
127+
This section covers the most common issues encountered when using PICA.
128+
129+
### 6.1 VISA Timeout Error or Resource Not Found
130+
131+
This is the most frequent issue and usually indicates a problem with the connection between the computer and the instrument. Follow these steps to resolve it:
132+
133+
1. **Check Physical Connections:** Ensure all cables (GPIB, USB, Ethernet) are securely connected to both the instrument and the computer.
134+
2. **Use the VISA Scanner:** Run the **VISA Instrument Scanner** utility from the PICA launcher.
135+
* If the instrument appears in the list, the connection is working. Note the correct VISA address.
136+
* If the instrument does **not** appear, PICA cannot see it. Proceed to the next steps.
137+
3. **Power Cycle the Instrument:** Turn the instrument off, wait a few seconds, and turn it back on. This can often resolve temporary communication hangs.
138+
4. **Restart the Computer:** If the problem persists, a full restart can resolve driver or backend issues.
139+
* Shut down the computer completely, leaving the instrument turned off.
140+
* Start the computer.
141+
* Once the system is fully booted, run the PICA VISA scanner.
142+
* Turn on the instrument.
143+
5. **Check Drivers and Communication Mode:**
144+
* Ensure you have the correct VISA backend installed (see the `A VISA Backend is Required` warning in the [Installation & Setup](#3-installation--setup) section).
145+
* If using a different communication interface (e.g., switching from GPIB to USB).
146+
147+
## 4. Core Utilities
125148

126149
### 4.1 VISA Instrument Scanner
127150

@@ -328,7 +351,7 @@ PICA also includes standalone utilities for monitoring and controlling temperatu
328351
<em>The standalone Temperature Control utility, providing a dedicated interface for managing temperature ramps and heater outputs on a Lakeshore 350.</em>
329352
</p>
330353

331-
## 6\. Technical Reference
354+
## 7. Technical Reference
332355

333356
### File Naming Convention
334357

@@ -348,7 +371,7 @@ PICA uses standard VISA resource strings. While the defaults below are common, u
348371
* **Keysight E4980A:** `GPIB0::17::INSTR`
349372
* **SRS SR830:** `GPIB0::8::INSTR`
350373

351-
## 7\. Citation & Funding
374+
## 8. Citation & Funding
352375

353376
**Collaborative Ecosystem:**
354377
PICA is open-source (MIT License) to foster transparency. By providing the source code, the measurement protocols become auditable, ensuring that experimental conditions are reproducible and not hidden behind a proprietary "black box." We encourage other research groups to adapt these scripts for their specific hardware configurations.
@@ -366,7 +389,7 @@ PICA is open-source (MIT License) to foster transparency. By providing the sourc
366389
}
367390
```
368391

369-
## 8\. Future Development
392+
## 9. Future Development
370393

371394
The following modules and features are currently under active development and are slated for upcoming releases.
372395

@@ -399,7 +422,7 @@ Financial support for this work was provided under SERB-CRG project grant No. CR
399422
## License
400423

401424
This project is licensed under the MIT License - see the LICENSE file for details.
402-
## 9\. Appendix A: Project File Structure
425+
## 10. Appendix A: Project File Structure
403426

404427
For developers and advanced users, the following reference outlines the PICA directory structure (v17.0).
405428

0 commit comments

Comments
 (0)