Setup

Authentication

The Simudyne SDK libraries are hosted on JFrog Artifactory at https://simudyne.jfrog.io/simudyne. Maven authenticates using a settings.xml file.

Your organisation's access credentials (username and API key) are provided as part of SDK onboarding. Add a <server> entry to your Maven settings.xml (typically at ~/.m2/settings.xml on Mac/Linux or %USERPROFILE%\.m2\settings.xml on Windows). Create the file if it does not exist:

<settings>
  <servers>
    <server>
      <id>simudyne.jfrog.io</id>
      <username>your-username</username>
      <password>your-api-key</password>
    </server>
  </servers>
</settings>

The <id> value (simudyne.jfrog.io) must match the repository <id> declared in your pom.xml.

Your organisation may require an HTTPS proxy for outbound requests. Add proxy settings to your settings.xml:

<proxies>
  <proxy>
    <active>true</active>
    <protocol>https</protocol>
    <host>proxy.example.com</host>
    <port>8080</port>
  </proxy>
</proxies>

IntelliJ IDEA

To use IntelliJ with the SDK:

1. Open the project root with File → Open and select the pom.xml.
2. In the Import Project from Maven dialog, make sure the JDK is set to JDK 25.
3. IntelliJ reads ~/.m2/settings.xml automatically for repository credentials.
4. If your model uses Spark, add the JVM module-access flags from the Requirements page under Run/Debug Configurations → VM options.

Simudyne License

SDK users receive a Simudyne license file as part of the onboarding process. Contact support@simudyne.com if you have licensing problems.

Simudyne licenses have a .license extension. The SDK automatically searches for licenses in the .simudyne directory. If the directory contains more than one license file, the SDK will pick one at random.

Use the following commands to create and open the .simudyne directory, then place the license file inside.

On Windows (Command Prompt):

md "%userprofile%\.simudyne"
explorer "%userprofile%\.simudyne"

On Mac OS and Linux:

mkdir -p ~/.simudyne
open ~/.simudyne   # macOS
xdg-open ~/.simudyne  # Linux

There are several ways Simudyne licenses can be configured for project-local use:

1. Copy the license to the project's root directory and rename it to licenseKey. The SDK will prioritise this license.
2. Set a core.license-file property in the simudyneSDK.properties file. The value should be the path to the license relative to your project root.
3. Pass the license path via the JVM flag -DsimudyneLicenseFile when launching your application.

Verifying Installation

Once credentials and the license are in place, compile and run the project from its root:

mvn compile exec:java

The first run downloads dependencies from JFrog Artifactory to the local Maven repository (~/.m2/repository). Subsequent runs use the cached jars.

If the server starts successfully you will see:

Server online at http://localhost:8080/

Navigate to that address in a browser to see the list of registered models. If you reach this step, authentication and licensing are working correctly.

If the build fails to authenticate, provide any error messages and contact support@simudyne.com.