Skip to content

Commit 56a9db1

Browse files
um corrections
1 parent df0a240 commit 56a9db1

1 file changed

Lines changed: 22 additions & 14 deletions

File tree

docs/User_Manual.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
1+
<p align="center">
12
# PICA User Manual
3+
</p>
4+
5+
**Manual Version:** 1.0.0
6+
**Last Updated:** December 16, 2025
27

38
<p align="center">
49
<img src="../pica/assets/LOGO/PICA_LOGO_NBG.png" alt="PICA Logo" width="250">
510
</p>
611

7-
12+
<p align="center">
813
**Python-based Instrument Control and Automation Software Suite**
9-
14+
</p>
15+
<p align="center">
1016
*Comprehensive Guide for Version 1.0.0*
17+
</p>
1118

1219
<hr />
1320

@@ -83,7 +90,7 @@ This approach, however, leads to a considerable degree of code repetition becaus
8390
>
8491
> Choose one of the following:
8592
> - **NI-VISA:** The industry standard from National Instruments. Download and install it from the [NI website](https://www.ni.com/en/support/downloads/drivers/download.ni-visa.html#575764).
86-
> - **PyVISA-py:** A backend written in pure Python. Install it using `pip install pyvisa-py`. To enhance `pyvisa-py`'s capabilities and avoid warnings related to resource discovery (e.g., for TCPIP or HiSLIP instruments), it is highly recommended to also install `psutil` and `zeroconf`: `pip install psutil zeroconf`. It can be used as a fallback but may have limitations compared to vendor-specific drivers like NI-VISA. Note that for direct GPIB communication via `pyvisa-py`, a separate GPIB library (e.g., from your GPIB adapter vendor) might still be required.
93+
> - **PyVISA-py:** A backend written in pure Python. It can be used as a fallback but may have limitations compared to vendor-specific drivers like NI-VISA. For `pyvisa-py` to discover all resources and avoid warnings (e.g., for TCPIP or HiSLIP instruments), `psutil` and `zeroconf` might be needed. These packages are already included in PICA's dependencies (`requirements.txt`). Note that for direct GPIB communication via `pyvisa-py`, a separate GPIB library (e.g., from your GPIB adapter vendor) might still be required.
8794
>
8895
> **Before proceeding, verify your VISA installation.** For more details and troubleshooting, refer to the "[Common Issues & Troubleshooting](#6-common-issues--troubleshooting)" section.
8996
@@ -151,7 +158,7 @@ python -B -m pytest --cov=pica --cov-report=term-missing -p no:cacheprovider
151158

152159
*File Reference: `pica/utils/GPIB_Instrument_Scanner_GUI.py`*
153160

154-
Automatically launched upon startup (and accessible within modules), this utility scans for connected hardware. It uses `ResourceManager.list_resources()` to find devices and sends a standard `*IDN?` query to verify communication. This allows users to verify their hardware configuration before starting any experiment.
161+
Automatically launched upon startup (and accessible within modules), this utility scans for connected hardware. It uses `ResourceManager.list_resources()` to find devices and sends a standard `*IDN?` query to verify communication. This allows users to verify their hardware configuration before starting any experiment. The VISA scanner also includes an address guide, which can be edited by the user for quick reference.
155162
156163
In the main PICA launcher, the VISA/GPIB scanner is configured to execute automatically at application startup. This design choice is motivated by the fact that initiating a measurement without first verifying the instrument connection is highly likely to fail and may result in non-informative error messages, such as a VISA connection timeout.
157164
@@ -179,7 +186,7 @@ A standalone, multiprocessing-enabled tool for detailed data analysis. Unlike th
179186
180187
### 5.3 Embedded Document Viewer
181188
182-
To ensure the software is self-contained (useful for offline lab computers), PICA includes an in-app viewer for project documentation, including this User Manual, the License, and the Changelog.
189+
To ensure the software is self-contained (useful for offline lab computers), PICA includes an in-app viewer for project documentation, including this User Manual, the Instrument Manuals List, the License, and the Changelog.
183190
184191
### 5.4 Measurement Module Interface
185192
@@ -191,7 +198,9 @@ Above the plot area, there are two buttons providing access to the [VISA Instrum
191198
192199
## 6. Supported Measurement Modules
193200
194-
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.
201+
PICA is designed to be as versatile, 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.
202+
Pyroelectric measurement performed using an electrometer enables highly sensitive characterization of ferroelectric phase transitions by detecting extremely small pyroelectric currents, with a resolution on the order of 10−15 A. A.The
203+
impedance analyzer enables the characterization of dielectric anomalies over the frequency range from 20 Hz to 2 MHz and is utilized for magnetodielectric and photoinduced characterization across a wide variety of multiferroic systems.
195204
196205
### 5.1 Low Resistance (Delta Mode)
197206
@@ -213,7 +222,7 @@ PICA is designed to be as versatile as possible, while being optimized for speci
213222
214223
### 5.2 General Transport (Standard I-V & R-T)
215224
216-
**Target Hardware:** Keithley 2400 SourceMeter (or compatible SMU).
225+
**Target Hardware:** Keithley 2400 SourceMeter (SMU).
217226
**Typical Range:** 100 µOhm to 200 MOhm.
218227
219228
* **Scientific Objective:** General transport characterization for semiconductors, oxides, and devices.
@@ -237,7 +246,7 @@ PICA is designed to be as versatile as possible, while being optimized for speci
237246
<em>Resistance-Temperature (R-T) measurement in sensing mode, where the system logs resistance and temprature while an external system/controller manages temperature.</em>
238247
</p>
239248
240-
### 5.3 High Precision Transport
249+
### 5.3 High Precision Transport (mid resistance range)
241250
242251
**Target Hardware:** Keithley 2400 (Source) + K2182 (Nanovoltmeter).
243252
**Typical Range:** 1 µOhm to 100 MOhm.
@@ -326,19 +335,18 @@ This utility provides a dedicated interface for **In-situ and ex-situ electrical
326335
327336
328337
<p align="center">
329-
330-
<img src="../pica/assets/Images/screenshots/Keysight_CV.png" alt="Keysight CV" width="600">
331-
<br>
332-
<em>Capacitance-Voltage (C-V) characterization of a device or a sample using a Keysight E4980A LCR meter.</em>
333-
</p>
338+
<img src="../pica/assets/Images/screenshots/Keysight_CV.png" alt="Keysight CV" width="600">
339+
<br>
340+
<em>Capacitance-Voltage (C-V) characterization of a device or a sample using a Keysight E4980A LCR meter.</em>
341+
</p>
334342
335343
### 5.8 Standalone Temperature Utilities
336344
337345
**Target Hardware:** Lake Shore 350 Temperature Controller.
338346
339347
PICA also includes standalone utilities for monitoring and controlling temperature, independent of other measurement modules.
340348
341-
* **Temperature Monitor:** A simple interface for logging temperature from multiple sensors.
349+
* **Temperature Monitor:** A simple interface for logging temperature from multiple types of sensors.
342350
* **Temperature Control:** A dedicated module for setting temperature ramps, controlling heater outputs, and managing control loops.
343351
344352
<p align="center">

0 commit comments

Comments
 (0)