Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 1.52 KB

setup.md

File metadata and controls

56 lines (34 loc) · 1.52 KB

Setup

The GSE software is run by using a Python based CLI.

Prerequisites

Prerequisites

Note

Items denoted with 🐳 are installed in the Docker container. They do not require manual installation.

Requirement Required Docker Development Native Development
Python >= 3.6 ✅ ✅ ✅
Docker ❌ ✅ ❌
Socat ❌ 🐳 ✅

Setup Instructions

Firstly navigate into the repository directory and ensure you have Python 3 installed

$ python3 --version

Then install the necessary packages

$ python3 -m pip install -r requirements.txt

Note

These packages are required for CLI usage and the production environment of the software. Testing packages are installed in the Docker container only

And run the setup script to make the CLI file executable.

$ bash setup.sh

Note

Otherwise you can run the CLI with $ python3 rocket.py --args in place of all further refferences of $ rocket --args if you don't run the setup file.

Testing Setup

Please install Docker Desktop or Docker Engine on your system. Install the desktop version if you would like a GUI.

Further Steps

See usage

Home