Skip to content

Getting Started

Jump to bottom
Jacky Mallett edited this page Sep 10, 2022 · 12 revisions

TLDR

  1. Clone Threadneedle from this github repository
  2. Make sure the latest Java JDK is installed (Java 18.0.1)
  3. Similarly install JavaFX version 18 (https://gluonhq.com/products/javafx/)
    • the path where JavaFX is installed must match the setting in ./build
  4. Build and Run Threadneedle - change into the Threadneedle directory
    • Unix/Linux derivatives: ./build
    • Windows : build.bat - may need to be edited to have correct path to the JDK and JavaFX

Java Downloads - Choose depending on platform

Oracle Java 18.0.2

Note: You will need to move the Java FX directory to the right local directory and change either build (Linux/OSX) or build.bat (Windows) appropriately.

Java FX SDK (to match java version

For example, on OSX:

Move the javafx directory that you have downloaded from the above, latest tested version is javafx-sdk-18.0.2 with java 18, to /usr/local

Update the build file to have the correct path/version to the above.

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. Java 18

You will need to install the Java 18 development kit 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 the Windows Linux environment.

Download

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