Skip to content

Commit 77485a0

Browse files
Update README with new badges and v1.0.3 details
Added PyPI version and download badges, updated GUI theme description, and added new section for v1.0.3 release notes.
1 parent 18d418f commit 77485a0

1 file changed

Lines changed: 66 additions & 26 deletions

File tree

README.md

Lines changed: 66 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,16 @@
1313
<img src="https://img.shields.io/badge/Python-3.10+-brightgreen.svg?logo=python&logoColor=white&style=flat-square" alt="Python Version">
1414
<a href="https://doi.org/10.5281/zenodo.18377217"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.18377217.svg" alt="DOI"></a>
1515
<a href="https://joss.theoj.org/papers/444957f999023680f8abbbf0e75687fa"><img src="https://joss.theoj.org/papers/444957f999023680f8abbbf0e75687fa/status.svg"></a>
16+
<a href="https://pypi.org/project/pica-suite/"><img src="https://img.shields.io/pypi/v/pica-suite.svg?style=flat-square&label=PyPI&color=blue" alt="PyPI Version"></a>
17+
<a href="https://pypi.org/project/pica-suite/"><img src="https://img.shields.io/pypi/dm/pica-suite?style=flat-square&label=PyPI%20Downloads" alt="PyPI Downloads"></a>
1618
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square" alt="License: MIT"></a>
1719
<br />
20+
<a href="https://prathameshnium.github.io/PICA-Python-Instrument-Control-and-Automation/"><img src="https://img.shields.io/badge/Docs-Online%20Documentation-blue.svg?logo=readthedocs&style=flat-square" alt="Online Documentation"></a>
1821
<a href="docs/User_Manual.md"><img src="https://img.shields.io/badge/Docs-User_Manual-blue.svg?logo=markdown&style=flat-square" alt="Documentation"></a>
1922
<a href="CONTRIBUTING.md"><img src="https://img.shields.io/badge/Contributing-Guidelines-orange.svg?style=flat-square" alt="Contributing Guidelines"></a>
2023
<a href="CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Code%20of%20Conduct-Contributor%20Covenant-ff69b4.svg?style=flat-square" alt="Code of Conduct"></a>
2124
<br />
22-
<img src="https://img.shields.io/badge/Project_Inception-June%202022-orange?style=flat-square&logo=calendar" alt="Project_Inception Date">
25+
<img src="https://img.shields.io/badge/Project_Inception-June%202022-orange?style=flat-square&logo=calendar" alt="Project Inception Date">
2326
<img src="https://img.shields.io/badge/Project%20Age-3%2B%20Years-blueviolet?style=flat-square" alt="Project Age">
2427
<img src="https://img.shields.io/github/created-at/prathameshnium/PICA-Python-Instrument-Control-and-Automation?style=flat-square" alt="GitHub created-at">
2528
<img src="https://img.shields.io/github/downloads/prathameshnium/PICA-Python-Instrument-Control-and-Automation/total?style=flat-square&color=blue" alt="Total Downloads">
@@ -31,6 +34,10 @@
3134

3235
---
3336

37+
> 🎉 **v1.0.3 is now live!** The GUI has been refreshed with a new **Latte** theme — lighter, warmer, and easier on the eyes during long measurement sessions. Install or upgrade via pip: `pip install --upgrade pica-suite`
38+
39+
---
40+
3441
## Overview
3542

3643
High-precision, low-noise transport measurements are essential for advancing research in spintronics and materials characterisation. **PICA (Python-based Instrument Control and Automation)** is a modular, open-source software suite designed to automate advanced transport measurements for electronic devices and material samples. It operates as a versatile framework capable of running on any standard laboratory workstation.
@@ -46,15 +53,17 @@ The suite performs automated protocols including:
4653
<p align="center">
4754
<img src="pica/assets/Images/screenshots/00_PICA_Launcher.png" alt="PICA Launcher" width="800">
4855
<br>
49-
<em>PICA Launcher Interface for accessing all measurement modules.</em>
56+
<em>PICA Launcher Interface (v1.0.3, Latte theme) for accessing all measurement modules.</em>
5057
</p>
5158

