Skip to content

Commit 73153d9

Browse files
Installation procedure updated
1 parent c43c5af commit 73153d9

1 file changed

Lines changed: 24 additions & 19 deletions

File tree

README.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@
4444

4545
<img src="https://img.shields.io/github/commit-activity/y/prathameshnium/PICA-Python-Instrument-Control-and-Automation?style=flat-square&color=success" alt="Commits (Yearly)">
4646
<img src="https://img.shields.io/github/languages/code-size/prathameshnium/PICA-Python-Instrument-Control-and-Automation?style=flat-square&color=blue" alt="Code Size">
47-
<img src="https://img.shields.io/tokei/lines/github/prathameshnium/PICA-Python-Instrument-Control-and-Automation" alt="Lines of Code">
4847
<img src="https://img.shields.io/github/last-commit/prathameshnium/PICA-Python-Instrument-Control-and-Automation?style=flat-square&color=critical" alt="Last Commit">
4948

5049
</div>
@@ -117,41 +116,47 @@ This software controls a facility designed for characterizing the full spectrum
117116

118117
---
119118

120-
## 🚀 Getting Started
119+
## Installation
121120

122-
### Prerequisites
123-
124-
1. **Python:** Python 3.10 or newer is recommended.
125-
2. **NI-VISA Driver:** You must install the [National Instruments VISA Driver](https://www.ni.com/en/support/downloads/drivers/download.ni-visa.html) or an equivalent backend. This is required for the `pyvisa` library to communicate with the instruments.
126-
127-
### Installation Steps
121+
PICA is now structured as a standard Python package. Follow these steps to install it in editable mode, which allows you to modify code and see changes immediately.
128122

129123
1. **Clone the Repository**
130124
```bash
131-
git clone [https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation.git](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation.git)
125+
git clone https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation.git
132126
cd PICA-Python-Instrument-Control-and-Automation
133127
```
134128

135129
2. **Create a Virtual Environment**
136-
Recommended to verify dependencies and avoid conflicts.
137130
```bash
138-
# Create the virtual environment
131+
# Windows
139132
python -m venv venv
140-
141-
# Activate (Windows)
142133
venv\Scripts\activate
143-
# Activate (macOS/Linux)
134+
135+
# macOS/Linux
136+
python3 -m venv venv
144137
source venv/bin/activate
145138
```
146139

147-
3. **Install Dependencies**
140+
3. **Install the Package**
141+
Use the `-e` (editable) flag. This installs PICA and all its dependencies (PyVISA, Pandas, etc.) linked to your current folder.
142+
```bash
143+
pip install -e .
144+
```
145+
146+
## 🖥️ Running the Software
147+
148+
You can now run PICA in two modes: the standard Graphical User Interface (GUI) or the new Command Line Interface (CLI) for headless operation.
149+
150+
1. **Graphical Launcher (GUI)**
151+
The standard dashboard for desktop users.
148152
```bash
149-
pip install -r requirements.txt
153+
python run_pica.py
150154
```
151155

152-
4. **Launch the Application**
156+
2. **Command Line Interface (CLI)**
157+
New in v.1.0.1: A text-based menu for running measurements via SSH, on Raspberry Pis, or in automated environments without a monitor.
153158
```bash
154-
python PICA.py
159+
python pica_cli.py
155160
```
156161

157162
---
@@ -184,7 +189,7 @@ To run the tests locally:
184189

185190
PICA has evolved from a collection of offline utility scripts into a modular software suite. The development timeline highlights the shift from manual instrument handling to a fully automated, asynchronous control system.
186191

187-
> **📜 Project Lore:** For a detailed chronological log of the project's development history, including the offline prototyping phase and specific version changelogs, please refer to [`docs/Change_Logs.md`](docs/Change_Logs.md).
192+
> **📜 Project Lore:** For a detailed chronological log of the project's development history, including the offline prototyping phase and specific version changelogs, please refer to [`Change_Logs.md`](Change_Logs.md).
188193
189194
### **v15.0 (Current): JOSS Submission & Professionalization**
190195
*Status: Released November 2025*

0 commit comments

Comments
 (0)