-
Notifications
You must be signed in to change notification settings - Fork 3
Contributing
Wendi Yu edited this page Oct 7, 2020
·
4 revisions
Welcome to Topside! To get started, follow these steps:
- 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
- If you have git configured with SSH, run
- Enter the newly-cloned repo with
cd topside
- Run
pip install wheel
, which will help install the rest of the packages more quickly. - Install Python dependencies with
pip install -r requirements.txt
. If you get a permissions error, trypip install -U -r requirements.txt
instead. - 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 atdist/Topside/Topside.exe
(on Windows).