Documentation
Reference
Javadocs
REST API
|
No results found.
SDK version
Get Started with the SDK
About SimudyneWhat is ABM?AccessRequirementsSetupBuild Your First ModelIntroductory Course
Tutorials
Synthetic Market TutorialMortgage Portfolio TutorialSchelling Segregation TutorialSIR Epidemiology TutorialForest Fire TutorialChiarella Calibration Tutorial
Features
Agents & Network/GraphGraph ComputationInput & OutputInteractive ConsoleRun & DeployMonte CarloDistributed ModellingTesting, Configuring, and Debugging
Sample Models
Tumor Growth ModelChain Bankruptcy ModelGai-Kapadia ModelCredit Card ModelMark 0 Simple Economy ModelFactory SimulatorConsultancy Model
Financial Tool Kit
Market SimulatorLending Model
Challenges
Synthetic Market ChallengeSimple Economy Challenge
Commercial Models
Financial Vulnerability ModelCCP Risk ModelDefense ModelsEconomic Forecasting Model
FAQ
Release Notes
HistoryLibrariesSimudyne SDK License Agreement

Requirements

Last updated on 16th July 2024

Minimum Requirements

The Simudyne SDK is a set of libraries in Java that will require the following to run:

  1. Java JDK 8 (Java Development Kit - must be 1.8)
  2. Maven
  3. IDE (recommend IntelliJ)

Getting Access

Free access is available for research and non-commercial purposes. If you would like to use the SDK for commercial purposes, you will need to purchase a license, please contact support@simudyne.com for more info.

Access to the Simudyne SDK is authenticated via an access token, and license file system.

30-day Free Trial

Email to Get Access to the SDK

If you would like to download a free 30-day trial, please click the button above to email us. You will then be sent an access token, and a license file to begin test-driving the software.

There are 2 options for downloading the Simudyne SDK libraries:

  1. Maven (recommended): Use Maven to download the libraries - A Firewall can block authentication and grabbing of Maven libraries, if Maven is being blocked, make sure to check your Firewall settings.
  2. Offline Installer: If your security restrictions will not allow you to use Maven, an offline installer is available for installing the libraries without Maven.

Offline installer

If you require an offline installer please contact support by emailing support@simudyne.com. A member of the team will be in touch with an offline installer access credentials.

Windows

JDK 8

It is highly recommended that you download the 64-Bit version of the JDK (if your system supports it). This is because only the 64-Bit version allows you to customize the available JVM memory via commands like -Xms and -Xmx.

Download and install the latest version of JDK 8 from the Oracle repository.

Other distributions of JDK 8 are available and can be downloaded using IntelliJ.

The JDK 8 installation path is explicitly set in the Windows installer, and can be saved from there.

It is recommended to install the Maven build tool to manage Simudyne SDK projects, even when using IntelliJ Idea.

Maven

  1. Visit the Maven repository and download the latest release.
  2. Extract the file and save it in the C:\Program Files directory.
  3. Right click on the Windows button, in the lower left corner of the screen, and open "Settings".
  4. In the search field, search for and select "Edit the system environment variables".
  5. On the "Advanced" tab, click "Environment Variables".
  6. In "System Variables", add the following variables if they do not exist. Otherwise, edit them accordingly.
Name Value
JAVA_HOME JDK repository (JDK installation path)
M2_HOME C:\Program Files\apache-maven-x.x.x
MAVEN_HOME C:\Program Files\apache-maven-x.x.x
PATH Add "%M2_HOME%\bin" to existing variable

To add the Maven home location to the PATH system variable:

  1. Select the PATH system variable.
  2. Underneath the list of system variables, click "Edit".
  3. In the dialog that appears, click "New."
  4. Enter "%M2_HOME%\bin" into the next empty PATH variable row.
  5. Hit "Enter" to save the value.

Finally, check whether the install was successful by running the following command.

mvn -v

If it returns Apache Maven X.X.X, the install was successful.

IDE

Simudyne recommends using IntelliJ Idea. This IDE also manages builds, so it is not necessary to install a separate build tool, however, it is recommended that the Maven build tool be installed.

There are instructions for using the Eclipse IDE in the reference section.

Mac OS

JDK 8

Run the following command in a terminal to check whether JDK 8 is already installed.

javac version

If the command returns a JDK version number that starts with 1.8 or higher, the system already has the proper JDK installed. Otherwise, the current JDK must be uninstalled before installing JDK 8.

Run the following command to uninstall an older JDK.

$ sudo rm -rf /Library/Java/JavaVirtualMachines/jdk<version>.jdk

Download and install the latest version of JDK 8 from the Oracle repository.

Other distributions of JDK 8 are available and can be downloaded using IntelliJ.

On Linux, run the following commands.

$ sudo add-apt-repository ppa:webupd8team/java
$ sudo apt-get update
$ sudo apt-get install oracle-java8-installer

The JDK 8 installation path is returned by the terminal after installation is complete.

Maven

The process of installing Maven differs slightly between Mac OS and Linux.

On Mac OS, make sure Homebrew is installed, then run the following command.

$ brew install maven

On Linux, run the following command.

$ apt-cache search maven
$ sudo apt-get install maven

IDE

Simudyne recommends using IntelliJ Idea. This IDE also manages builds, so it is not necessary to install a separate build tool, however, it is recommended that the Maven build tool be installed in the next section.

There are instructions for using the Eclipse IDE in the reference section.

Linux

JDK 8

Download and install the latest version of JDK 8 from the Oracle repository.

Other distributions of JDK 8 are available and can be downloaded using IntelliJ.

On Linux, run the following commands.

$ sudo add-apt-repository ppa:webupd8team/java
$ sudo apt-get update
$ sudo apt-get install oracle-java8-installer

The JDK 8 installation path is returned by the terminal after installation is complete.

Maven

On Linux, run the following command:

$ apt-cache search maven
$ sudo apt-get install maven

IDE

Simudyne recommends using IntelliJ Idea. This IDE also manages builds, so it is not necessary to install a separate build tool, however, it is recommended that the Maven build tool be installed in the next section.

There are instructions for using the Eclipse IDE in the reference section.

AccessSetup