View source for Getting started for Demiurge

This page will list all the necessary steps you should take before starting to work on the Demiurge project.

== Set up your working environment ==

* Activate all resources as described [[What_you_need_to_begin_to_work_in_IRIDIA | on this page]], if you not have done so already.
** '''TODO''' What is most important of these steps?
* Set up your workstation (see [[Workstation_configuration|this page]] for more details)
* Send your [https://www.github.com github] account name to the Demiurge repository administrator (at the moment Ken)
** He will add you to the [https://github.com/demiurge-project demiurge-project organization] so that you can see the private development repositories
** Development rules for the github repositories: '''TODO'''
* Get yourself added to the Demiurge Whatsapp group
* Give your e-mail address to Mauro, he will add you to the Demiurge mailing list
* Install argos ('''TODO''' Instructions)
*# Install all prerequisites (specified at the [https://github.com/ilpincy/argos3 github page])
*#* You can do so by running the following command in your terminal: '''TODO'''
*# Download and install argos
*#* Be aware that we are currently not using the most recent version but instead the release "3.0.0-beta48"
*#* Get the repository:
*#*# <code>git clone git@github.com:ilpincy/argos3.git argos3</code>, clones the repository '''TODO:''' Setting up ssh keys?
*#*# <code>cd argos3</code>
*#*# <code>git checkout 3.0.0-beta48</code>, checks out the version that we are using at the moment
*#* '''If you are on the cluster:''' Change the CMake-version from 2.8.12 to 2.8.8 in the src/CMakeLists.txt file. There are two occurences that need to be replaced.
*#* Prepare the build of argos3
*#*# <code>mkdir build</code>
*#*# <code>cd build</code>
*#*# <code>cmake -DCMAKE_INSTALL_PREFIX=[INSTALL_LOCATION]/argos3-dist -DCMAKE_BUILD_TYPE=Release -DARGOS_INSTALL_LDSOCONF=OFF -DARGOS_DOCUMENTATION=OFF ../src</code>, where the [INSTALL_LOCATION] is the place where you will place all compiled projects (on the cluster /home/[USER_NAME]/)
*#*# <code>make</code>
*#*# <code>make doc</code>, if you have forgotten the -DARGOS_DOCUMENTATION=OFF
*#*# <code>make install</code>
*#* Before you can install our epuck-plugin, you have to remove the default plugin first. In argos3-dist run the following commdands
*#*# <code>rm -rf include/argos3/plugins/robots/e-puck</code>
*#*# <code>rm -rf lib/argos3/lib*epuck*.so</code>

*#* Add the following lines to your .bashrc (or create a separate file and source it from your .bashrc)
*#*# <code>export PKG_CONFIG_PATH=[INSTALL_LOCATION]/argos3-dist/lib/pkgconfig</code>
*#*# <code>export ARGOS_PLUGIN_PATH=[INSTALL_LOCATION]/argos3-dist/lib/argos3</code>
*#*# <code>export LD_LIBRARY_PATH=$ARGOS_PLUGIN_PATH:$LD_LIBRARY_PATH</code>
*#*# <code>export PATH=[INSTALL_LOCATION]/argos3-dist/bin/:$PATH</code>
*# Download and install the e-puck plugin '''TODO'''
*#* Get the repository
*#*# <code>git clone git@github.com:demiurge-project/argos3-epuck.git argos3-epuck</code>
*#*# <code>cd argos3-epuck</code>
*#*# <code>git checkout v48</code>
*#* '''If you are on the cluster:'''
*#*# Open src/plugins/robots/e-puck/CMakeLists.txt and comment the line with <code>include(VisionTools.cmake)</code>
*#*# Open src/cmake/ARGoSBuildChecks.cmake and remove the checks for Lua and Qt/OpenGL
*#* Prepare the build of the epuck-plugin
*#*# <code>mkdir build</code>
*#*# <code>cd build</code>
*#*# <code>cmake -DCMAKE_INSTALL_PREFIX=[INSTALL_LOCATION]/argos3-dist -DCMAKE_BUILD_TYPE=Release ../src</code>, where the [INSTALL_LOCATION] is the same place as for argos3 (on the cluster /home/[USER_NAME]/)
*#*# <code>make</code>
*#*# <code>make install</code>
** If you don't want to install everything by hand [http://iridia.ulb.ac.be/~afranzin/files/scripts/bundle_argos3_epuck.sh this script] might be useful. However you need all prerequisites installed before running the script.
* Install AutoMoDe ('''TODO''' Instructions)
<!--** Problems that I have encountered: Lua.h couldn't be found (solution move lua headers from /usr/include/lua5.x/ to /usr/include/)-->
* If you have to work on the cluster you should follow [http://majorana.ulb.ac.be/wordpress/how-to-install-argos3-on-majorana/ these instructions] to install Argos. AutoMoDe can be installed as on your local computer.
* In order to install irace on the cluster, follow these steps:
*# Download the [https://nextcloud.ananas.space/s/WhQ2yqhmqoaBRdC irace package]
*# Upload the .tar.gz file to your home directory in the cluster
*# Install the R package locally
*#* Run the following command: <code>R CMD INSTALL -l ~/R/x86_64-redhat-linux-gnu-library/2.15/ irace_2.2.tar.gz</code>
*#* Please note that the irace package must be located in ~/R/x86_64-redhat-linux-gnu-library/2.15/irace to be correctly located by R. At the moment it is not possible to put it anywhere else
*#* If you are installing on the new rack, replace the 2.15 in the path by 3.5. This is because we have an updated version of R.
*# Add irace to IRACE_HOME, PATH and R_LIBS path (for example in your [https://en.wikipedia.org/wiki/Bash_%28Unix_shell%29#Startup_scripts .bashrc file] with the following commands)
*#* <code>export R_LIBS_USER=~/R/x86_64-redhat-linux-gnu-library/2.15</code>
*#* <code>export IRACE_HOME=${R_LIBS_USER}/irace</code>
*#* <code>export PATH=${IRACE_HOME}/bin/:${PATH}</code>
*#* <code>export R_LIBS=${R_LIBS_USER}:${R_LIBS}</code>
<!--** Installing new software in the cluster is not always easy. Therefore many modules are not up-to-date and you have to stick to the versions that are used by the cluster. Check before writing your software that you have approximately the same versions as on the cluster or you might encounter some surprises when running your experiments.-->

== Running robot experiments in the arena ==

* A detailed description on running experiments in the Arena can be found [[AutoMoDe_Arena_Experiments | here]]

== Writing your paper ==

* See [[Demiurge_Writing_Papers | this page]] for information on how to write your paper.

== Important paper to read ==

* [http://iridia.ulb.ac.be/~mbiro/paperi/FraBraBru-etal2014si.pdf AutoMoDe Vanilla]
* [http://iridia.ulb.ac.be/~mbiro/paperi/FraBraBru-etal2015si.pdf AutoMoDe Chocolate]
* [http://iridia.ulb.ac.be/IridiaTrSeries/link/IridiaTr2016-004.pdf Irace User Guide]

== Useful pages to bookmark ==

* http://iridia.ulb.ac.be/IridiaTrSeries/: Here all Technical reports will be published
* https://github.com/demiurge-project: The github page for all of our repositories

== People working on the project ==

* '''TODO'''

== Resources depending on your area of expertise ==

* '''TODO'''