Skip to content

Getting Started

Jacky Mallett edited this page Nov 11, 2016 · 2 revisions


  1. Clone Threadneedle from this github repository
  2. Make sure the latest Java JDK is installed (Java 8)
  3. Build and Run - change into the Threadneedle directory
    • Unix/Linux derivatives: ./build
    • Windows : build.bat - may need to be edited to have correct path to JDK

Full Instructions

This guide assumes a reasonable background in development and programming, and some familiarity with the Linux/MacOS command line. Although java experience is not required to create simulations - simple ones can be made purely from the GUI, creating your own Agents or modifying the behaviours of existing agents does require some Java, or general programming, knowledge, or at least a willingness to learn those things.

Downloading, Compiling and Running Threadneedle.

You will need to install the Java 8 development kit (update 25 or later), which can be downloaded from Oracle:

Java JDK

and the git source code control system, graphical clients for which can be found at:

Github Clients.

Threadneedle is run via command line scripts. If you are using a Microsoft Windows operating system you may find it easier to use a Linux like command line environment such as Cygwin or Windows 10 bash (available Summer 2016).


Download Threadneedle from git to a directory of your choice. The following assumes Threadneedle is installed in your home directory.

Compile and Run Threadneedle

From the command line, change directory into the Threadneedle top directory. The following scripts are provided to compile and run Threadneedle (build), or just to run it (run):

  • build (MacOS/Linux) or build.bat (windows)
  • run (MacOS/Linux) or run.bat (windows)

To compile and run Threadneedle on MacOS for example, open Terminal (which can be found in Applications/Utilities), and enter:

$ ./build

If successful, Threadneedle will start, and you will see a dialog asking you to give the country name for your simulation.

and after pressing ok you will see the main windows:

More information on creating simulations can be found in the following documents.

Clone this wiki locally
You can’t perform that action at this time.