First time setup 🔗

Prerequisites 🔗

You will need the following tools to get a local copy of OpenMOLE running:

• A java 8 (or higher) JDK (N.B. not only the JRE!). Check your version by typing javac -version in a terminal.
• The git software and the LFS extension.
• SBT, the Scala Building Tool.
• npm, library required to build the website.

As a suggestion, we recommend the IntelliJ IDE to edit the Scala source code of the project.

Get the project and set it up 🔗

The following commands are to be typed in your command shell (prompt $> )

1. Clone the OpenMOLE repository:
   
   

   $> git lfs install
   $> git lfs clone git@github.com:openmole/openmole.git
   

2. Publish locally the content of the build-system and libraries subdirectories:
   
   

   $> cd openmole/build-system
   $> sbt publishLocal
   $> cd ../libraries/
   $> sbt publishLocal
   

These commands may take some time to execute (a few minutes at least).

Build the OpenMOLE application 🔗

Build from sources 🔗

To build the OpenMOLE application, use the sbt assemble command inside the openmole subdirectory.

$> cd openmole
$> sbt
# following commands occur inside sbt prompt
sbt:openmole-root> project openmole
openmole> assemble

Upon completion, the executable is placed under /openmole/openmole/bin/openmole/target/assemble and is launched as any executable via the ./openmole command. The app should then pop up in your default web browser, the URL should be something like http://localhost:44961/app.

Create a standalone archive 🔗

You can create a standalone archive of your fresh OpenMOLE build and ship it around by using sbt openmole:tar. You will find the resulting archive in bin/openmole/target/openmole.tar.gz.

Publish the bundles

$> cd build-system
$> sbt publish
$> cd ../libraries
$> sbt publish
$> cd ../openmole
$> sbt publish

Compile within Docker 🔗

An easy way to get an OpenMOLE compilation environment up and running is to use docker. Once docker is installed on your machine you can do:

$> git clone https://github.com/openmole/docker-build.git
$> cd docker-build
$> ./run -v /a/local/path/on/your/system
# You should be in the docker container now, execute
clone
compile

You can now find the compiled OpenMOLE app in /a/local/path/on/your/system/openmole/openmole/bin/openmole/target/assemble/.