diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 41 |
1 files changed, 35 insertions, 6 deletions
@@ -33,12 +33,12 @@ typically takes less than a second) based on the specified arguments and launches it immediately. Different VM architectures can be implemented as standalone C files, plus an -associated `arch_vars.py` script, within in the `arch/` directory. When creating -a new simulation, you can select a specific architecture using the `--arch` +associated `vars.py` script, within in the `arch/` directory. When creating a +new simulation, you can select a specific architecture using the `--arch` argument. Similarly, different user interfaces are implemented as C files, plus an -associated `ui_vars.py` script, within the `ui/` directory. For example, the +associated `vars.py` script, within the `ui/` directory. For example, the `curses` UI launches a terminal-based simulation visualizer, allowing easy exploration of *SALIS* memory cores and processes. In contrast, the `daemon` UI provides minimal output, making it ideal for running *SALIS* as a background @@ -62,10 +62,39 @@ removed, you can reload the saved simulation with the following command: user@host$ ./salis.py load -n world-1 -o ``` -## Requirements +## Data server and client + + +*SALIS data client showing live simulation data* + +This project includes a native data visualizer that plots live simulation data. +A generic set of plots is configured by default for all VM architectures. Each +architecture may expand on these by configuring its own set of plots within +`arch/{arch}/plots.cpp`. Once a simulation has been created (i.e., exists in +${HOME}/.salis), you may launch the data server with: +```console +user@host$ ./salis.py server -n world-1 -o +``` + +The server may run regardless of whether the simulator itself is running or not. +Once the server is running, you may attach a client from the local network by +running: +```console +user@host$ ./salis.py client -o -i ${SERVER_IP} +``` + +## Dependencies - C compiler - Python - -## Optional Dependencies - SQLite - Zlib + +## Dependencies for curses UI +- NCurses + +## Dependencies for data client +- GLFW +- GLU +- ImGui +- ImPlot +- OpenGL |