5259
> **More details here:**
53-
> For more information, go through the [User Manual](docs/User_Manual.md).
60+
> Full online documentation is available at [https://prathameshnium.github.io/PICA-Python-Instrument-Control-and-Automation/](https://prathameshnium.github.io/PICA-Python-Instrument-Control-and-Automation/).
61+
> For usage guides, see the [User Manual](docs/User_Manual.md).
5462
5563
## Table of Contents
5664

5765
- [Overview](#overview)
66+
- [What's New in v1.0.3](#whats-new-in-v103)
5867
- [Motivation](#motivation)
5968
- [Key Features](#key-features)
6069
- [Design and Implementation](#design-and-implementation)
@@ -69,6 +78,28 @@ The suite performs automated protocols including:
6978

7079
---
7180

81+
## What's New in v1.0.3
82+
83+
**v1.0.3** is the latest release and is available on [PyPI](https://pypi.org/project/pica-suite/) and [GitHub Releases](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/releases).
84+
85+
```bash
86+
pip install pica-suite==1.0.3
87+
# or upgrade from a previous version:
88+
pip install --upgrade pica-suite
89+
```
90+
91+
### 🎨 Latte GUI Theme
92+
The GUI has been redesigned with a **Latte** theme — a lighter, warmer colour palette that replaces the previous darker interface. This makes PICA more comfortable for extended lab sessions and improves readability under typical laboratory lighting conditions.
93+
94+
Key visual changes:
95+
* Lighter background and widget colours throughout all measurement modules.
96+
* Improved contrast for console log text.
97+
* Softer colour scheme for real-time plot backgrounds.
98+
99+
For the full changelog, see [`CHANGELOG.md`](CHANGELOG.md).
100+
101+
---
102+
72103
## Motivation
73104

74105
Advancements in experimental physics and device manufacturing depend on the precise characterisation of material properties under extreme physical conditions. Researchers often face a binary choice: purchase expensive proprietary software or develop custom measurement scripts from scratch.
@@ -79,7 +110,7 @@ PICA enables continuous operation across a full range of measurements, from ultr
79110

80111
## Key Features
81112

82-
* **Accessibility:** A professional GUI dashboard allows researchers without coding experience to configure and run complex measurement protocols immediately using pre-packaged measurement modules.
113+
* **Accessibility:** A professional GUI dashboard (now with the Latte theme) allows researchers without coding experience to configure and run complex measurement protocols immediately using pre-packaged measurement modules.
83114
* **Operational Validation:** Validated via cryogenic transport measurements using a custom-designed probe in conjunction with a **Physical Property Measurement System (PPMS)** (5-380 K, up to 14 Tesla) at the [UGC DAE Consortium for Scientific Research, Mumbai Centre](https://www.csr.res.in/Mumbai_Centre).
84115
* **Fault Tolerance:** Control logic is isolated from the user interface. Hardware timeouts or driver crashes are prevented from freezing the main dashboard.
85116
* **Modular CLI Architecture:** Measurement modules contain CLI counterparts, allowing researchers to utilize PICA's protocol logic for headless automation or integration into other workflows without GUI overhead.
@@ -124,8 +155,6 @@ The system is currently validated with industry-standard hardware, covering a re
124155

125156
*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.*
126157

127-
128-
129158
> [!NOTE]
130159
> **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.
131160
@@ -139,7 +168,8 @@ The system is currently validated with industry-standard hardware, covering a re
139168
<p align="center">
140169
<img src="pica/assets/Images/screenshots/K6517B_IV.png" alt="K6517B IV" width="600">
141170
<br>
142-
<em>Interface for current-voltage (I-V) characterisation of high-impedance materials using the Keithley 6517B Electrometer.</p>
171+
<em>Interface for current-voltage (I-V) characterisation of high-impedance materials using the Keithley 6517B Electrometer.</em>
172+
</p>
143173

144174
---
145175

@@ -151,8 +181,6 @@ The system is currently validated with industry-standard hardware, covering a re
151181

152182
## Pre-requisites: The VISA Driver
153183

154-
155-
156184
> [!WARNING]
157185
> **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.
158186
>
@@ -162,11 +190,25 @@ The system is currently validated with industry-standard hardware, covering a re
162190
>
163191
> **Before proceeding, verify your VISA installation.**
164192
165-
---
193+
---
166194

167195
## Getting Started
168196

169-
PICA is structured as a standard Python package. The following instructions are for the supported Windows platform.
197+
PICA is available on [PyPI](https://pypi.org/project/pica-suite/) and structured as a standard Python package. The following instructions are for the supported Windows platform.
198+
199+
### Option 1: Install from PyPI (Recommended)
200+
201+
```bash
202+
pip install pica-suite
203+
```
204+
205+
To upgrade to the latest version (currently **v1.0.3**):
206+
207+
```bash
208+
pip install --upgrade pica-suite
209+
```
210+
211+
### Option 2: Install from Source
170212

171213
1. **Clone the Repository**
172214
```bash
@@ -179,7 +221,7 @@ PICA is structured as a standard Python package. The following instructions are
179221
# Create and activate a virtual environment
180222
python -m venv venv
181223
venv\Scripts\activate
182-
224+
183225
# Install the package and its dependencies
184226
pip install .
185227
```
@@ -215,21 +257,20 @@ PICA is structured as a standard Python package. The following instructions are
215257
```bash
216258
pica-cli
217259
```
218-
260+
219261
> [!IMPORTANT]
220262
> **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.
221-
263+
222264
> [!NOTE]
223-
> **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.
265+
> **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.
224266
>
225267
> We **strongly recommend** new users utilize the PICA GUI for the most complete and supported experience.
268+
226269
## System Requirements & Compatibility
227270
228271
**Supported Platform:** Windows 10 / 11
229272
**Architecture:** x86_64
230273
231-
232-
233274
> [!IMPORTANT]
234275
> **Windows Only**
235276
> PICA is currently designed and validated exclusively for Windows environments.
@@ -255,8 +296,7 @@ Upon launching PICA (`pica-gui`), select your desired measurement module from th
255296
256297
*The interface is designed to be minimalistic to reduce unnecessary user interaction during active high-precision, low-noise transport measurements.*
257298
258-
259-
299+
---
260300
261301
## Running Tests Locally
262302
@@ -279,8 +319,6 @@ python -B -m pytest --cov=pica --cov-report=term-missing -p no:cacheprovider
279319
280320
### Experimental Linux Instructions
281321
282-
283-
284322
> [!WARNING]
285323
> **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.
286324
@@ -306,7 +344,8 @@ For downloadable release builds, please visit the [releases page](https://github
306344
307345
PICA evolved from simple offline scripts in 2022 to a full-stack automated suite.
308346
309-
* **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.
347+
* **v1.0.3 (Latest):** GUI refreshed with the **Latte** theme — lighter, warmer, and less dark. Available on [PyPI](https://pypi.org/project/pica-suite/).
348+
* **v1.0.1 / v1.0.0 (Initial Public Release):** Version numbering was reset from legacy development builds (v17.0) to v1.0.0 to standardize the package for public distribution and citation.
310349
* **v17.0:** Professional directory restructuring, Semantic Versioning, and documentation overhaul.
311350
* **v15.0:** JOSS submission preparation, CI/CD integration.
312351
* **v13.0:** Transition to Multiprocessing and standardized GUI themes.
@@ -324,11 +363,13 @@ The project's earlier history and foundational development are outlined below:
324363

325364
## Resources & Documentation
326365

327-
366+
* **Online Documentation:** Full documentation site at [https://prathameshnium.github.io/PICA-Python-Instrument-Control-and-Automation/](https://prathameshnium.github.io/PICA-Python-Instrument-Control-and-Automation/).
367+
* **PyPI Package:** Install directly via [https://pypi.org/project/pica-suite/](https://pypi.org/project/pica-suite/).
328368
* **User Manual:** Details on the project and usage guides are available in the [User Manual](docs/User_Manual.md).
329369
* **Instrument Manuals:** A list of instrument manuals is available in [docs/Instruments_Manuals_Lists.md](docs/Instruments_Manuals_Lists.md).
330370
* **GitLab Backup:** This project is manually backed up weekly to a [GitLab repository](https://gitlab.com/prathameshnium/pica-python-instrument-control-and-automation).
331371
* **Project Web Page:** [https://prathameshdeshmukh.site/pages/project-pica.html](https://prathameshdeshmukh.site/pages/project-pica.html).
372+
332373
---
333374

334375
## Citation
@@ -343,19 +384,18 @@ If you use this software in your research, please cite it:
343384
day = 26,
344385
year = 2026,
345386
publisher = {Zenodo},
346-
version = {1.0.1},
387+
version = {1.0.3},
347388
doi = {10.5281/zenodo.18377217},
348389
url = {https://doi.org/10.5281/zenodo.18377217}
349390
}
350-
````
391+
```
351392

352393
## Authors & Funding
353394

354395
This project is led by [**Prathamesh Deshmukh**](https://www.researchgate.net/profile/Prathamesh-Deshmukh-6) under the supervision of [**Dr. Sudip Mukherjee**](https://www.csr.res.in/Faculty/profile/889/893/Dr.SudipMukherjee) at the UGC-DAE Consortium for Scientific Research, Mumbai Centre, Bhabha Atomic Research Centre, Mumbai, 400 085, Maharashtra, India.
355396

356397
We acknowledge the financial support provided under the **SERB-CRG project grant No. CRG/2022/005676** from the Anusandhan National Research Foundation (ANRF), a statutory body of the Department of Science and Technology (DST), Government of India.
357398

358-
359399
<p align="center">
360400
<img src="pica/assets/LOGO/UGC_DAE_CSR_NBG.jpeg" alt="UGC DAE CSR Logo" width="150">
361401
</p>

0 commit comments

Comments
 (0)