Skip to content

Commit 914ec4b

Browse files
authored
Merge pull request #453 from GREENRAT-K405/dev
update tools documentation
2 parents 02cf91c + 73b2393 commit 914ec4b

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

tools/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
11
# _concore_ tools
22

33
A collection of utility methods and toolkits for _concore_.
4+
5+
## Plotting Tools
6+
7+
This directory includes several standard Python scripts for visualizing your simulation data:
8+
* **`plotym.py`**: This script visualizes the measured outputs of the physiological model over the course of the simulation.
9+
* **`plotymlag.py`**: Plots outputs utilizing a configurable lag buffer.
10+
* **`plotu.py`**: This script visualizes the control signals being generated by the controller node.Specifically, this script generates a 3x2 grid to track neuromodulation stimulation parameters across three different channels, displaying the Pulse Width (Pw) in seconds and Pulse Frequency (Pf) in Hz for each channel.
11+
12+
### Real-Time Plotting
13+
14+
By default, these scripts collect data silently during the simulation and render a single static graph when the simulation completes.
15+
16+
You can enable **real-time dynamic plotting** by passing the `realtime=True` parameter to your simulation. This opens an interactive Matplotlib window that updates continuously as the simulation runs.
17+
18+
#### How to enable real-time plotting
19+
20+
After generating and building your workflow, navigate to your generated output directory (usually `out/`). Use the generated `params` script to set the parameter *before* starting the run script:
21+
22+
**POSIX (Linux / macOS):**
23+
```bash
24+
cd <your-study>
25+
./params "realtime=True"
26+
./run or ./debug
27+
```
28+
29+
**Windows:**
30+
```bash
31+
cd <your-study>
32+
.\params "realtime=True"
33+
.\run or .\debug
34+
```

0 commit comments

Comments
 (0)