Skip to content

Commit 31172c8

Browse files
release section added
1 parent 3ceecce commit 31172c8

3 files changed

Lines changed: 29 additions & 20 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
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
12
## Instrument & Software Update Log
23
---
34
### [1.0.0] - 2025-12-15 (Initial Public Release)
@@ -186,5 +187,4 @@
186187
- **June 09, 2022:** **Environment Setup & Skill Acquisition.** Due to the air-gapped nature of the laboratory computers, the initial Python environment was established by manually downloading dependencies (PyVISA, NumPy, Matplotlib) and installing them offline. This phase involved guided learning of instrument control concepts (e.g., "Python in Origin", SCPI basics) alongside specific training provided by the PI.
187188

188189
- **Collaboration Note:** The project's realization was significantly aided by colleagues (from UGC-DAE CSR,Mumbai) who assisted in rectifying technical issues and developing the necessary cryogenic probes and hardware fixtures required for measurements.
189-
- **June 2022:** **Project Ideation.** Dr. Sudip Mukherjee (Principal Investigator) proposed the initiative for laboratory automation from manual methods to Python-based control. He provided critical roadmap materials, including reference videos, instrument handling protocols, and conceptual designs for the GUI layouts and hardware integration.
190-
190+
- **June 2022:** **Project Ideation.** Dr. Sudip Mukherjee (Principal Investigator) proposed the initiative for laboratory automation from manual methods to Python-based control. He provided critical roadmap materials, including reference videos, instrument handling protocols, and conceptual designs for the GUI layouts and hardware integration.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,8 @@ python -B -m pytest --cov=pica --cov-report=term-missing -p no:cacheprovider
262262

263263
## Project History
264264

265+
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
266+
265267
PICA evolved from simple offline scripts in 2022 to a full-stack automated suite.
266268

267269
* **v1.0.0 (Initial Public Release):** Version numbering has been reset from legacy development builds (v17.0) to v1.0.0 to standardize the package for public distribution and citation.

docs/User_Manual.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,14 @@
2222
* [High Voltage Poling](#56-high-voltage-poling)
2323
* [Capacitance Spectroscopy](#57-capacitance-spectroscopy)
2424
* [Standalone Temperature Utilities](#58-standalone-temperature-utilities)
25-
6. [Common Issues & Troubleshooting](#6-common-issues--troubleshooting)
26-
7. [Technical Reference](#7-technical-reference)
27-
8. [Citation & Funding](#8-citation--funding)
28-
9. [Future Development](#9-future-development)
29-
10. [Appendix A: Project File Structure](#10-appendix-a-project-file-structure)
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. [Authors & Acknowledgments](#11-authors--acknowledgments)
31+
12. [License](#12-license)
32+
13. [Appendix A: Project File Structure](#13-appendix-a-project-file-structure)
3033

3134
<hr />
3235

@@ -389,11 +392,15 @@ PICA also includes standalone utilities for monitoring and controlling temperatu
389392
<em>The standalone Temperature Control utility, providing a dedicated interface for managing temperature ramps and heater outputs on a Lakeshore 350.</em>
390393
</p>
391394
392-
## 6. Common Issues & Troubleshooting
395+
## 6. Releases and Versions
396+
397+
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
398+
399+
## 7. Common Issues & Troubleshooting
393400
394401
This section covers the most common issues encountered when using PICA.
395402
396-
### 6.1 VISA Timeout Error or Resource Not Found
403+
### 7.1 VISA Timeout Error or Resource Not Found
397404
398405
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:
399406
@@ -411,15 +418,15 @@ This is the most frequent issue and usually indicates a problem with the connect
411418
* Ensure you have the correct VISA backend installed (see the `A VISA Backend is Required` warning in the [Installation & Setup](#3-installation--setup) section).
412419
* 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.
413420
414-
## 7. Technical Reference
421+
## 8. Technical Reference
415422
416-
### 7.1 File Naming Convention
423+
### 8.1 File Naming Convention
417424
418425
To ensure data integrity and easy sorting, PICA automatically generates filenames using a standardized format. This allows for easier parsing by external analysis tools.
419426
Format: `[SampleName]_[Timestamp]_[Identifier].dat`
420427
Example: `SampleA_2025-12-04_1430_IV_Sweep.dat`
421428
422-
### 7.2 GPIB Address Guide
429+
### 8.2 GPIB Address Guide
423430
424431
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.
425432
@@ -430,11 +437,11 @@ PICA uses standard VISA resource strings. While the defaults below are common, u
430437
* **Keithley 6517B:** `GPIB1::27::INSTR`
431438
* **Keysight E4980A:** `GPIB0::17::INSTR`
432439
433-
### 7.3 Repository Mirroring
440+
### 8.3 Repository Mirroring
434441
435442
This project is manually backed up weekly to a [GitLab repository](https://gitlab.com/prathameshnium/pica-python-instrument-control-and-automation).
436443
437-
## 8. Citation & Open source
444+
## 9. Citation & Open source
438445
439446
**Collaborative Ecosystem:**
440447
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.
@@ -452,9 +459,9 @@ PICA is open-source ([MIT License](https://github.com/prathameshnium/PICA-Python
452459
}
453460
```
454461
455-
## 9. Future Development
462+
## 10. Future Development
456463
457-
### 9.1 AC Resistivity (Lock-In)
464+
### 10.1 AC Resistivity (Lock-In)
458465
459466
*Status: Under Development*
460467
@@ -464,12 +471,12 @@ PICA is open-source ([MIT License](https://github.com/prathameshnium/PICA-Python
464471
* **Use Case:** Useful for distinguishing between different conduction mechanisms by analyzing the frequency response of the sample's resistance.
465472
* **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 accurate ac resistivity measurements.
466473
467-
### 9.2 Standalone Executables
474+
### 10.2 Standalone Executables
468475
469476
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.
470477
471478
472-
## 10. Authors & Acknowledgments
479+
## 11. Authors & Acknowledgments
473480
<p align="center">
474481
<img src="../pica/assets/LOGO/UGC_DAE_CSR_NBG.jpeg" alt="UGC DAE CSR Logo" width="150">
475482
</p>
@@ -481,10 +488,10 @@ In the future, We also plan to develop executable (`.exe`) versions of the PICA
481488
### Funding
482489
Financial support for this work was provided under SERB-CRG project grant No. CRG/2022/005676 from the Anusandhan National Research Foundation (ANRF).
483490
484-
## 11. License
491+
## 12. License
485492
486493
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.
487-
## 12. Appendix A: Project File Structure
494+
## 13. Appendix A: Project File Structure
488495
489496
For developers and advanced users, the following reference outlines the PICA directory structure (v1.0.0).
490497

0 commit comments

Comments
 (0)