diff --git a/install/dfall_install_git_clone_and_catkin_make.sh b/install/dfall_install_git_clone_and_catkin_make.sh index 58c5aa22d8a776242e17eb85ec714fe2fa5358ef..594ccf93e05db8803f4488a20817ff667a096c03 100644 --- a/install/dfall_install_git_clone_and_catkin_make.sh +++ b/install/dfall_install_git_clone_and_catkin_make.sh @@ -1,18 +1,18 @@ # --------------------------------------------------------------- # -# CLONE THE D-FaLL-System REPOSITORY +# CLONE THE dfall-system REPOSITORY -# Make the "work" directory under the users root +# Make the "dfall" directory under the users root # > Note: the -p option means: no error if existing, make parent directories as needed -mkdir -p ~/work +mkdir -p ~/dfall # Change directory to this folder -cd ~/work +cd ~/dfall # Install git sudo apt -y install git -# Clone the D-FaLL-System git repository -git clone https://gitlab.ethz.ch/D-FaLL/PandS-System/D-FaLL-System.git +# Clone the dfall-system git repository +git clone https://gitlab.ethz.ch/dfall/dfall-system.git @@ -31,33 +31,57 @@ sudo sh -c "echo $1 >> /etc/dfall_default_agent_id" sudo sh -c "echo 1 >> /etc/dfall_default_coord_id" # Copy rules necessary for using the Crazyradio -sudo cp ~/work/D-FaLL-System/install/99-crazyflie.rules /etc/udev/rules.d -sudo cp ~/work/D-FaLL-System/install/99-crazyradio.rules /etc/udev/rules.d +sudo cp ~/dfall/dfall-system/install/99-crazyflie.rules /etc/udev/rules.d +sudo cp ~/dfall/dfall-system/install/99-crazyradio.rules /etc/udev/rules.d # --------------------------------------------------------------- # -# BUILD THE D-FaLL-System ROS PACKAGE +# BUILD THE dfall-system ROS PACKAGE # > NOTE: This is done by calling "catkin_make" from the folder "dfall_ws", # where "ws" stands for workspace # > NOTE: the package that is built is named "dfall_pkg", as specified in the file # .../dfall_ws/src/dfall_pkg/package.xml # > NOTE: the -j4 option specifies the: Maximum number of build jobs to be # distributed across active packages. (default is cpu count) -cd ~/work/D-FaLL-System/dfall_ws +cd ~/dfall/dfall-system/dfall_ws catkin_make # --------------------------------------------------------------- # -# ADD TO THE .bashrc THE D-FaLL-System CONFIG AND ROS PACKAGE SETUP +# ADD TO THE .bashrc THE dfall-system CONFIG AND ROS PACKAGE SETUP -# Add the D-FaLL ROS Package setup to the .bashrc -echo "source ~/work/D-FaLL-System/dfall_ws/devel/setup.bash" >> ~/.bashrc +# Add a heading for the addition to the .bashrc +echo "# ADDED AS PART OF THE dfall-system INSTALLATION" >> ~/.bashrc + +# Add an evironment variable that point to the dfall-system Repository +echo "# Environment variable for the home directory" >> ~/.bashrc +echo "export DFALL_HOME=\"/home/$USER/dfall/dfall-system\"" >> ~/.bashrc +# And set the environment variable for this terminal session +export DFALL_HOME="/home/$USER/dfall/dfall-system" + +# Add the ROS environment setup to the .bashrc +echo "# Source the ROS setup" >> ~/.bashrc +echo "source /opt/ros/melodic/setup.bash" >> ~/.bashrc + +# Add the dfall ROS Package setup to the .bashrc +echo "# Source the dfall package setup" >> ~/.bashrc +echo "# > Note that the \"devel\" folder is created as part of running \"catkin_make\"" >> ~/.bashrc +echo "source ~/dfall/dfall-system/dfall_ws/devel/setup.bash" >> ~/.bashrc # And run it now so that it is valid for this terminal session -source ~/work/D-FaLL-System/dfall_ws/devel/setup.bash +source ~/dfall/dfall-system/dfall_ws/devel/setup.bash # Add the "Config.sh" shell script to the .bashrc -echo "source ~/work/D-FaLL-System/dfall_ws/src/dfall_pkg/launch/Config.sh" >> ~/.bashrc +echo "# Source the dfall config shell script" >> ~/.bashrc +echo "source ~/dfall/dfall-system/dfall_ws/src/dfall_pkg/launch/Config.sh" >> ~/.bashrc +# And run it now so that it is valid for this terminal session +source ~/dfall/dfall-system/dfall_ws/src/dfall_pkg/launch/Config.sh + +# Add an alias for changing directory to the dfall-system repository +echo "# Alias for changing directory to the \$DFALL_HOME" >> ~/.bashrc +echo "alias dfall=\"cd $DFALL_HOME\"" >> ~/.bashrc +echo "alias cddfall=\"cd $DFALL_HOME\"" >> ~/.bashrc # And run it now so that it is valid for this terminal session -source ~/work/D-FaLL-System/dfall_ws/src/dfall_pkg/launch/Config.sh +alias dfall="cd $DFALL_HOME" +alias cddfall="cd $DFALL_HOME" diff --git a/install/dfall_install_instructions_for_raspberry_pi.md b/install/dfall_install_instructions_for_raspberry_pi.md index 01e3605d5d3fe9c6c64c9eaa76e4842e277920e0..b7f912539a6c73b5ecf715fc905d0f37595e7609 100644 --- a/install/dfall_install_instructions_for_raspberry_pi.md +++ b/install/dfall_install_instructions_for_raspberry_pi.md @@ -211,7 +211,7 @@ systemctl restart systemd-modules-load.service systemctl status systemd-modules-load.service ``` -Note that even if left un-resolved, this error does not prevent the installation and running of ROS-Melodic and the D-FaLL-System software. +Note that even if left un-resolved, this error does not prevent the installation and running of ROS-Melodic and the dfall-system software. ## CREATING AND ENABLING A SWAP FILE @@ -273,7 +273,7 @@ For example: ```sudo apt-get install lubuntu-desktop``` -Other desktops are available, for example ``xubuntu-desktop`` and ``kubuntu-desktop``, but the D-FaLL-System has only been tested to work with ``lubuntu-desktop``. Note that this can take upto an hour to install. +Other desktops are available, for example ``xubuntu-desktop`` and ``kubuntu-desktop``, but the dfall-system has only been tested to work with ``lubuntu-desktop``. Note that this can take upto an hour to install. @@ -292,7 +292,7 @@ sudo add-apt-repository restricted If any of these were not already added, then run ``sudo apt update`` and ``upgrade``. -## INSTALL THE D-FaLL-System +## INSTALL THE dfall-system Download the appropriate installation script diff --git a/install/dfall_install_ros_kinetic_ubuntu16.sh b/install/dfall_install_ros_kinetic_ubuntu16.sh index 1822a0ec9d97dec3cc605b3830940ae27b10263e..ecc29b27d6d6c3eb171583dc233414b231105eeb 100755 --- a/install/dfall_install_ros_kinetic_ubuntu16.sh +++ b/install/dfall_install_ros_kinetic_ubuntu16.sh @@ -96,20 +96,20 @@ sudo apt -y install qtcreator # --------------------------------------------------------------- # -# CLONE THE D-FaLL-System REPOSITORY +# CLONE THE dfall-system REPOSITORY -# Make the "work" directory under the users root +# Make the "dfall" directory under the users root # > Note: the -p option means: no error if existing, make parent directories as needed -mkdir -p ~/work +mkdir -p ~/dfall # Change directory to this folder -cd ~/work +cd ~/dfall # Install git sudo apt -y install git -# Clone the D-FaLL-System git repository -git clone https://gitlab.ethz.ch/D-FaLL/PandS-System/D-FaLL-System.git +# Clone the dfall-system git repository +git clone https://gitlab.ethz.ch/dfall/dfall-system.git @@ -128,54 +128,54 @@ sudo sh -c "echo $1 >> /etc/dfall_default_agent_id" sudo sh -c "echo 1 >> /etc/dfall_default_coord_id" # Copy rules necessary for using the Crazyradio -sudo cp ~/work/D-FaLL-System/install/99-crazyflie.rules /etc/udev/rules.d -sudo cp ~/work/D-FaLL-System/install/99-crazyradio.rules /etc/udev/rules.d +sudo cp ~/dfall/dfall-system/install/99-crazyflie.rules /etc/udev/rules.d +sudo cp ~/dfall/dfall-system/install/99-crazyradio.rules /etc/udev/rules.d # --------------------------------------------------------------- # -# BUILD THE D-FaLL-System ROS PACKAGE +# BUILD THE dfall-system ROS PACKAGE # > NOTE: This is done by calling "catkin_make" from the folder "dfall_ws", # where "ws" stands for workspace # > NOTE: the package that is built is named "dfall_pkg", as specified in the file # .../dfall_ws/src/dfall_pkg/package.xml # > NOTE: the -j4 option specifies the: Maximum number of build jobs to be # distributed across active packages. (default is cpu count) -cd ~/work/D-FaLL-System/dfall_ws +cd ~/dfall/dfall-system/dfall_ws catkin_make -j4 # --------------------------------------------------------------- # -# ADD TO THE .bashrc THE D-FaLL-System CONFIG AND ROS PACKAGE SETUP +# ADD TO THE .bashrc THE dfall-system CONFIG AND ROS PACKAGE SETUP # Add a heading for the addition to the .bashrc -echo "# ADDED AS PART OF THE D-FaLL-System INSTALLATION" >> ~/.bashrc +echo "# ADDED AS PART OF THE dfall-system INSTALLATION" >> ~/.bashrc -# Add an evironment variable that point to the D-FaLL-System Repository +# Add an evironment variable that point to the dfall-system repository echo "# Environment variable for the home directory" >> ~/.bashrc -echo "export DFALL_HOME=\"/home/$USER/work/D-FaLL-System\"" >> ~/.bashrc +echo "export DFALL_HOME=\"/home/$USER/dfall/dfall-system\"" >> ~/.bashrc # And set the environment variable for this terminal session -export DFALL_HOME="/home/$USER/work/D-FaLL-System" +export DFALL_HOME="/home/$USER/dfall/dfall-system" # Add the ROS environment setup to the .bashrc echo "# Source the ROS setup" >> ~/.bashrc echo "source /opt/ros/melodic/setup.bash" >> ~/.bashrc -# Add the D-FaLL ROS Package setup to the .bashrc -echo "# Source the D-FaLL package setup" >> ~/.bashrc +# Add the dfall ROS Package setup to the .bashrc +echo "# Source the dfall package setup" >> ~/.bashrc echo "# > Note that the \"devel\" folder is created as part of running \"catkin_make\"" >> ~/.bashrc -echo "source ~/work/D-FaLL-System/dfall_ws/devel/setup.bash" >> ~/.bashrc +echo "source ~/dfall/dfall-system/dfall_ws/devel/setup.bash" >> ~/.bashrc # And run it now so that it is valid for this terminal session -source ~/work/D-FaLL-System/dfall_ws/devel/setup.bash +source ~/dfall/dfall-system/dfall_ws/devel/setup.bash # Add the "Config.sh" shell script to the .bashrc -echo "# Source the D-FaLL config shell script" >> ~/.bashrc -echo "source ~/work/D-FaLL-System/dfall_ws/src/dfall_pkg/launch/Config.sh" >> ~/.bashrc +echo "# Source the dfall config shell script" >> ~/.bashrc +echo "source ~/dfall/dfall-system/dfall_ws/src/dfall_pkg/launch/Config.sh" >> ~/.bashrc # And run it now so that it is valid for this terminal session -source ~/work/D-FaLL-System/dfall_ws/src/dfall_pkg/launch/Config.sh +source ~/dfall/dfall-system/dfall_ws/src/dfall_pkg/launch/Config.sh -# Add an alias for changing directory to the D-FaLL-System repository +# Add an alias for changing directory to the dfall-system repository echo "# Alias for changing directory to the \$DFALL_HOME" >> ~/.bashrc echo "alias dfall=\"cd $DFALL_HOME\"" >> ~/.bashrc echo "alias cddfall=\"cd $DFALL_HOME\"" >> ~/.bashrc diff --git a/install/dfall_install_ros_melodic_ubuntu18.sh b/install/dfall_install_ros_melodic_ubuntu18.sh index 1dd32f5e791cd797b0660dccab0f645d3000d817..abcfc1df324d9a27f7d4a1f88f735e281abf5f65 100755 --- a/install/dfall_install_ros_melodic_ubuntu18.sh +++ b/install/dfall_install_ros_melodic_ubuntu18.sh @@ -96,20 +96,20 @@ sudo apt -y install qtcreator # --------------------------------------------------------------- # -# CLONE THE D-FaLL-System REPOSITORY +# CLONE THE dfall-system REPOSITORY -# Make the "work" directory under the users root +# Make the "dfall" directory under the users root # > Note: the -p option means: no error if existing, make parent directories as needed -mkdir -p ~/work +mkdir -p ~/dfall # Change directory to this folder -cd ~/work +cd ~/dfall # Install git sudo apt -y install git -# Clone the D-FaLL-System git repository -git clone https://gitlab.ethz.ch/D-FaLL/PandS-System/D-FaLL-System.git +# Clone the dfall-system git repository +git clone https://gitlab.ethz.ch/dfall/dfall-system.git @@ -128,54 +128,54 @@ sudo sh -c "echo $1 >> /etc/dfall_default_agent_id" sudo sh -c "echo 1 >> /etc/dfall_default_coord_id" # Copy rules necessary for using the Crazyradio -sudo cp ~/work/D-FaLL-System/install/99-crazyflie.rules /etc/udev/rules.d -sudo cp ~/work/D-FaLL-System/install/99-crazyradio.rules /etc/udev/rules.d +sudo cp ~/dfall/dfall-system/install/99-crazyflie.rules /etc/udev/rules.d +sudo cp ~/dfall/dfall-system/install/99-crazyradio.rules /etc/udev/rules.d # --------------------------------------------------------------- # -# BUILD THE D-FaLL-System ROS PACKAGE +# BUILD THE dfall-system ROS PACKAGE # > NOTE: This is done by calling "catkin_make" from the folder "dfall_ws", # where "ws" stands for workspace # > NOTE: the package that is built is named "dfall_pkg", as specified in the file # .../dfall_ws/src/dfall_pkg/package.xml # > NOTE: the -j4 option specifies the: Maximum number of build jobs to be # distributed across active packages. (default is cpu count) -cd ~/work/D-FaLL-System/dfall_ws +cd ~/dfall/dfall-system/dfall_ws catkin_make -j4 # --------------------------------------------------------------- # -# ADD TO THE .bashrc THE D-FaLL-System CONFIG AND ROS PACKAGE SETUP +# ADD TO THE .bashrc THE dfall-system CONFIG AND ROS PACKAGE SETUP # Add a heading for the addition to the .bashrc -echo "# ADDED AS PART OF THE D-FaLL-System INSTALLATION" >> ~/.bashrc +echo "# ADDED AS PART OF THE dfall-system INSTALLATION" >> ~/.bashrc -# Add an evironment variable that point to the D-FaLL-System Repository +# Add an evironment variable that point to the dfall-system Repository echo "# Environment variable for the home directory" >> ~/.bashrc -echo "export DFALL_HOME=\"/home/$USER/work/D-FaLL-System\"" >> ~/.bashrc +echo "export DFALL_HOME=\"/home/$USER/dfall/dfall-system\"" >> ~/.bashrc # And set the environment variable for this terminal session -export DFALL_HOME="/home/$USER/work/D-FaLL-System" +export DFALL_HOME="/home/$USER/dfall/dfall-system" # Add the ROS environment setup to the .bashrc echo "# Source the ROS setup" >> ~/.bashrc echo "source /opt/ros/melodic/setup.bash" >> ~/.bashrc -# Add the D-FaLL ROS Package setup to the .bashrc -echo "# Source the D-FaLL package setup" >> ~/.bashrc +# Add the dfall ROS Package setup to the .bashrc +echo "# Source the dfall package setup" >> ~/.bashrc echo "# > Note that the \"devel\" folder is created as part of running \"catkin_make\"" >> ~/.bashrc -echo "source ~/work/D-FaLL-System/dfall_ws/devel/setup.bash" >> ~/.bashrc +echo "source ~/dfall/dfall-system/dfall_ws/devel/setup.bash" >> ~/.bashrc # And run it now so that it is valid for this terminal session -source ~/work/D-FaLL-System/dfall_ws/devel/setup.bash +source ~/dfall/dfall-system/dfall_ws/devel/setup.bash # Add the "Config.sh" shell script to the .bashrc -echo "# Source the D-FaLL config shell script" >> ~/.bashrc -echo "source ~/work/D-FaLL-System/dfall_ws/src/dfall_pkg/launch/Config.sh" >> ~/.bashrc +echo "# Source the dfall config shell script" >> ~/.bashrc +echo "source ~/dfall/dfall-system/dfall_ws/src/dfall_pkg/launch/Config.sh" >> ~/.bashrc # And run it now so that it is valid for this terminal session -source ~/work/D-FaLL-System/dfall_ws/src/dfall_pkg/launch/Config.sh +source ~/dfall/dfall-system/dfall_ws/src/dfall_pkg/launch/Config.sh -# Add an alias for changing directory to the D-FaLL-System repository +# Add an alias for changing directory to the dfall-system repository echo "# Alias for changing directory to the \$DFALL_HOME" >> ~/.bashrc echo "alias dfall=\"cd $DFALL_HOME\"" >> ~/.bashrc echo "alias cddfall=\"cd $DFALL_HOME\"" >> ~/.bashrc diff --git a/wiki/installation.md b/wiki/installation.md index 6031a12bc4b85f0392b798e2adb4259e227fb428..4d5c8d9db5a2b578cd71df1deb49b52f9553d86d 100644 --- a/wiki/installation.md +++ b/wiki/installation.md @@ -3,12 +3,12 @@ ## For Student and Teacher ### Install Script -Installation with the install script is the easiest. You will need only the install script from this repository, located in the ``install`` folder and named ``dfall_install.sh`` +Installation with the install script is the easiest. You will need only the install script from this repository, located in the ``install`` folder and named ``dfall_install_ros_<version>_ubuntu<version>.sh`` where you chose the version that matches your desired installation. -To run the installation, using terminal change directory to the folder containing ``dfall_install.sh`` and call it with +To run the installation, using terminal change directory to the folder containing ``dfall_install_ros_<version>_ubuntu<version>.sh`` and call it with ``` -./dfall_install.sh <agent id> +./dfall_install_ros_<version>_ubuntu<version>.sh <agent id> ``` The ``<agent id>`` needs to be a unique number that is used as identication for the agent's laptop. Make sure not that the script file is marked executable and do NOT run the script as root, i.e., do NOT run the script using ``sudo``. The installation script will ask for the password and only execute commands with root privilege when required. @@ -20,18 +20,18 @@ The detailed instructions for the installation of ROS can be found [here](http:/ - Clone this repository: <br /> -Clone this repository into the desired location on your computer, we use the location ``~/work``: +Clone this repository into the desired location on your computer, we use the location ``~/dfall``: ``` -mkdir -p ~/work +mkdir -p ~/dfall ``` ``` -cd ~/work +cd ~/dfall ``` ``` -git clone https://gitlab.ethz.ch/D-FaLL/PandS-System/D-FaLL-System.git +git clone https://gitlab.ethz.ch/dfall/dfall-system.git ``` @@ -39,11 +39,11 @@ git clone https://gitlab.ethz.ch/D-FaLL/PandS-System/D-FaLL-System.git To set up the crazyradio USB dongle just copy the rule files ``99-crazyflie.rules`` and ``99-crazyradio.rules`` from directory ``install`` to the directory ``/etc/udev/rules.d``: ``` -sudo cp ~/work/D-FaLL-System/install/99-crazyflie.rules /etc/udev/rules.d +sudo cp ~/dfall/dfall-system/install/99-crazyflie.rules /etc/udev/rules.d ``` ``` -sudo cp ~/work/D-FaLL-System/install/99-crazyradio.rules /etc/udev/rules.d +sudo cp ~/dfall/dfall-system/install/99-crazyradio.rules /etc/udev/rules.d ``` @@ -81,7 +81,7 @@ sudo sh -c "echo 1 >> /etc/dfall_default_coord_id" - Build the D-FaLL ROS Package: <br /> To do this you need to first change direction to the ``dfall_ws`` directory, where ``ws`` stands for workspace: ``` -cd ~/work/D-FaLL-System/dfall_ws +cd ~/dfall/dfall-system/dfall_ws ``` And then you build the D-FaLL ROS Package using the ``catkin_make`` command: @@ -98,7 +98,7 @@ source <catkin workspace>/devel/setup.bash source <catkin workspace>/src/dfall_pkg/launch/Config.sh ``` -If you follow the steps above, then the ``<catkin workspace>`` should be ``~/work/D-FaLL-System/dfall_ws``. Note that the workspace setup script will only appear after the first compilation of the catkin workspace. +If you follow the steps above, then the ``<catkin workspace>`` should be ``~/dfall/dfall-system/dfall_ws``. Note that the workspace setup script will only appear after the first compilation of the catkin workspace. If you are not sure at any point you can check out the ``dfall_install.sh`` script.