Contributing

Welcome to Topside! To get started, follow these steps:

1. Clone the repo.
   • If you have git configured with SSH, run git clone git@github.com:waterloo-rocketry/topside.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/topside.git
2. Enter the newly-cloned repo with cd topside
3. Run pip install wheel, which will help install the rest of the packages more quickly.
4. Install Python dependencies with pip install -r requirements.txt. If you get a permissions error, try pip install -U -r requirements.txt instead.
5. Install the Topside library locally with pip install -e .. This will allow you to import Topside from other Python scripts or files.

You should now be ready to start developing!

• To run unit tests: pytest
• To launch the Topside application: python main.py
• To build a standalone application: ./tools/build_pyinstaller.sh. The resulting executable will be at dist/Topside/Topside.exe (on Windows).