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.txtafter 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.gitIf 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
First, you will need to install python’s
virtualenvlibrarypip install virtualenv
Then you will need to create a virtual environment
python -m venv [Directory]
Activate the virtual environment
For osx/linux:
source [Directory]/bin/activateFor windows:
[Directory]\Scripts\activate
When you first run through these procedures, you should make sure your pip is up to date, especially is using a Virtual Environment
pip install --upgrade pip
Similarly, you should make sure you have wheel installed (especially if you just created a Virtual Environment)
pip install wheel
Now that you have your environment set up, you can install the dependencies needed to run omnibus
pip install -r requirements.txtIf you get a permissions error, try
pip install --user -r requirements.txtinstead
Afterwards, you can install the omnibus library locally. For links that explain what a local library is, refer to the core library section
pip install -e .Don't forget the
.! This allows the sources and sinks (and you) to import Omnibus.