No description, website, or topics provided.
Web Ontology Language Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
deploy
documentation Changed doxygen version number Jul 18, 2016
setup
utilities
LICENSE
README.md

README.md

Documentation about the RAPP Scripts: Wiki Page

The rapp_scripts folder contains scripts necessary for operations related to the RAPP Platform. The scripts are divided into four folders:

deploy

There are two files aimed for deployment:

  • deploy_rapp_ros.sh: Deploys the RAPP Platform back-end, i.e. all the ROS nodes
  • deploy_web_services.sh: Deploys the corresponding HOP services

If you want to deploy the RAPP Platform in the background you can use screen. Just follow the next steps:

  • screen -S rapp_ros
  • ./deploy_rapp_ros.sh
  • Press Ctrl + a + d to detach
  • screen -S rapp_web
  • ./deploy_web_services
  • Press Ctrl + a + d to detach
  • screen -ls to check that 2 screen sessions exist

Alternatively:

  • screen -d -m -S rapp_ros /path/to/deploy_rapp_ros.sh
  • screen -d -m -S rapp_web /path/to/deploy_web_services.sh

To reattach to screen session, i.e. rapp_ros:

screen -r rapp_ros

The screen step is for running rapp_ros and web_services on detached terminals which is useful, for example in the case where you want to connect via ssh to a remote computer, launch the processes and keep them running even after closing the connection. Alternatively, you can open two terminals and run one script on each, without including the screen commands. It is imperative for the terminals to remain open for the processes to remain active.

Deploy RAPP at boot

  • Create a script to deploy rapp, for example /home/user/deploy_rapp.sh:
#! /bin/bash -i
screen -d -m -S rapp_ros /path/to/deploy_rapp_ros.sh
screen -d -m -S rapp_web /path/to/deploy_web_services.sh
  • Edit /etc/rc.local to deploy the script as user at startup. Add the following line before the exit command:
su user -c '/bin/bash -i /home/user/deploy_rapp.sh'

Screen how-to: http://www.rackaid.com/blog/linux-screen-tutorial-and-how-to/

setup

These scripts can be executed after a clean Ubuntu 14.04 installation, in order to install the appropriate packages and setup the environment.

NOTE: Output is disabled by default. In order to enable the setup scripts output the RAPP_SILENT environmental variable must be set. Execute:

export RAPP_SILENT=1

To remove the variable execute:

unset RAPP_SILENT

Step 0 - Get the scripts

You can get the setup scripts either by downloading the rapp-platform-scripts repository in a zip format, or by cloning it in your PC using git:

git clone https://github.com/rapp-project/rapp-platform-scripts.git

WARNING: At least 10 GB's of free space are recommended.

Install RAPP Platform

It is advised to execute the clean_install.sh script in a clean VM or clean system.

Performs:

  • initial system updates
  • installs ROS Indigo
  • downloads all Github repositories needed
  • builds and install all repos (rapp_platform, knowrob, rosjava)
  • downloads builds and installs depending libraries for Sphinx4
  • installs MySQL
  • installs HOP

What you must do manually

A new MySQL user was created with username = dummyUser and password = changeMe and was granted all on RappStore DB. It is highly recommended that you change the password and the username of the user. The username and password are stored in the file located at /etc/db_credentials. The file db_credentials is used by the RAPP platform services, be sure to update it with the correct username and password. It's first line is the username and it's second line the password.

Setup in an existing system

If you want to add rapp-platform to an already existent system (Ubuntu 14.04) you should choose which setup scripts you need to execute. For example if you have MySQL install you do not need to execute 8_mysql_install.sh.

Scripts

  • 1_system_updates.sh: Fetches the Ubuntu 14.04 updates and installs them
  • 2_ros_setup.sh: Installs ROS Indigo
  • 3_auxiliary_packages_setup.sh: Installs software from apt-get, necessary for the correct RAPP Platform deployment
  • 4_rosjava_setup.sh: Fetches a number of GitHub repositories and compiles rosjava. This is a dependency of Knowrob.
  • 5_knowrob_setup.sh: Fetches the Knowrob repository and builds it. Knowrob is the tool that deploys the RAPP ontology.
  • 6_rapp_platform_setup.sh: Fetches the rapp-platform and rapp-api repositories and builds them. This script has an input argument which is the git branch the rapp-platform will be checked out. If you decide to execute this script manually it is recommended to give master as input.
  • 7_sphinx_libraries.sh: Fetches the Sphinx4 necessary libraries, compiles them and installs them, Sphinx4 is used for ASR (Automatic Speech Recognition).
  • 8_mysql_install.sh: Installs MySQL
  • 9_create_rapp_mysql_db.sh: Adds the RAPP MySQL empty database in mysql
  • 10_create_rapp_mysql_user.sh: Creates a user to enable access the to database from the RAPP Platform code
  • 11_hop_setup.sh: Installs HOP and Bigloo, the tools providing the RAPP Platform generic services.
  • 12_caffe_setup.sh: Installs Caffe.
  • 13_authentication_setup.sh: Installs authentication related information.
NOTES:

The following notes concern the manual setup of rapp-platform (not the clean setup form our scripts):

documentation

Scripts to automatically create documentation from the RAPP Platform code, the services and this wiki, using Doxygen. All documents can be bound in ${HOME}/rapp_platform_files/documentation.

  • create_source_documentation.sh : Creates the platform's source code documentation (cpp, h, py, java).
  • create_wiki_documentation.sh : Creates the platform's GitHub Wiki documentation.
  • create_test_documentation.py : Creates the platform's test source code documentation.
  • create_web_services_documentation.sh : Creates the rapp_web_services documentation.
  • create_documentation.sh : Creates all aforementioned documentations.
  • update_rapp-project.github.io.sh : Creates the documentation and pushes it in the gh-pages branch of rapp-platform, in order to update the online pages. NOTE: This is functional only when executed in the Travis environment, so do not try to run it!

utillities

The following scripts are offered:

  • dumpRAPPMysqlDatabase.sh: Dumps the RAPP MySQL database in a .sql file
  • importRAPPMysqlDatabase.sh: Imports the RAPP MySQL database from a .sql file
  • dumpRAPPOntology.sh: Dumps the RAPP ontology in an .owl file
  • importRAPPOntology.sh: Imports the RAPP ontology from an .owl file
  • create_rapp_user.sh: Create and authenticate a new RAPP User.