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
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -141,6 +141,8 @@ The system is currently validated with industry-standard hardware, covering a re
141
141
142
142
*While the current implementation drives specific instruments, the underlying framework is highly customizable. Researchers need only replace specific SCPI commands to utilize the suite with different models.*
143
143
144
+
145
+
144
146
> [!NOTE]
145
147
> **Understanding "Delta Mode":** The term "Delta Mode" refers specifically to a technique used by Keithley Models 6220 and 6221 Current Sources in conjunction with the Model 2182/2182A Nanovoltmeter for very low resistance measurements. This method is described in detail in the [Keithley Low Level Measurements Handbook](https://www.tek.com/en/documents/product-article/keithley-low-level-measurements-handbook---7th-edition). In this documentation, "Ultra Low Resistance Measurements" is used as the general scientific term, while "Delta Mode" may appear when specifically referencing the Keithley-specific method or program files.
146
148
@@ -166,6 +168,8 @@ A screencast demonstrating the high resistance IV module is available at [this l
166
168
167
169
## Pre-requisites: The VISA Driver
168
170
171
+
172
+
169
173
> [!WARNING]
170
174
> **A VISA Backend is Required:**[`PyVISA`](https://github.com/pyvisa/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.
171
175
>
@@ -241,6 +245,8 @@ PICA is structured as a standard Python package. The following instructions are
241
245
**Supported Platform:** Windows 10 / 11
242
246
**Architecture:** x86_64
243
247
248
+
249
+
244
250
> [!IMPORTANT]
245
251
> **Windows Only**
246
252
> PICA is currently designed and validated exclusively for Windows environments.
@@ -270,6 +276,8 @@ Upon launching PICA (`pica-gui`), select your desired measurement module from th
270
276
271
277
### Experimental Linux Instructions
272
278
279
+
280
+
273
281
> [!WARNING]
274
282
> **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.
Copy file name to clipboardExpand all lines: docs/User_Manual.md
+17-2Lines changed: 17 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,6 +82,8 @@ This approach, however, leads to a considerable degree of code repetition becaus
82
82
**Supported Platform:** Windows 10 / 11
83
83
**Architecture:** x86_64
84
84
85
+
86
+
85
87
> [!IMPORTANT]
86
88
> **Windows Only**
87
89
> PICA is currently designed and validated exclusively for Windows environments.
@@ -92,6 +94,8 @@ This approach, however, leads to a considerable degree of code repetition becaus
92
94
1.**Python 3.10+**: The core execution environment.
93
95
2.**Dependencies:** Install via `pip install -r requirements.txt`.
94
96
97
+
98
+
95
99
> [!WARNING]
96
100
> **A VISA Backend is Required:**[`PyVISA`](https://github.com/pyvisa/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.
97
101
>
@@ -153,9 +157,13 @@ PICA is structured as a standard Python package. The following instructions are
153
157
```bash
154
158
pica-cli
155
159
```
160
+
161
+
156
162
> [!IMPORTANT]
157
163
> **Template Scripts:** The instrument control modules (CLI's) provided are designed as **template scripts**. Users are expected to modify these scripts programmatically to adapt them to their specific experimental requirements and custom workflows. They are also excellent for developing **custom measurement protocols, sequences, and for learning instrument automation**. These scripts are typically named with an 'Instrument_Control' suffix to denote their programmatic nature. This approach ensures maximum flexibility and customization for advanced research applications.
158
164
165
+
166
+
159
167
> [!NOTE]
160
168
>**Legacy CLI Notice:** The PICA CLI (`pica-cli`) is retained to support legacy headless workflows. While fully functional forspecific protocols, this interface is **less frequently maintained** and may not support recent features availablein the GUI.
>**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.
184
194
@@ -198,6 +208,8 @@ For users who wish to experiment with PICA on Linux, please be aware of the foll
198
208
199
209
## 4. Safety Precautions
200
210
211
+
212
+
201
213
> [!WARNING]
202
214
>**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.
203
215
@@ -272,9 +284,10 @@ impedance analyzer enables the characterization of capacitance anomalies over th
272
284
273
285
***Scientific Objective:** Ideal forsuperconductors, metallic films, and low-impedance devices. It actively cancels thermal offsets (Seebeck EMFs) generatedin leads and contacts.
274
286
***Principle:** Uses the **AC Delta Method**.
287
+
288
+
275
289
> [!NOTE]
276
-
>**Understanding "Delta Mode":** The term "Delta Mode" refers specifically to a technique used by Keithley Models 6220 and 6221 Current Sources in conjunction with the Model 2182/2182A Nanovoltmeter forvery low resistance measurements. This method is describedin detail in the [Keithley Low Level Measurements Handbook](https://www.tek.com/en/documents/product-article/keithley-low-level-measurements-handbook---7th-edition). In this documentation, "Ultra Low Resistance Measurements" is used as the general scientific term, while"Delta Mode" may appear when specifically referencing the Keithley-specific method or program files.
277
-
1. Source +I, measure V1.
290
+
>**Understanding "Delta Mode":** The term "Delta Mode" refers specifically to a technique used by Keithley Models 6220 and 6221 Current Sources in conjunction with the Model 2182/2182A Nanovoltmeter forvery low resistance measurements. This method is describedin detail in the [Keithley Low Level Measurements Handbook](https://www.tek.com/en/documents/product-article/keithley-low-level-measurements-handbook---7th-edition). In this documentation, "Ultra Low Resistance Measurements" is used as the general scientific term, while"Delta Mode" may appear when specifically referencing the Keithley-specific method or program files. 1. Source +I, measure V1.
278
291
2. Source -I, measure V2.
279
292
3. Compute V\_corr = (V1 - V2) / 2.
280
293
The software synchronizes the source and voltmeter via a **hardware trigger link (RS-232)**for microsecond-level timing.
@@ -577,6 +590,8 @@ This project is licensed under the MIT License - see the [LICENSE](https://githu
577
590
578
591
For developers and advanced users, the following reference outlines the PICA directory structure (v1.0.0).
579
592
593
+
594
+
580
595
> [!NOTE]
581
596
> Adding a new module to the main launcher into the GUI requires modifying `pica/main.py`.
0 commit comments