Skip to content

Commit 4b5af43

Browse files
numbering fix
1 parent 2830e77 commit 4b5af43

1 file changed

Lines changed: 31 additions & 33 deletions

File tree

docs/User_Manual.md

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -122,28 +122,6 @@ pip install -r requirements-dev.txt
122122
> [!WARNING]
123123
> **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.
124124
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-
147125
## 4. Core Utilities
148126

149127
### 4.1 VISA Instrument Scanner
@@ -188,7 +166,7 @@ The control window also contains a console located below the parameter settings.
188166

189167
Above the plot area, there are two buttons providing access to the [VISA Instrument Scanner](#41-visa-instrument-scanner) and [PICA Plotter Utility](#42-pica-plotter-utility). These utilities are accessible from all modules to facilitate rapid testing and diagnostics. The VISA/GPIB scanner allows the user to quickly verify whether instruments are properly connected and recognized by the system, while the plotter utility offers additional plotting capabilities beyond those available in the default plot window.
190168

191-
## 5\. Supported Measurement Modules
169+
## 5. Supported Measurement Modules
192170

193171
PICA is designed to be as versatile as possible, while being optimized for specific classes of instruments. The following modules represent the core capabilities of the suite, supporting a resistance scale spanning **24 orders of magnitude** (10 nOhm to 10 POhm) depending on the hardware used.
194172

@@ -351,15 +329,37 @@ PICA also includes standalone utilities for monitoring and controlling temperatu
351329
<em>The standalone Temperature Control utility, providing a dedicated interface for managing temperature ramps and heater outputs on a Lakeshore 350.</em>
352330
</p>
353331

332+
## 6. Common Issues & Troubleshooting
333+
334+
This section covers the most common issues encountered when using PICA.
335+
336+
### 6.1 VISA Timeout Error or Resource Not Found
337+
338+
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:
339+
340+
1. **Check Physical Connections:** Ensure all cables (GPIB, USB, Ethernet) are securely connected to both the instrument and the computer.
341+
2. **Use the VISA Scanner:** Run the **VISA Instrument Scanner** utility from the PICA launcher.
342+
* If the instrument appears in the list, the connection is working. Note the correct VISA address.
343+
* If the instrument does **not** appear, PICA cannot see it. Proceed to the next steps.
344+
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.
345+
4. **Restart the Computer:** If the problem persists, a full restart can resolve driver or backend issues.
346+
* Shut down the computer completely, leaving the instrument turned off.
347+
* Start the computer.
348+
* Once the system is fully booted, run the PICA VISA scanner.
349+
* Turn on the instrument.
350+
5. **Check Drivers and Communication Mode:**
351+
* Ensure you have the correct VISA backend installed (see the `A VISA Backend is Required` warning in the [Installation & Setup](#3-installation--setup) section).
352+
* 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.
353+
354354
## 7. Technical Reference
355355

356-
### File Naming Convention
356+
### 7.1 File Naming Convention
357357

358358
To ensure data integrity and easy sorting, PICA automatically generates filenames using a standardized format. This allows for easier parsing by external analysis tools.
359359
Format: `[SampleName]_[Timestamp]_[Identifier].dat`
360360
Example: `SampleA_2025-12-04_1430_IV_Sweep.dat`
361361

362-
### GPIB Address Guide
362+
### 7.2 GPIB Address Guide
363363

364364
PICA uses standard VISA resource strings. While the defaults below are common, users should verify their specific instrument addresses using the built-in **Instrument Scanner** or front-panel settings.
365365

@@ -391,9 +391,7 @@ PICA is open-source (MIT License) to foster transparency. By providing the sourc
391391

392392
## 9. Future Development
393393

394-
The following modules and features are currently under active development and are slated for upcoming releases.
395-
396-
### 8.1 AC Resistivity (Lock-In)
394+
### 9.1 AC Resistivity (Lock-In)
397395

398396
*Status: Under Development*
399397

@@ -403,12 +401,12 @@ The following modules and features are currently under active development and ar
403401
* **Use Case:** Useful for distinguishing between different conduction mechanisms by analyzing the frequency response of the sample's resistance.
404402
* **Workflow:** The Keithley 6221 provides a precise AC excitation current, while the Lock-In Amplifier (SR830) extracts the signal amplitude and phase with high noise rejection, allowing for measurements in high-noise environments.
405403

406-
### 8.2 Standalone Executables
404+
### 9.2 Standalone Executables
407405

408406
In the future, We also plan to develop executable (`.exe`) versions of the PICA software suite. This will remove the need for users to manage Python environments and dependencies, further simplifying the setup process and facilitating rapid adoption in laboratories with strict IT policies or offline computers.
409407

410408

411-
## Authors & Acknowledgments
409+
## 10. Authors & Acknowledgments
412410
<p align="center">
413411
<img src="../pica/assets/LOGO/UGC_DAE_CSR_NBG.jpeg" alt="UGC DAE CSR Logo" width="150">
414412
</p>
@@ -419,10 +417,10 @@ In the future, We also plan to develop executable (`.exe`) versions of the PICA
419417
**Funding:**
420418
Financial support for this work was provided under SERB-CRG project grant No. CRG/2022/005676 from the Anusandhan National Research Foundation (ANRF).
421419

422-
## License
420+
## 11. License
423421

424422
This project is licensed under the MIT License - see the LICENSE file for details.
425-
## 10. Appendix A: Project File Structure
423+
## 12. Appendix A: Project File Structure
426424

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

@@ -490,4 +488,4 @@ PICA (Root Directory)/
490488
GPIB_Instrument_Scanner_GUI.py
491489
PlotterUtil_GUI.py
492490
tests/ <-- Automated Test Suite
493-
```
491+
```

0 commit comments

Comments
 (0)