Interfaces

Besides the graphical user interface, the SIMPLACE engine can be used in several ways. All of them use one common interface of the engine, the SimplaceWrapper: open a session with a solution (and optionally a project), create and run simulations – as a whole or step by step – and read the results.

Console

The console distribution (see Download) runs solutions and projects without a graphical user interface, e.g. on a server or in batch jobs:

simplace run -workdir=<WORK_DIR> -outputdir=<OUTPUT_DIR> ...
simplace check ...
simplace postprocess ...

simplace help lists all commands and options.

REST server

Since version 5.3 the engine can be offered as a REST service: a remote client opens a session, queues simulations, runs them, polls the progress and retrieves the results over HTTP.

simplace rest -workdir=<WORK_DIR> -outputdir=<OUTPUT_DIR> [-port=<PORT>]

The interface is described in an OpenAPI 3.0 definition (openapi.yaml in the package net.simplace.sim.wrapper.rest of simplace_core).

Web client

Since version 5.3 a solution can be run in the browser: choose a solution (single run, project table, sensitivity analysis or existing project), follow progress and log, look at the CSV outputs as diagrams and download them. The page also works on phones. Try it online with three example solutions.

simplace web -workdir=<WORK_DIR> -outputdir=<OUTPUT_DIR> [-port=<PORT>] [-config=<PROPERTIES_FILE>]

The web client is protected by a login (user and password in a properties file). It is also available as a Docker container that builds SIMPLACE from the public repositories (directory docker-web in the lapclient repository):

cp web.properties.example web.properties   # set web.user and web.password
docker compose up --build -d                # then open http://localhost:7080/

Java

Java programs use the engine directly through SimplaceWrapper in simplace_core – see For software developers and the JavaDoc.