You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23Lines changed: 23 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -179,6 +179,29 @@ PICA is structured as a standard Python package.
179
179
pica-cli
180
180
```
181
181
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.
> **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.
123
124
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
125
148
126
149
### 4.1 VISA Instrument Scanner
127
150
@@ -328,7 +351,7 @@ PICA also includes standalone utilities for monitoring and controlling temperatu
328
351
<em>The standalone Temperature Control utility, providing a dedicated interface for managing temperature ramps and heater outputs on a Lakeshore 350.</em>
329
352
</p>
330
353
331
-
## 6\. Technical Reference
354
+
## 7. Technical Reference
332
355
333
356
### File Naming Convention
334
357
@@ -348,7 +371,7 @@ PICA uses standard VISA resource strings. While the defaults below are common, u
348
371
***Keysight E4980A:**`GPIB0::17::INSTR`
349
372
***SRS SR830:**`GPIB0::8::INSTR`
350
373
351
-
## 7\. Citation & Funding
374
+
## 8. Citation & Funding
352
375
353
376
**Collaborative Ecosystem:**
354
377
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
366
389
}
367
390
```
368
391
369
-
## 8\. Future Development
392
+
## 9. Future Development
370
393
371
394
The following modules and features are currently under active development and are slated for upcoming releases.
372
395
@@ -399,7 +422,7 @@ Financial support for this work was provided under SERB-CRG project grant No. CR
399
422
## License
400
423
401
424
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
403
426
404
427
For developers and advanced users, the following reference outlines the PICA directory structure (v17.0).
0 commit comments