From 31f393f2a84a71992563dc565fedf0aa187e4a44 Mon Sep 17 00:00:00 2001 From: Stephen Skeirik Date: Wed, 11 Mar 2020 17:51:10 -0500 Subject: [PATCH] update install docs --- INSTALL.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index 00febc9..25552b7 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,4 +1,4 @@ -# Installing ROSRV +# ROSRV Manual Installation Here are instructions for installing and building ROSRV by checking out its source code on GitHub. @@ -42,3 +42,57 @@ via catkin as `catkin run rvmonitor `. See [docs/Usage.md](docs/Usage.md) for further information on how to run ROSRV. Get help or report problems on [ROSRV's issues page](https://github.com/FormalSystemsLaboratory/ROSRV/issues). + +# ROSRV Guided Installation + +These instructions will take you from a fresh box to a working ROSRV installation. +For maximum portability, installing a fresh machine/VM is recommended. + +0. Find an Ubuntu 16.04 box or spin up a new Ubuntu 16.04 machine/VM. + All other steps occur on this machine/VM and assume the default shell is bash. + +1. Setup ROS PPA + +``` +sudo sh -c '. /etc/lsb-release && echo "deb http://mirror.umd.edu/packages.ros.org/ros/ubuntu $DISTRIB_CODENAME main" > /etc/apt/sources.list.d/ros-latest.list' +sudo apt-key adv --keyserver 'hkp://keyserver.ubuntu.com:80' --recv-key C1CF6E31E6BADE8868B172B4F42ED6FBAB17C654 +sudo apt-get update +``` + +2. Install ROS package and RV-Monitor and ROSRV dependencies + +``` +sudo apt install ros-kinetic-desktop-full +sudo apt install default-jdk-headless clang-6.0 maven python3-pip python3-yaml ros-kinetic-marti-common-msgs +``` + +3. Initialize ROS with this magic + +``` +sudo rosdep init +rosdep update +echo "source /opt/ros/kinetic/setup.bash" >> ~/.bashrc +source ~/.bashrc +``` + +4. Install pytest via pip3 + +``` +pip3 install pytest +``` + +5. Install RVMonitor on the darpa branch and setup environment variable + +``` +git clone -b darpa https://github.com/runtimeverification/rv-monitor +( cd rv-monitor; mvn install -DskipTests; ) +echo "export RVMONITOR=\"$(pwd)/rv-monitor\"" >> $HOME/.bashrc +``` + +6. Get ROSRV master and run the tests (minus the DDL tests) + +``` +git clone https://github.com/Formal-Systems-Laboratory/ROSRV +cd ROSRV +PYTEST_FLAGS="--skip-dl-tests" ./Test +```