Skip to content

Commit 21a0a8f

Browse files
Create CONTRIBUTING.md
init
1 parent 63a06a5 commit 21a0a8f

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing to PICA
2+
3+
Thank you for your interest in PICA (Python-based Instrument Control and Automation)
4+
5+
As this is primarily a research project for the UGC-DAE CSR Mumbai Centre, our main goal is stability for our experiments. However, we welcome feedback and contributions from the scientific community.
6+
7+
## How to Report Bugs
8+
If you encounter an error while running a measurement:
9+
1. Go to the [Issues tab](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/issues).
10+
2. Click "New Issue".
11+
3. Include the error message from the PICA console and which instrument you were using (e.g., Keithley 2400).
12+
13+
## How to Suggest Features
14+
If you have a script for a new instrument (e.g., a lock-in amplifier) that you would like to include:
15+
1. Fork this repository.
16+
2. Add your script to a new folder (e.g., `SRS_830/`).
17+
3. Submit a Pull Request (PR) describing what the instrument does.
18+
19+
## Development Setup
20+
To run the PICA launcher locally for development:
21+
```bash
22+
pip install -e .
23+
python PICA_v6.py

0 commit comments

Comments
 (0)