This is largely stolen from the GitHub Readme
Requirements
Python version 3.8 or newer
For Linux users, a python package with C headers (such as
python3-dev
) is necessaryAll required packages can be installed using
pip install -r requirements.txt
after the repo is cloned (refer to next section)
Git
Refer to out Git tutorial for everything you need to know about this [Yet to be written]
Note, these instructions also assume an understanding of how to use a command line, which should also be covered in the Git Documentation
Instillation
The Omnibus library is required to run any of the sources or sinks. To install it:
Clone the Omnibus GitHub Repo
If you have git configured with SSH, run
git clone git@github.com:waterloo-rocketry/omnibus.git
If you don't have git configured with SSH (or you're not sure what that means), run
git clone https://github.com/waterloo-rocketry/omnibus.git
Enter the newly cloned Repo
cd omnibus
Optional, but highly recommend, create a Python Virtual Environment