Installing Github Repository

While we don't have binaries available for download, our application can be accessed through our open source Github repository (https://github.com/TUL-Dev/QuantUS). Below are building instructions to support application building on all major operating systems. For troubleshooting or further assistance getting started, reach out to us through our "Contact" page.

Before continuing, make sure you have Python3.9 installed on your computer. For the most up-to-date installation instructions and supported version, find the latest release in our releases page.
‍

Mac/Linux

Build

Currently, the only way to download our software is by downloading the source code from Github. Once package installers are created for each machine, this page will be updated.

To install the source code on Mac and Linux machines, first pull our software repository:

git clone https://github.com/TUL-Dev/QuantUS

Next, make sure you have the "virtualenv" package installed in Python3.9. From there, proceed to create a Python virtual environment as follows:

cd QuantUS
python3.9 -m pip install virtualenv
virtualenv --python="python3.9" venv

Next, activate the Python virtual environment and install all dependencies of our software:

source venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt

Finally, while still in the virtual environment, convert our GUI files into Python and our software will be ready to run:

chmod +x
./saveQt.sh

When you're finished using the software, make sure to deactivate your Python virtual environment with the "deactivate" command.

Run

To run our software, make sure that the Python virtual environment is running. This virtual environment is started using the `source venv/bin/activate`command. If so, our software can be started using the following simple command:

python main.py

Windows