Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Installing

Jump to bottom
Mitchell D Scott edited this page Dec 9, 2021 · 10 revisions

This workspace is designed to be used in an Ubuntu18 environment. The guides to setup Ubuntu on you PC/Laptop have been omitted because there are plenty of sufficient ones online. As well there are many different cases for installing Ubuntu: dual boot will share your drive with your existing OS, full install will overwrite your existing OS. The instructions will also be different depending on your machines existing OS and hardware.

Caution: Installing a new OS can result in erasing data that you did not mean to erase, be careful what guide you follow and ask returning team members for assistance if you feel unsure of anything.

Once you have Ubuntu18 installed follow the steps below to install the workspace:

Its best to clone the repo in your home directory. You can get to you home directory like so:

cd

Or using the HOME environment variable:

cd $HOME

Or by using an absolute path:

cd /home/<USERNAME>

Now make sure git is installed:

sudo apt update
sudo apt install git

clone the github repo:

git clone git@github.com:CU-Robotics/buff-code.git

If you don't have ssh keys setup use the https address:

git clone https://github.com/CU-Robotics/buff-code.git

Now we will run a bash script to load our environment variable. This will set things like your PATH, PYTHONPATH and ROS_PACKAGE_PATH.

source buff.bash

Next you can run the install from the root of the project. The install is another bash script:

source scripts/install.bash

the install has a bug that may require this additional command

sudo apt install --reinstall ros-melodic-desktop-full

This script will need to run for awhile because there is a lot of things to install. Try to watch the console for any errors that might pop up. It is much harder to catch errors later than if you see it during the install.

The script is fairly straight forward so long as you understand apt (Ubuntu's package manager) pip (pythons package manager) and CURL.

The script starts by updating apt and installing the dependencies from config/install/dependencies.txt. You might notice some dependencies for other operating systems, this is not totally supported (but might be in the future).

Next the script will install all the python dependencies from config/install/python3_requirements.txt. It is important that if you project uses a new dependency you add it to the corresponding config file.

The script will then install ROS and it's dependencies, this was taken almost word for word from the ROS tutorials.

Finally the script will install the teensy loader binaries to buffpy/bin (not totally support right now).

To test the install you'll need to resource the buff.bash (setup script) and then you can test buffpy.

source buff.bash
buffpy -h

If buffpy prints out a usage message that means the install worked (for the most part). If there are errors ask a returner if they recognize the issue (they will likely have resolved it before) or you can dive into the install script and try to debug the issue.

Clone this wiki locally