Skip to content

Commit 4659f94

Browse files
wording changes
1 parent 1c8c7ee commit 4659f94

3 files changed

Lines changed: 22 additions & 3 deletions

File tree

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,10 +195,29 @@ PICA is structured as a standard Python package.
195195
pica-cli
196196
```
197197
> [!NOTE]
198-
> **Legacy CLI Notice:** The PICA CLI (`pica-cli`) is retained to support legacy headless workflows. While fully functional for specific protocols, this interface is **no longer actively maintained** and may not support recent features available in the GUI.
198+
> **Legacy CLI Notice:** The PICA CLI (`pica-cli`) is retained to support legacy headless workflows. While fully functional for specific protocols, this interface is **less frequently maintained** and may not support recent features available in the GUI.
199199
>
200200
> We **strongly recommend** new users utilize the PICA GUI for the most complete and supported experience.
201201

202+
## Example Usage: Running a Measurement
203+
204+
Upon launching PICA (`pica-gui`), select your desired measurement module from the main dashboard. Each module opens as a unified interface divided into two primary sections:
205+
206+
1. **Configuration (Control Window - Left):**
207+
* **Setup:** Enlarge this window first to view all experimental parameters.
208+
* **Parameters:** Specify the `Sample Name`, select the `File Storage Location`, and choose the `Instrument Address` (GPIB/VISA) via the dropdown selection box.
209+
* **Protocol:** Define measurement specific settings such as voltage/current limits, temperature step sizes, and delay times.
210+
* **Console:** A scrollable log at the bottom provides a continuous, time-stamped stream of all operations and SCPI commands sent to the instruments.
211+
212+
2. **Visualization (Plotter Window - Right):**
213+
* **Real-Time Monitoring:** Displays up to three simultaneous plots (e.g., Resistance vs. Temperature, Voltage vs. Current) updated in real-time.
214+
* **Data Analysis:** Includes options to switch axes to logarithmic scales for better visualization of wide-range data.
215+
* **Utilities:** Two buttons above the plot area provide instant access to:
216+
* **VISA Instrument Scanner:** To verify instrument connections and addresses.
217+
* **PICA Plotter Utility:** For post-measurement comparison and detailed analysis.
218+
219+
*The interface is designed to be minimalistic to reduce unnecessary user interaction during active high-precision measurements.*
220+
202221
---
203222
## Running Tests
204223

docs/User_Manual.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ PICA is structured as a standard Python package.
120120
pica-cli
121121
```
122122
> [!NOTE]
123-
> **Legacy CLI Notice:** The PICA CLI (`pica-cli`) is retained to support legacy headless workflows. While fully functional for specific protocols, this interface is **no longer actively maintained** and may not support recent features available in the GUI.
123+
> **Legacy CLI Notice:** The PICA CLI (`pica-cli`) is retained to support legacy headless workflows. While fully functional for specific protocols, this interface is **less frequently maintained** and may not support recent features available in the GUI.
124124
>
125125
> We **strongly recommend** new users utilize the PICA GUI for the most complete and supported experience.
126126

pica/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def print_banner():
5757
print("="*60)
5858
print("\n")
5959
print("*"*80)
60-
print("**Legacy CLI Notice:** The PICA CLI (`pica-cli`) is retained to support legacy headless workflows. While fully functional for specific protocols, this interface is **no longer actively maintained** and may not support recent features available in the GUI. We **strongly recommend** new users utilize the PICA GUI for the most complete and supported experience.")
60+
print("**Legacy CLI Notice:** The PICA CLI (`pica-cli`) is retained to support legacy headless workflows. While fully functional for specific protocols, this interface is **less frequently maintained** and may not support recent features available in the GUI. We **strongly recommend** new users utilize the PICA GUI for the most complete and supported experience.")
6161
print("*"*80)
6262
print("\n")
6363

0 commit comments

Comments
 (0)