You are looking at the QUICKSTART for Psyclone 2.1 (26 July 2026).

The use of this software is subject to licensing terms; 
please see the headers of the files that belong to this distribution.

--------------------------------------------------------------------------------
For documentation see the readme.html file in the top-level directory or the
Psyclone Manual from within PsyProbe.

--------------------------------------------------------------------------------
INTRODUCTION

Psyclone is a general-purpose platform for deploying multiple processes with 
powerful message and stream communications. It employs a simple yet powerful
publish-subscribe mechanism that allows you to quickly create and connect 
modules and make them interact.

We'd love to hear about your experience in working with Psyclone so we can 
continue improving it. Please tell us about your use of it by sending email
to: feedback@cmlabs.com

--------------------------------------------------------------------------------
COMPILING PSYCLONE

On Windows you can use Visual Studio Express or Professional 2010, 2012 and 2013
to open the appropriate solution file in the root directory and compile the
solution for either 32-bit or 64-bit for either Release or Debug.

On Linux you can use GCC-C++ and MAKE to compile the full solution for release
(‘make’) or debug (‘make debug’). Remember to do a ‘make clear’ when switching
between release and debug.

This should result in the binary Psyclone executable (Psyclone.exe or
PsycloneDebug.exe on Windows and Psyclone on Linux) to be created in the dir
bin/<arch> where <arch> is either win32, win64, linux32 or linux64.

In the same dir at least two DLLs/shared object will be, called Examples and
PsySystem (with appropriate Debug, lib, .dll or .so). The Examples library
contains all the Module Cranks from the Examples project (which you can extend
or recreate) and the PsySystem library contains all the system components such
as Whiteboards and Catalogs which you can copy to Examples and modify to create
new types of system components.

--------------------------------------------------------------------------------
RUNNING PSYCLONE

Running the Psyclone executable with the command line ‘psytest’ will auto-
generate a PsySpec with Modules, Whiteboards and Catalogs from the included
Examples library and run the system on a single node. ‘psytest=N’ will spawn
N nodes on the local computer and dynamically spread the test Modules across
the system and run the tests.

You can create your own PsySpec configuration file and run Psyclone with this
using the ‘spec=<file>’ parameter. To run Psyclone on a port different from
port 10000 you can use ‘port=<other port>’.

-------------------------------------------------------------------------------
PsyProbe: WEB-BASED INTERFACE

PsyProbe is the web-based interface to Psyclone. It allows you to see the 
status of Psyclone at run time. With Psyclone running, do the following in 
your favourite browser on the same machine:

  http://localhost:10000

(or another port number if you changed the default port using the command line)

PsyProbe uses Javascript extensively -- remember to turn it on in your 
browser's preferences. 

Detailed instructions can be found in the readme.html file.

-------------------------------------------------------------------------------
THE EXAMPLES

To see a demonstration of how the posting and registration works in Psyclone, 
you can see the example modules in the Examples project.

Detailed instructions can be found in the readme.html file.

-------------------------------------------------------------------------------
COPYRIGHT NOTICE
Copyright © 2026 by Communicative Machines Limited.
All rights reserved.

The content of this guide is the property of Communicative Machines. Permission 
to make digital or hard copies of part or all of this work, to republish, to post 
on servers, or to redistribute to lists, for personal or classroom use, is 
granted without fee provided that copies are not made or distributed for profit 
or commercial advantage and that copies bear this notice. For all other use, 
special permissions are required. Contact info@cmlabs.com. 

Psyclone is a trademark of Communicative Machines Limited.
