Skip to content

Commit 1ae6b04

Browse files
TOC fixed
1 parent 08b212b commit 1ae6b04

1 file changed

Lines changed: 38 additions & 39 deletions

File tree

docs/User_Manual.md

Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,26 @@
1212
1. [Overview](#1-overview)
1313
2. [Design Philosophy & Architecture](#2-design-philosophy--architecture)
1414
3. [Installation & Setup](#3-installation--setup)
15-
4. [Core Utilities](#4-core-utilities)
16-
5. [Supported Measurement Modules](#5-supported-measurement-modules)
17-
* [Ultra Low Resistance Measurements](#51-ultra-low-resistance-measurements)
18-
* [General Transport (Standard I-V & R-T)](#52-general-transport-standard-i-v--r-t)
19-
* [High Precision Transport](#53-high-precision-transport)
20-
* [Electrometry & High Resistance](#54-electrometry--high-resistance)
21-
* [Pyroelectric Measurements](#55-pyroelectric-measurements)
22-
* [High Voltage Poling](#56-high-voltage-poling)
23-
* [Capacitance Spectroscopy](#57-capacitance-spectroscopy)
24-
* [Standalone Temperature Utilities](#58-standalone-temperature-utilities)
25-
6. [Releases and Versions](#6-releases-and-versions)
26-
7. [Common Issues & Troubleshooting](#7-common-issues--troubleshooting)
27-
8. [Technical Reference](#8-technical-reference)
28-
9. [Citation & Funding](#9-citation--funding)
29-
10. [Future Development](#10-future-development)
30-
11. [Adding a New Instrument](#11-adding-a-new-instrument)
31-
12. [Authors & Acknowledgments](#12-authors--acknowledgments)
32-
13. [License](#13-license)
33-
14. [Appendix A: Project File Structure](#14-appendix-a-project-file-structure)
15+
4. [Safety Precautions](#4-safety-precautions)
16+
5. [Core Utilities](#5-core-utilities)
17+
6. [Supported Measurement Modules](#6-supported-measurement-modules)
18+
* [Ultra Low Resistance Measurements](#61-ultra-low-resistance-measurements)
19+
* [General Transport (Standard I-V & R-T)](#62-general-transport-standard-i-v--r-t)
20+
* [High Precision Transport](#63-high-precision-transport)
21+
* [Electrometry & High Resistance](#64-electrometry--high-resistance)
22+
* [Pyroelectric Measurements](#65-pyroelectric-measurements)
23+
* [High Voltage Poling](#66-high-voltage-poling)
24+
* [Capacitance Spectroscopy](#67-capacitance-spectroscopy)
25+
* [Standalone Temperature Utilities](#68-standalone-temperature-utilities)
26+
7. [Releases and Versions](#7-releases-and-versions)
27+
8. [Common Issues & Troubleshooting](#8-common-issues--troubleshooting)
28+
9. [Technical Reference](#9-technical-reference)
29+
10. [Citation & Open Source](#10-citation--open-source)
30+
11. [Future Development](#11-future-development)
31+
12. [Adding a New Instrument](#12-adding-a-new-instrument)
32+
13. [Authors & Acknowledgments](#13-authors--acknowledgments)
33+
14. [License](#14-license)
34+
15. [Appendix A: Project File Structure](#15-appendix-a-project-file-structure)
3435

3536
<hr />
3637

@@ -201,7 +202,7 @@ The control window also contains a console located below the parameter settings.
201202
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.
202203
203204
204-
## Supported Hardware Modules
205+
## 6. Supported Measurement Modules
205206
206207
The system is currently validated with industry-standard hardware, covering a resistance range spanning 24 orders of magnitude, 10<sup>-15</sup> resolution pyroelectric current measurements, and capacitance characterisation from 20 Hz - 2 MHz.
207208
@@ -216,13 +217,11 @@ The system is currently validated with industry-standard hardware, covering a re
216217
217218
*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.*
218219
219-
## 6. Supported Measurement Modules
220-
221220
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 nΩ to 10 PΩ) depending on the hardware used.
222221
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<sup>-15</sup> A. The
223222
impedance analyzer enables the characterization of capacitance anomalies over the frequency range from 20 Hz to 2 MHz and is utilized for magnetocapacitance and photoinduced characterization across a wide variety of multiferroic systems.
224223
225-
### 5.1 Ultra Low Resistance Measurements
224+
### 6.1 Ultra Low Resistance Measurements
226225
227226
**Target Hardware:** Keithley 6221 (Current Source) + K2182 (Nanovoltmeter).
228227
**Typical Range:** 10 nΩ to 100 MΩ.
@@ -254,7 +253,7 @@ impedance analyzer enables the characterization of capacitance anomalies over th
254253
<em>Ultra Low Resistance Measurement R-T measurement in sensing mode, where the system logs resistance and temperature while an external system manages temperature.</em>
255254
</p>
256255
257-
### 5.2 General Transport (Standard I-V & R-T)
256+
### 6.2 General Transport (Standard I-V & R-T)
258257
259258
**Target Hardware:** Keithley 2400 SourceMeter (SMU).
260259
**Typical Range:** 100 µΩ to 200 MΩ.
@@ -280,7 +279,7 @@ impedance analyzer enables the characterization of capacitance anomalies over th
280279
<em>Resistance-Temperature (R-T) measurement in sensing mode, where the system logs resistance and temperature while an external system/controller manages temperature.</em>
281280
</p>
282281
283-
### 5.3 High Precision Transport (mid resistance range)
282+
### 6.3 High Precision Transport (mid resistance range)
284283
285284
**Target Hardware:** Keithley 2400 (Source) + K2182 (Nanovoltmeter).
286285
**Typical Range:** 1 µΩ to 100 MΩ.
@@ -304,7 +303,7 @@ impedance analyzer enables the characterization of capacitance anomalies over th
304303
<em>High-precision R-T measurement in sensing mode, leveraging the K2400 and K2182 for enhanced accuracy for mid-range resistance measurements.</em>
305304
</p>
306305
307-
### 5.4 Electrometry & High Resistance
306+
### 6.4 Electrometry & High Resistance
308307
309308
**Target Hardware:** Keithley 6517B Electrometer (or compatible High-R meter).
310309
**Typical Range:** 1 Ω to 10 PΩ (10<sup>16</sup> Ω).
@@ -331,7 +330,7 @@ A screencast demonstrating the high resistance IV module is available at [this l
331330
<em>High-resistance R-T measurement in passive sensing mode using a Keithley 6517B.</em>
332331
</p>
333332
334-
### 5.5 Pyroelectric Current Measurements
333+
### 6.5 Pyroelectric Current Measurements
335334
336335
**Target Hardware:** Keithley 6517B Electrometer + Temperature Controller.
337336
**Sensitivity:** Down to 1 fA (10<sup>-15</sup> A).
@@ -350,7 +349,7 @@ This module automates the measurement of pyroelectric currents (Ip) as a functio
350349
<em>Pyroelectric current measurement as a function of temperature, captured with a Keithley 6517B to identify ferroelectric phase transitions via measuring pyroelectric current.</em>
351350
</p>
352351
353-
### 5.6 High Voltage Poling
352+
### 6.6 High Voltage Poling
354353
355354
**Target Hardware:** Keithley 6517B (Voltage Source).
356355
**Capabilities:** High Voltage Sourcing.
@@ -360,7 +359,7 @@ This utility provides a dedicated interface for **In-situ and ex-situ electrical
360359
* **Objective:** Establish a uniform ferroelectric polarization state in samples before characterization.
361360
* **Applications:** Preparing samples for pyroelectric current measurements, converse magnetoelectric studies, and ex-situ neutron diffraction studies on poled materials.
362361
363-
### 5.7 Dielectric Spectroscopy
362+
### 6.7 Dielectric Spectroscopy
364363
365364
**Target Hardware:** Keysight E4980A Precision LCR Meter.
366365
**Frequency Range:** 20 Hz to 2 MHz
@@ -376,7 +375,7 @@ This utility provides a dedicated interface for **In-situ and ex-situ electrical
376375
<em>Capacitance-Voltage (C-V) characterization of a device or a sample using a Keysight E4980A LCR meter.</em>
377376
</p>
378377
379-
### 5.8 Standalone Temperature Utilities
378+
### 6.8 Standalone Temperature Utilities
380379
381380
**Target Hardware:** Lake Shore 350 Temperature Controller.
382381
@@ -396,11 +395,11 @@ PICA also includes standalone utilities for monitoring and controlling temperatu
396395
<em>The standalone Temperature Control utility, providing a dedicated interface for managing temperature ramps and heater outputs on a Lakeshore 350.</em>
397396
</p>
398397
399-
## 6. Releases and Versions
398+
## 7. Releases and Versions
400399
401400
go through [releases](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/releases) and [tags](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/tags), for the finalised released versions
402401
403-
## 7. Common Issues & Troubleshooting
402+
## 8. Common Issues & Troubleshooting
404403
405404
This section covers the most common issues encountered when using PICA.
406405
@@ -425,7 +424,7 @@ This is the most frequent issue and usually indicates a problem with the connect
425424
### 7.2 Instrument Control and Delays
426425
An important parameter to consider during concurrent control of instruments is the delay. The time between each step should be sufficient to ensure that all instruments (whether two or three) have completed their commanded actions. Sending a new command before an instrument has had time to process the previous one will definitely cause errors. It is also important to introduce proper delays for the system to reach equilibrium. Furthermore, during the initial setup, instruments should be given adequate delay time for all their internal components to stabilize and enter a ready state. In PICA, sufficient internal delays are provided in all modules. However, it was observed that some systems might need more delay time. Therefore, a parameter for initial delay is available in those modules' GUI. Users should provide an appropriate initial delay time. This initial delay time parameter is in addition to the basic delay already contained in the module.
427426
428-
## 8. Technical Reference
427+
## 9. Technical Reference
429428
430429
### 8.1 File Naming Convention
431430
@@ -464,7 +463,7 @@ Set Current (A),Measured Voltage (V),Resistance (Ohm)
464463
```
465464
Most other data files generated by PICA follow a similar structure.
466465
467-
## 9. Citation & Open source
466+
## 10. Citation & Open Source
468467
469468
**Collaborative Ecosystem:**
470469
PICA is open-source ([MIT License](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/blob/main/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.
@@ -482,7 +481,7 @@ PICA is open-source ([MIT License](https://github.com/prathameshnium/PICA-Python
482481
}
483482
```
484483
485-
## 10. Future Development
484+
## 11. Future Development
486485
487486
### 10.1 AC Resistivity (Lock-In)
488487
@@ -502,12 +501,12 @@ In the future, We also plan to develop executable (`.exe`) versions of the PICA
502501
We plan to add more utility modules, such as a PID simulator for temperature controller PID values calibration and various simple data analysis modules. These additions will help to streamline the entire process from measurement to analysis, making PICA a more self-contained ecosystem.
503502
504503
505-
## 11. Adding a New Instrument
504+
## 12. Adding a New Instrument
506505
507506
The procedure for adding a new instrument module to PICA is described in the [CONTRIBUTING.md](../CONTRIBUTING.md#adding-a-new-instrument-module) file. Please refer to that guide for detailed, step-by-step instructions.
508507
509508
510-
## 12. Authors & Acknowledgments
509+
## 13. Authors & Acknowledgments
511510
<p align="center">
512511
<img src="../pica/assets/LOGO/UGC_DAE_CSR_NBG.jpeg" alt="UGC DAE CSR Logo" width="150">
513512
</p>
@@ -519,10 +518,10 @@ The procedure for adding a new instrument module to PICA is described in the [CO
519518
### Funding
520519
Financial support for this work was provided under SERB-CRG project grant No. CRG/2022/005676 from the Anusandhan National Research Foundation (ANRF).
521520
522-
## 13. License
521+
## 14. License
523522
524523
This project is licensed under the MIT License - see the [LICENSE](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/blob/main/LICENSE) file for details.
525-
## 14. Appendix A: Project File Structure
524+
## 15. Appendix A: Project File Structure
526525
527526
For developers and advanced users, the following reference outlines the PICA directory structure (v1.0.0).
528527

0 commit comments

Comments
 (0)