Skip to content

Commit 14f8cdb

Browse files
installation from readme to docs
1 parent f0b17a1 commit 14f8cdb

1 file changed

Lines changed: 29 additions & 23 deletions

File tree

docs/User_Manual.md

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -86,33 +86,39 @@ This approach, however, leads to a considerable degree of code repetition becaus
8686
> - **PyVISA-py:** A backend written in pure Python that is installed automatically with PICA. It can be used as a fallback but may have limitations compared to vendor-specific drivers like NI-VISA.
8787
>
8888
> **Before proceeding, verify your VISA installation.**
89-
90-
### 3.2 Installation Procedure
91-
```bash
92-
# Clone the repository
93-
git clone https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation.git
94-
cd PICA-Python-Instrument-Control-and-Automation
9589
96-
# Create virtual environment (Recommended)
97-
python -m venv venv
98-
# Activate: venv\Scripts\activate (Windows) or source venv/bin/activate (Linux/Mac)
90+
### 3.2 Getting Started
9991

100-
# Install Python dependencies
101-
pip install -r requirements.txt
92+
PICA is structured as a standard Python package.
10293

103-
# The base installation does not include gpib-ctypes, which is only required for
104-
# specific GPIB hardware on Linux systems (e.g., linux-gpib).
105-
# If you need this functionality, install it separately:
106-
pip install .[gpib]
107-
```
94+
1. **Clone the Repository**
95+
```bash
96+
git clone [https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation.git](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation.git)
97+
cd PICA-Python-Instrument-Control-and-Automation
98+
```
10899

109-
### 3.3 Execution
100+
2. **Create Virtual Environment & Install**
101+
```bash
102+
python -m venv venv
103+
# Activate venv (Windows: venv\Scripts\activate, Linux/Mac: source venv/bin/activate)
104+
pip install .
105+
```
110106

111-
Launch the main dashboard:
107+
*Note: Ensure you have the NI-VISA drivers installed on your host machine to allow `PyVISA` to communicate with the hardware.*
112108

113-
```bash
114-
python run_pica.py
115-
```
109+
### 3.3 Running the Software
110+
111+
1. **Graphical Launcher (Recommended)**
112+
The central dashboard for accessing all modules, the plotter, and the scanner.
113+
```bash
114+
pica-gui
115+
```
116+
117+
2. **Command Line Interface (CLI)**
118+
For headless operation (e.g., Raspberry Pi).
119+
```bash
120+
pica-cli
121+
```
116122
> [!WARNING]
117123
> **CLI Deprecation Notice:** The PICA CLI is comprised of old, deprecated scripts from the early stages of development. It is **strongly recommended to use the PICA GUI** for all interactions. The CLI scripts are considered legacy code, contain minimal functionality for performing set protocols, and are not recommended for general use.
118124

@@ -124,12 +130,12 @@ If you plan to contribute to PICA or run the test suite, you will need to instal
124130
pip install -r requirements-dev.txt
125131
```
126132

127-
## Safety Precautions
133+
## 4. Safety Precautions
128134

129135
> [!WARNING]
130136
> **Safety Instructions:** Always switch off the instrument and verify that the output current, voltage, and any other relevant parameters are set to zero before modifying the connections to the Device Under Test (DUT). Failure to follow appropriate safety procedures may result in electric shock or other hazards. Adopt a safety-first approach at all times, and ensure that all instrument parameters remain within the specified safe operating limits defined either by the instrument manufacturer or by your measurement setup.
131137

132-
## 4. Core Utilities
138+
## 5. Core Utilities
133139

134140
### 4.1 VISA Instrument Scanner
135141

0 commit comments

Comments
 (0)