Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions tools/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
# _concore_ tools

A collection of utility methods and toolkits for _concore_.

## Plotting Tools

This directory includes several standard Python scripts for visualizing your simulation data:
* **`plotym.py`**: This script visualizes the measured outputs of the physiological model over the course of the simulation.
* **`plotymlag.py`**: Plots outputs utilizing a configurable lag buffer.
* **`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.

### Real-Time Plotting

By default, these scripts collect data silently during the simulation and render a single static graph when the simulation completes.

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.

#### How to enable real-time plotting

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:

**POSIX (Linux / macOS):**
```bash
cd <your-study>
./params "realtime=True"
./run or ./debug
```

**Windows:**
```bash
cd <your-study>
.\params "realtime=True"
.\run or .\debug
```