This page describes how to setup the full Simonstrator Platform for the development and simulative evluation of overlays and services. We assume that you already created an account at our GitLab instance. We also assume that you have an up-to-date installation of eclipse available, with support for Java and Maven enabled.
All repositories contain ready-to-use eclipse projects. Eclipse will take care of resolving Maven dependencies either locally (if you cloned the respective project from source) or by downloading a public version from our build server. Although we love Windows for all our Powerpoint-related needs, we highly encourage the use of a Linux-based system for development. This documentation lists all required steps and commands for Linux – steps on Windows PCs might differ slightly.
To browse and clone the overlay project, you first need to request access to the @simonstrator group when logged in to GitLab.
Usually, you will only alter code in the overlays- and the simrunner-project. The respective API version and PeerfactSim.KOM will then be fetched via Maven.
Clone git repositories
Start by cloning the remote repositories for both projects into your eclipse workspace. In this example, we fetch release 3.0 as our starting point, but you can start your work directly on the current master (SNAPSHOT).
# navigate to root folder of your eclipse workspace cd path-to-your-eclipse-workspace/ # clone via SSH, assuming keys are installed git clone email@example.com:simonstrator/simonstrator-api.git -b releases/v3.0 git clone firstname.lastname@example.org:simonstrator/simonstrator-overlays.git -b releases/v3.0 # OR clone via https (provide gitlab username and password) git clone https://dev.kom.e-technik.tu-darmstadt.de/gitlab/simonstrator/simonstrator-api.git -b releases/v3.0 git clone https://dev.kom.e-technik.tu-darmstadt.de/gitlab/simonstrator/simonstrator-overlays.git -b releases/v3.0
Import to Eclipse
Next, you need to import the projects into your eclipse IDE. Start by switching to the git perspective.
Now, click add an existing local git repository:
Select both repositories and finish the dialog. The repositories will show up in the list of local repositories within eclipse. Now, simply right-click on the simonstrator-api repository and select Import Projects. Ensure that import existing eclipse projects is selected and confirm with next and finish. Repeat the step for the simonstrator-overlays project.
Now, switch back to the Java perspective and you should see both projects. Wait for them to finish compilation.
In some cases, the build process might fail due to unresolved Maven dependencies. Most of the time, executing Project > Clean… resolves the issue.
Execute the GuiRunner
To test your project setup, execute the
GUIRunner located within the package
de.tudarmstadt.maki.simonstrator.peerfact by right-clicking on the file in the Package Explorer and selecting Run As > Java Application.
If everything is set up correctly, you will be greeted with the configuration selection window.
That’s it – now you can start implementing your own distributed system in the overlays-project and add the respective workload generators for its evaluation within the simrunner project. If you plan to extend PeerfactSim.KOM or the Simonstrator-API, you can simply clone both projects by following the same steps as detailed above.