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: CHANGELOG.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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
1
2
## Instrument & Software Update Log
2
3
---
3
4
### [1.0.0] - 2025-12-15 (Initial Public Release)
@@ -186,5 +187,4 @@
186
187
-**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.
187
188
188
189
-**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.
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
+
265
267
PICA evolved from simple offline scripts in 2022 to a full-stack automated suite.
266
268
267
269
***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.
@@ -389,11 +392,15 @@ PICA also includes standalone utilities for monitoring and controlling temperatu
389
392
<em>The standalone Temperature Control utility, providing a dedicated interface for managing temperature ramps and heater outputs on a Lakeshore 350.</em>
390
393
</p>
391
394
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
393
400
394
401
This section covers the most common issues encountered when using PICA.
395
402
396
-
### 6.1 VISA Timeout Error or Resource Not Found
403
+
### 7.1 VISA Timeout Error or Resource Not Found
397
404
398
405
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:
399
406
@@ -411,15 +418,15 @@ This is the most frequent issue and usually indicates a problem with the connect
411
418
* Ensure you have the correct VISA backend installed (see the `A VISA Backend is Required` warning in the [Installation & Setup](#3-installation--setup) section).
412
419
* 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.
413
420
414
-
## 7. Technical Reference
421
+
## 8. Technical Reference
415
422
416
-
### 7.1 File Naming Convention
423
+
### 8.1 File Naming Convention
417
424
418
425
To ensure data integrity and easy sorting, PICA automatically generates filenames using a standardized format. This allows for easier parsing by external analysis tools.
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.
425
432
@@ -430,11 +437,11 @@ PICA uses standard VISA resource strings. While the defaults below are common, u
430
437
***Keithley 6517B:**`GPIB1::27::INSTR`
431
438
***Keysight E4980A:**`GPIB0::17::INSTR`
432
439
433
-
### 7.3 Repository Mirroring
440
+
### 8.3 Repository Mirroring
434
441
435
442
This project is manually backed up weekly to a [GitLab repository](https://gitlab.com/prathameshnium/pica-python-instrument-control-and-automation).
436
443
437
-
## 8. Citation & Open source
444
+
## 9. Citation & Open source
438
445
439
446
**Collaborative Ecosystem:**
440
447
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
452
459
}
453
460
```
454
461
455
-
## 9. Future Development
462
+
## 10. Future Development
456
463
457
-
### 9.1 AC Resistivity (Lock-In)
464
+
### 10.1 AC Resistivity (Lock-In)
458
465
459
466
*Status: Under Development*
460
467
@@ -464,12 +471,12 @@ PICA is open-source ([MIT License](https://github.com/prathameshnium/PICA-Python
464
471
***Use Case:** Useful for distinguishing between different conduction mechanisms by analyzing the frequency response of the sample's resistance.
465
472
* **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.
466
473
467
-
### 9.2 Standalone Executables
474
+
### 10.2 Standalone Executables
468
475
469
476
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.
@@ -481,10 +488,10 @@ In the future, We also plan to develop executable (`.exe`) versions of the PICA
481
488
### Funding
482
489
Financial support for this work was provided under SERB-CRG project grant No. CRG/2022/005676 from the Anusandhan National Research Foundation (ANRF).
483
490
484
-
## 11. License
491
+
## 12. License
485
492
486
493
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
488
495
489
496
For developers and advanced users, the following reference outlines the PICA directory structure (v1.0.0).
0 commit comments