Firmware Setup

The following assumes that you have already read Initial Setup guide. The guides are only written for Linux/WSL. If you have a mac, you may need to ask a lead for a separate setup.

Pre-requisites

You have git installed and configured
You have WSL setup
If using WSL, you are working from a directory in the WSL home directory, not a directory that contains /mnt/ in it’s filename

Getting Setup

Run the following command in a directory of your choice to clone the repository:

# if you are using https (common)
git clone https://github.com/UWOrbital/orbital-software.git

# or if you are using SSH
git clone git@github.com:UWOrbital/orbital-software.git

Install our required tools:

sudo apt update
sudo apt install -y build-essential gcc-multilib g++-multilib cmake curl

Install Python 3.11+. If you are using Ubuntu 24.04 LTS or later, or installed the default WSL distribution, you should already have a compatible version of Python installed.
Terminal window
```
sudo apt install python3
```
Check your installed Python version with:
Terminal window
```
python3 --version
```
If it’s 3.11 or higher, you’re good.
Install the Python virtual environment:
Terminal window
```
sudo apt install python3-venv
```
Setup your virtual environment by running the following commands in the repository’s root directory (the orbital-software folder):
Terminal window
```
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install -e .
```
Setup the pre-commit by running the following command in the repository’s root directory:
Terminal window
```
pre-commit install
```