Skip to content

Commit d05371b

Browse files
Readme made consise
1 parent d5a3907 commit d05371b

1 file changed

Lines changed: 9 additions & 15 deletions

File tree

README.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,12 @@ The core design philosophy of PICA is the separation of concerns, implemented th
4141

4242
- **Frontend:** Each measurement has a dedicated GUI script (e.g., `IV_K2400_Frontend_v5.py`) built with `Tkinter` and the `CustomTkinter` library. It is responsible for all user interaction, parameter input, and data visualization (live plotting). It runs in the main process.
4343
- **Frontend:** Each measurement has a dedicated GUI script (e.g., `IV_K2400_Frontend_v5.py`) built with Python's standard `Tkinter` library. It is responsible for all user interaction, parameter input, and data visualization (live plotting). It runs in the main process.
44-
4544
- **Backend:** The instrument control logic is encapsulated in a separate class (e.g., `Keithley2400_Backend`). This class handles all `PyVISA` communication, instrument configuration, and data acquisition commands.
46-
4745
- **Process Isolation:** When a measurement is started, the frontend launches its corresponding backend logic in a separate, isolated process using Python's `multiprocessing` library. This is the key to PICA's stability: a crash or error in one measurement script will not affect the main launcher or any other running experiments.
48-
4946
- **Communication:** The frontend and backend communicate via `multiprocessing.Queue` for thread-safe data exchange. The backend performs a measurement and places the data into a queue, which the frontend then reads to update plots and save to a file.
5047

48+
---
49+
5150
## Table of Contents
5251

5352
- [Core Features](#core-features)
@@ -81,14 +80,15 @@ The core of PICA is built with a stack of robust and widely-used Python librarie
8180

8281
<p align="center">
8382
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/Python-3.9+-blue.svg?logo=python&logoColor=white" alt="Python"></a> <a href="https://docs.python.org/3/library/tkinter.html"><img src="https://img.shields.io/badge/Tkinter-GUI-orange.svg" alt="Tkinter"></a>
83+
<a href="https://github.com/TomSchimansky/CustomTkinter"><img src="https://img.shields.io/badge/CustomTkinter-Modern%20GUI-orange.svg" alt="CustomTkinter"></a>
8484
<a href="https://pyvisa.readthedocs.io/en/latest/"><img src="https://img.shields.io/badge/PyVISA-Instrument%20Control-yellow.svg" alt="PyVISA"></a>
8585
<a href="https://numpy.org/"><img src="https://img.shields.io/badge/NumPy-Data%20Handling-blueviolet.svg?logo=numpy&logoColor=white" alt="NumPy"></a>
8686
<a href="https://pandas.pydata.org/"><img src="https://img.shields.io/badge/Pandas-Data%20Manipulation-purple.svg?logo=pandas&logoColor=white" alt="Pandas"></a>
8787
<a href="https://matplotlib.org/"><img src="https://img.shields.io/badge/Matplotlib-Plotting-green.svg?logo=matplotlib&logoColor=white" alt="Matplotlib"></a>
8888
</p>
8989

9090
- **Primary Language:** **Python 3.9+**
91-
- **Graphical User Interface:** **Tkinter** (Python's standard GUI library)
91+
- **Graphical User Interface:** **Tkinter** (with the **CustomTkinter** library for a modern look and feel)
9292
- **Instrument Communication:** **PyVISA** (a Python wrapper for the NI-VISA library)
9393
- **Numerical Operations:** **NumPy**
9494
- **Data Structuring:** **Pandas**
@@ -98,7 +98,7 @@ The core of PICA is built with a stack of robust and widely-used Python librarie
9898
All required packages are listed in the `requirements.txt` file for easy one-step installation.
9999

100100
---
101-
101+
## Available Measurement Modules
102102
## Available Scripts & Modules
103103

104104
The PICA suite is organized into modules, each containing a frontend GUI application and its corresponding backend logic for instrument control.
@@ -227,6 +227,7 @@ Here is a meticulously verified summary of the key measurement specifications fo
227227

228228
### Installation Steps
229229
h
230+
1. **Clone the Repository**
230231
git clone https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation.git
231232
cd PICA-Python-Instrument-Control-and-Automation
232233
```
@@ -327,13 +328,13 @@ Finally, add the path to your new frontend script in `PICA_v6.py` and `Setup/Pic
327328

328329
---
329330

330-
## 📚 Resources & Documentation
331+
## Resources & Documentation
331332

332333
#### Included Manuals
333334
A collection of official instrument manuals and software library documentation is provided within the `/_assets/Manuals/` directory. These documents serve as valuable technical references.
334335

335336
#### Instrument Interfacing Guide
336-
For a detailed guide on hardware setup, instrument configuration, and connection testing, please consult the **Python Instrument Interfacing Guide**.
337+
For a quick reference on instrument addresses, see the `GPIB_Address_Guide.md` file.
337338

338339
---
339340

@@ -349,7 +350,7 @@ Please open an issue first to discuss any major changes you would like to make.
349350

350351
---
351352

352-
## 🧑‍🔬 Authors & Acknowledgments
353+
## Authors & Acknowledgments
353354

354355
<div align="center">
355356
<img src="_assets/LOGO/UGC_DAE_CSR_NBG.jpeg" alt="UGC DAE CSR Logo" width="150">
@@ -756,10 +757,3 @@ Financial support for this work was provided under SERB-CRG project grant No. CR
756757
## License
757758
758759
This project is licensed under the terms of the MIT License. See the `LICENSE` file for full details.
759-
760-
761-
---
762-
763-
## License
764-
765-
This project is licensed under the terms of the MIT License. See the `LICENSE` file for full details.

0 commit comments

Comments
 (0)