Skip to content

Commit 42c2224

Browse files
made README short
1 parent d183341 commit 42c2224

1 file changed

Lines changed: 15 additions & 21 deletions

File tree

README.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ PICA is designed with a clear separation between the user interface (frontend) a
3131

3232
<div align="center">
3333
<img src="_assets/Images/PICA_Laucher_V6.png" alt="PICA Launcher Screenshot" width="800"/>
34+
<img src="_assets/Images/PICA_Launcher_v6.png" alt="PICA Launcher Screenshot" width="800"/>
3435
</div>
3536

3637
---
@@ -89,6 +90,7 @@ The core of PICA is built with a stack of robust and widely-used Python librarie
8990

9091
- **Primary Language:** **Python 3.9+**
9192
- **Graphical User Interface:** **Tkinter** (with the **CustomTkinter** library for a modern look and feel)
93+
- **Graphical User Interface:** **Tkinter**
9294
- **Instrument Communication:** **PyVISA** (a Python wrapper for the NI-VISA library)
9395
- **Numerical Operations:** **NumPy**
9496
- **Data Structuring:** **Pandas**
@@ -170,9 +172,14 @@ The PICA suite is organized into modules, each containing a frontend GUI applica
170172
## Instrument Specifications
171173

172174
Here is a meticulously verified summary of the key measurement specifications for the instruments used in the PICA project. All values have been cross-referenced with the provided instrument manuals to ensure accuracy.
175+
PICA supports a range of common laboratory instruments. For a detailed summary of their measurement specifications, please see the Instrument Specifications Guide.
173176

174177
#### Keithley 6221 Current Source + 2182A Nanovoltmeter System (Low Resistance)
175178
**Primary Use:** High-precision, low-resistance I-V and R-T measurements via **Delta Mode**.
179+
- **Source-Measure Units:** Keithley 2400, Keithley 6221, Keithley 6517B
180+
- **Nanovoltmeters:** Keithley 2182A
181+
- **LCR Meters:** Keysight E4980A
182+
- **Temperature Controllers:** Lakeshore 340, Lakeshore 350
176183

177184
| Parameter | Lower Limit | Higher Limit | Best Resolution |
178185
| :------------------------ | :------------------------------------------------ | :-------------- | :------------------------------------------ |
@@ -183,6 +190,7 @@ Here is a meticulously verified summary of the key measurement specifications fo
183190

184191
#### Keithley 2400 SourceMeter (Mid-Range Resistance)
185192
**Primary Use:** Versatile four-probe I-V and R-T measurements for a broad range of materials.
193+
## 🚀 Getting Started
186194

187195
| Parameter | Lower Limit (Source / Measure) | Higher Limit (Source / Measure) | Best Resolution (Source / Measure) |
188196
| :----------------------------- | :----------------------------- | :------------------------------ | :----------------------------------- |
@@ -227,6 +235,7 @@ Here is a meticulously verified summary of the key measurement specifications fo
227235

228236
### Installation Steps
229237
h
238+
230239
1. **Clone the Repository**
231240
git clone https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation.git
232241
cd PICA-Python-Instrument-Control-and-Automation
@@ -260,10 +269,14 @@ h
260269
---
261270
262271
## Extending PICA: Adding a New Module
272+
## 🛠️ Extending PICA: Adding a New Module
263273
264274
The modular architecture makes it straightforward to add support for new instruments or measurement types. Here is a simplified example of the required structure.
265275
266276
#### 1. Create a Backend Class
277+
1. **Create a Backend Class:** Encapsulate all direct instrument communication (`PyVISA` commands) in a dedicated class.
278+
2. **Create a Frontend GUI:** Build a `Tkinter` GUI to gather user parameters and display live data. This GUI will instantiate and control the backend.
279+
3. **Integrate with the Launcher:** Add a button and the script path to `PICA_v6.py` to make your new module accessible from the main dashboard.
267280
268281
The backend class handles all direct communication with the instrument.
269282
@@ -339,6 +352,7 @@ For a quick reference on instrument addresses, see the `GPIB_Address_Guide.md` f
339352
---
340353

341354
## 🤝 Contributing
355+
## 🤝 How to Contribute
342356
Contributions are welcome! If you have suggestions for improvements or want to add a new instrument module, please feel free to:
343357
1. Fork the repository.
344358
2. Create a new branch (`git checkout -b feature/YourFeature`).
@@ -361,24 +375,4 @@ Please open an issue first to discuss any major changes you would like to make.
361375
- **Affiliation:** *[UGC-DAE Consortium for Scientific Research, Mumbai Centre](https://www.csr.res.in/Mumbai_Centre)*
362376

363377
#### Funding
364-
Financial support for this work was provided under SERB-CRG project grant No. CRG/2022/005676 from the Anusandhan National Research Foundation (ANRF), a statutory body of the Department of Science & Technology (DST), Government of India.<div align="center">
365-
<img src="_assets/LOGO/PICA_LOGO_NBG.png" alt="PICA Logo" width="150"/>
366-
<h1>PICA: Python-based Instrument Control and Automation</h1>
367-
<p>A modular software suite for automating laboratory measurements in physics research.</p>
368-
369-
<p>
370-
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a>
371-
<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/Python-3.9+-brightgreen.svg" alt="Python 3.9+"></a>
372-
<a href="#"><img src="https://img.shields.io/badge/Status-Active-success.svg" alt="Project Status: Active"></a>
373-
</p>
374-
<p>
375-
<a href="https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation"><img src="https://img.shields.io/github/last-commit/prathameshnium/PICA-Python-Instrument-Control-and-Automation" alt="Last Commit"></a>
376-
<a href="https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation"><img src="https://img.shields.io/github/repo-size/prathameshnium/PICA-Python-Instrument-Control-and-Automation" alt="Repo Size"></a>
377-
<a href="https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/stargazers"><img src="https://img.shields.io/github/stars/prathameshnium/PICA-Python-Instrument-Control-and-Automation?style=social" alt="GitHub Stars"></a>
378-
<a href="https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/network/members"><img src="https://img.shields.io/github/forks/prathameshnium/PICA-Python-Instrument-Control-and-Automation?style=social" alt="GitHub Forks"></a>
379-
</p>
380-
<p>
381-
<img src="https://komarev.com/ghpvc/?username=prathameshnium&repo=PICA-Python-Instrument-Control-and-Automation&color=brightgreen&style=flat" alt="Profile views">
382-
</p>
383-
</div>
384-
378+
Financial support for this work was provided under SERB-CRG project grant No. CRG/2022/005676 from the Anusandhan National Research Foundation (ANRF), a statutory body of the Department of Science & Technology (DST), Government of India.

0 commit comments

Comments
 (0)