Skip to content

Commit d5a3907

Browse files
📃 docs(Method to Cite Added):
1 parent ead7a3c commit d5a3907

4 files changed

Lines changed: 55 additions & 6 deletions

File tree

CITATION.cff

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ authors:
88
- family-names: "Mukherjee"
99
given-names: "Sudip"
1010
affiliation: "UGC-DAE Consortium for Scientific Research, Mumbai Centre"
11-
title: "PICA: Python-based Instrument Control and Automation"
11+
title: "PICA: Python-based Instrument Control and Automation Software Suite"
1212
version: 14.1.0
13-
date-released: 2024-05-22
13+
date-released: 2023-09-01
1414
url: "https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation"
1515
repository-code: "https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation"
1616
license: MIT

PICA_README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,30 @@ This executable (`Picachu.exe`) is a standalone application. Simply run it to op
180180

181181
---
182182

183+
## How to Cite
184+
185+
If you use this software in your research, please cite it. This helps to credit the work involved in creating and maintaining this resource.
186+
187+
#### BibTeX Entry
188+
189+
You can use the following BibTeX entry for your reference manager (e.g., Zotero, Mendeley, JabRef).
190+
191+
```bibtex
192+
@software{Deshmukh_PICA_2023,
193+
author = {Deshmukh, Prathamesh Keshao and Mukherjee, Sudip},
194+
title = {{PICA: Python-based Instrument Control and Automation Software Suite}},
195+
month = sep,
196+
year = 2023,
197+
publisher = {GitHub},
198+
version = {14.1.0},
199+
url = {https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation}
200+
}
201+
```
202+
203+
Alternatively, you can use the `CITATION.cff` file in the root of the repository for automatic parsing by modern reference managers.
204+
205+
---
206+
183207
## 📚 Resources & Documentation
184208

185209
#### Included Manuals

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -420,6 +420,7 @@ The core design philosophy of PICA is the separation of concerns, implemented th
420420
- [Getting Started](#getting-started)
421421
- [Prerequisites](#prerequisites)
422422
- [Installation Steps](#installation-steps)
423+
- [How to Cite](#how-to-cite)
423424
- [Resources & Documentation](#resources--documentation)
424425
- [Contributing](#contributing)
425426
- [Authors & Acknowledgments](#authors--acknowledgments)
@@ -691,6 +692,30 @@ Finally, add the path to your new frontend script in `PICA_v6.py` and `Setup/Pic
691692
692693
---
693694
695+
## How to Cite
696+
697+
If you use this software in your research, please cite it. This helps to credit the work involved in creating and maintaining this resource.
698+
699+
#### BibTeX Entry
700+
701+
You can use the following BibTeX entry for your reference manager (e.g., Zotero, Mendeley, JabRef).
702+
703+
```bibtex
704+
@software{Deshmukh_PICA_2023,
705+
author = {Deshmukh, Prathamesh Keshao and Mukherjee, Sudip},
706+
title = {{PICA: Python-based Instrument Control and Automation Software Suite}},
707+
month = sep,
708+
year = 2023,
709+
publisher = {GitHub},
710+
version = {14.1.0},
711+
url = {https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation}
712+
}
713+
```
714+
715+
Alternatively, you can use the `CITATION.cff` file in the root of the repository for automatic parsing by modern reference managers.
716+
717+
---
718+
694719
## 📚 Resources & Documentation
695720
696721
#### Included Manuals

index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ You can use the following BibTeX entry for your reference manager (e.g., Zotero,
1212

1313
.. code-block:: bibtex
1414
15-
@software{Deshmukh_PICA_2024,
15+
@software{Deshmukh_PICA_2023,
1616
author = {Deshmukh, Prathamesh Keshao and Mukherjee, Sudip},
17-
title = {{PICA: Python-based Instrument Control and Automation}},
18-
month = may,
19-
year = 2024,
17+
title = {{PICA: Python-based Instrument Control and Automation Software Suite}},
18+
month = sep,
19+
year = 2023,
2020
publisher = {GitHub},
2121
version = {14.1.0},
2222
url = {https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation}

0 commit comments

Comments
 (0)