Skip to content

Install SSS on Mac or Linux

Checking Dependencies

To install the SSS on your Mac or Linux device, you will need some certain dependencies. You can get them from your package manager by doing the following

This project only uses python3. Check to see if you are using python3 by: 

python -V
If your system has multiple versions of python installed, you can force v3 by replacing all python and pip commands with python3 and pip3.

For Mac

Make sure that you have homebrew installed and then run the following: 

curl https://bootstrap.pypa.io/get-pip.py | python && brew install git virtualenv

For Linux

If you are using Ubuntu or any other Debian based Linux distro with the apt package manager: 

sudo apt install git python3-virtualenv
If you are using RedHat or any of its variants that uses dnf: 
sudo dnf install git python-virtualenv

Setting up SSS

Once you have all the dependencies for your system installed, you can now move onto downloading and setting up the SSS on your system. The following steps should be system-agnostic.

First we'll get the code from GitHub by cloning the repository:

git clone https://github.com/NET-BYU/sss.git

Now we'll move into the folder and make sure our virtual environment is set up:

cd sss                      # Change to SSS project directory
virtualenv venv             # Create a python virtual environment called venv
source venv/bin/activate    # Activate the venv environment
You can now verify that you are inside a virtual environment by echoing out the VIRTUAL_ENV variable

echo $VIRTUAL_ENV
If the VIRTUAL_ENV is set (i.e. you get output from the previous command like /home/christopolise/dev/sss/venv), this indicates that you are inside your new Python virtual environment.

Most shells will visually indicate that you are inside of a virtual environment by changing the prompt. For example, you are using bash, your prompt change from user@computer1$ to (venv) user@computer1$. You should notice the prompt of your terminal change to indicate that you are now in your newly created python virtual environment. All of the following steps assume you are within this environment. If you are not, you will install all SSS dependencies system-wide which may conflict with some previous configurations.

Then you will need to install all the python requirements for the SSS:

python3 -m pip install -r requirements.txt

And that's it! Once this has successfully completed, you are ready to run the simulator and start developing for the SSS! For more information, go to Get Started.

Last update: August 25, 2023
Created: June 2, 2022