Build From Sources

Suggest edits
Documentation > Download

Contents

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 ๐Ÿ”—

Clone the OpenMOLE repository by typing the following in your command shell (prompt $>):

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

Build the OpenMOLE application ๐Ÿ”—

Build from sources ๐Ÿ”—

For the first time
To build the OpenMOLE application for the first time after cloning it, execute the build.sh script inside the openmole directory that you just cloned.

$> cd openmole
$> ./build.sh

Upon successful completion, the executable is placed under 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.
Re-build the project after an update
In order to apply the changes after you updated your openmole version (by doing a git pull of the project for instance), you need to run successively the clean.sh and build.sh scripts.

$> ./clean.sh
$> ./build.sh

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/.