Skip to content

Commit 4d058cb

Browse files
note warning formatting tried fixing
1 parent 36edc80 commit 4d058cb

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

README.md

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

142142
*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.*
143143

144+
145+
144146
> [!NOTE]
145147
> **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.
146148
@@ -166,6 +168,8 @@ A screencast demonstrating the high resistance IV module is available at [this l
166168

167169
## Pre-requisites: The VISA Driver
168170

171+
172+
169173
> [!WARNING]
170174
> **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.
171175
>
@@ -241,6 +245,8 @@ PICA is structured as a standard Python package. The following instructions are
241245
**Supported Platform:** Windows 10 / 11
242246
**Architecture:** x86_64
243247
248+
249+
244250
> [!IMPORTANT]
245251
> **Windows Only**
246252
> 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
270276
271277
### Experimental Linux Instructions
272278
279+
280+
273281
> [!WARNING]
274282
> **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.
275283

docs/User_Manual.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ This approach, however, leads to a considerable degree of code repetition becaus
8282
**Supported Platform:** Windows 10 / 11
8383
**Architecture:** x86_64
8484

85+
86+
8587
> [!IMPORTANT]
8688
> **Windows Only**
8789
> 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
9294
1. **Python 3.10+**: The core execution environment.
9395
2. **Dependencies:** Install via `pip install -r requirements.txt`.
9496

97+
98+
9599
> [!WARNING]
96100
> **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.
97101
>
@@ -153,9 +157,13 @@ PICA is structured as a standard Python package. The following instructions are
153157
```bash
154158
pica-cli
155159
```
160+
161+
156162
> [!IMPORTANT]
157163
> **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.
158164

165+
166+
159167
> [!NOTE]
160168
> **Legacy CLI Notice:** The PICA CLI (`pica-cli`) is retained to support legacy headless workflows. While fully functional for specific protocols, this interface is **less frequently maintained** and may not support recent features available in the GUI.
161169
>
@@ -179,6 +187,8 @@ python -B -m pytest --cov=pica --cov-report=term-missing -p no:cacheprovider
179187

180188
#### Experimental Linux Instructions
181189

190+
191+
182192
> [!WARNING]
183193
> **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.
184194

@@ -198,6 +208,8 @@ For users who wish to experiment with PICA on Linux, please be aware of the foll
198208

199209
## 4. Safety Precautions
200210

211+
212+
201213
> [!WARNING]
202214
> **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.
203215

@@ -272,9 +284,10 @@ impedance analyzer enables the characterization of capacitance anomalies over th
272284
273285
* **Scientific Objective:** Ideal for superconductors, metallic films, and low-impedance devices. It actively cancels thermal offsets (Seebeck EMFs) generated in leads and contacts.
274286
* **Principle:** Uses the **AC Delta Method**.
287+
288+
275289
> [!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 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.
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 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. 1. Source +I, measure V1.
278291
2. Source -I, measure V2.
279292
3. Compute V\_corr = (V1 - V2) / 2.
280293
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
577590
578591
For developers and advanced users, the following reference outlines the PICA directory structure (v1.0.0).
579592
593+
594+
580595
> [!NOTE]
581596
> Adding a new module to the main launcher into the GUI requires modifying `pica/main.py`.
582597

0 commit comments

Comments
 (0)