Skip to content

Commit 680d601

Browse files
Readme updated
1 parent 9bae001 commit 680d601

2 files changed

Lines changed: 650 additions & 1107 deletions

File tree

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
<div align="center">
1+
<p align="center">
22
<img src="assets/LOGO/PICA_LOGO_NBG.png" alt="PICA Logo" width="150"/>
3-
<h1>PICA: Python-based Instrument Control and Automation</h1>
4-
<p>A modular software suite for automating laboratory measurements in physics research.</p>
3+
</p>
4+
<h1 align="center">PICA: Python-based Instrument Control and Automation</h1>
5+
<p align="center">
6+
A modular software suite for automating laboratory measurements in physics research.
7+
</p>
58

6-
<p>
9+
<p align="center">
710
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a>
811
<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/Python-3.9+-brightgreen.svg" alt="Python 3.9+"></a>
912
<a href="https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/actions/workflows/joss_tests.yml"><img src="https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/actions/workflows/joss_tests.yml/badge.svg" alt="Run PICA JOSS Tests"></a>
1013
<a href="https://codecov.io/gh/prathameshnium/PICA-Python-Instrument-Control-and-Automation"><img src="https://codecov.io/gh/prathameshnium/PICA-Python-Instrument-Control-and-Automation/branch/main/graph/badge.svg" alt="codecov"></a>
1114
<a href="https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/actions/workflows/codeql.yml"><img src="https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/actions/workflows/codeql.yml/badge.svg" alt="CodeQL"></a>
12-
</p>
13-
</div>
15+
</p>
1416

1517
---
1618

@@ -22,9 +24,9 @@ A key architectural feature is the use of isolated process execution for each me
2224

2325
PICA is designed with a clear separation between the user interface (GUI) and the instrument control logic (backend). This modular approach makes the system easy to maintain, extend, and debug.
2426

25-
<div align="center">
27+
<p align="center">
2628
<img src="assets/Images/PICA_Launcher_v6.png" alt="PICA Launcher Screenshot" width="800"/>
27-
</div>
29+
</p>
2830

2931
---
3032

@@ -148,7 +150,7 @@ This facility provides users with a comprehensive, modular system for characteri
148150

149151
1. **Clone the Repository**
150152
```bash
151-
git clone [https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation.git](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation.git)
153+
git clone https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation.git
152154
cd PICA-Python-Instrument-Control-and-Automation
153155
```
154156

@@ -203,17 +205,17 @@ If you use this software in your research, please cite it. This helps to credit
203205
year = 2023,
204206
publisher = {GitHub},
205207
version = {14.1.0},
206-
url = {[https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation)}
208+
url = {https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation}
207209
}
208-
````
210+
```
209211
210212
Alternatively, you can use the `CITATION.cff` file in the root of the repository for automatic parsing by modern reference managers.
211213
212-
-----
214+
---
213215
214216
## 🤝 How to Contribute
215217
216-
Contributions are welcome\! If you have suggestions for improvements or want to add a new instrument module, please feel free to:
218+
Contributions are welcome! If you have suggestions for improvements or want to add a new instrument module, please feel free to:
217219
218220
1. Fork the repository.
219221
2. Create a new branch (`git checkout -b feature/YourFeature`).
@@ -223,18 +225,17 @@ Contributions are welcome\! If you have suggestions for improvements or want to
223225
224226
Please open an issue first to discuss any major changes you would like to make.
225227
226-
-----
228+
---
227229
228230
## Authors & Acknowledgments
229231
230-
\<div align="center"\>
231-
\<img src="assets/LOGO/UGC\_DAE\_CSR\_NBG.jpeg" alt="UGC DAE CSR Logo" width="150"\>
232-
\</div\>
232+
<p align="center">
233+
<img src="assets/LOGO/UGC_DAE_CSR_NBG.jpeg" alt="UGC DAE CSR Logo" width="150">
234+
</p>
233235
234-
- **Lead Developer:** **[Prathamesh Deshmukh](https://prathameshdeshmukh.site/)**
235-
- **Principal Investigator:** **[Dr. Sudip Mukherjee](https://www.researchgate.net/lab/Sudip-Mukherjee-Lab)**
236-
- **Affiliation:** *[UGC-DAE Consortium for Scientific Research, Mumbai Centre](https://www.csr.res.in/Mumbai_Centre)*
236+
- **Lead Developer:** **[Prathamesh Deshmukh](https://prathameshdeshmukh.site/)**
237+
- **Principal Investigator:** **[Dr. Sudip Mukherjee](https://www.researchgate.net/lab/Sudip-Mukherjee-Lab)**
238+
- **Affiliation:** *[UGC-DAE Consortium for Scientific Research, Mumbai Centre](https://www.csr.res.in/Mumbai_Centre)*
237239
238240
#### Funding
239-
240-
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.
241+
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)