CMLabs · Psyclone AIOS
Psyclone User Guide
Everything you need to build real-time, modular, distributed applications on Psyclone — from your first ping-pong system to a full multi-node deployment with custom catalogs and live monitoring.
Psyclone is a platform for large-scale modular applications and the integration of disparate software and hardware. You compose a system from components — modules, whiteboards and catalogs — that communicate by messages and signals in a context-sensitive publish/subscribe environment, described in a single PsySpec XML file and monitored live through the PsyProbe web interface.
New to Psyclone? Start with the Introduction for the big picture, then follow the Quick Start to run your first system in minutes.
What’s in this guide
| If you want to… | Go to |
|---|---|
| Understand what Psyclone is and why it exists | 1. Introduction |
| Install, build and run your first system | 2. Quick Start |
| Learn the PsySpec file, components and the message bus | 3. Core Concepts |
| Write modules (C++ / Python / external) | 4. Modules |
| Route data with messages, signals, filters and tags | 5. Messaging & Signals |
| Reconfigure the system at runtime with contexts | 6. Contexts |
| Share and query data (whiteboards, catalogs) | 7 & 8 |
| Scale across nodes and processes | 10. Distributed Systems |
| Look up any PsySpec element or attribute | 13. PsySpec XML Reference |
| Follow step-by-step worked examples | 14. Tutorials |
| Look up what a term means | Glossary |