Skip to content

INSTALL-OLD.md

Latest commit

 

History

History
162 lines (103 loc) · 6.56 KB

INSTALL-OLD.md

File metadata and controls

162 lines (103 loc) · 6.56 KB

Installation (DEPRACATED)

These are the previous development installation insturctions and have now been revamped to be more streamlined (see here). Follow these instructions if the newer method does not work for you.

Docker Installation - Website and Satellite Simulator (Recommended)

The docker installation methods below are compatible with any operating system that is supported by docker. If you are just looking to use the web app and don't plan on making any changes to the source code, then choose the User Installation method below. Otherwise, choose the Developer Installation method below.

Prior to starting, please install docker for your operating system if you have not already.

User Installation

This installation method will install a docker image that will be run as a container and used to host the ground station web app.

All you need to do is open a terminal instance on your operating system and enter the following commands:

docker pull albertasatdocker/ground-station-website:user-latest
docker run --rm -it -p 8000:8000 albertasatdocker/ground-station-website:user-latest

Now, open Google Chrome and navigate to http://localhost:8000.

Developer Installation

This installation method it will allow you to immediately see any modifications you have made to the source code on your host machine in the docker container (and vice versa). As a result, you will not have to rebuild the docker image every time you make a change to the source code on your host machine.

First, clone this repository and create a keys.sh file in the root folder that follows the same conventions outlined in the keys-example.sh file. You will need to create a Flask sessions SECRET_KEY and optionally, a Slack token. Information on using the Slack API can be found here.

MacOS and Ubuntu

After cloning this repository, pull the albertasatdocker/ground-station-website:dev-latest docker image using the commands below.

cd <cloned-repo-location>
docker pull albertasatdocker/ground-station-website:dev-latest

You can then run a container off the updated image using:

export GS_HOMEDIR=$(pwd)
docker run --rm -it -v $GS_HOMEDIR:/home/ex2_ground_station_website -p 8000:8000 albertasatdocker/ground-station-website:dev-latest

This will open a bash terminal within the docker container.

Install pip and npm libraries by running update.sh.

source ./update.sh

Then, run the app.

flask run --host=0.0.0.0 --port=8000

Finally, open Google Chrome and navigate to http://localhost:8000.

Windows

After cloning this repository, pull the albertasatdocker/ground-station-website:dev-latest docker image using the commands below.

cd <cloned-repo-location>
docker pull albertasatdocker/ground-station-website:dev-latest

You can then run a container off the updated image using:

docker run --rm -it -v %cd%:/home/ex2_ground_station_website -p 8000:8000 albertasatdocker/ground-station-website:dev-latest

This will open a bash terminal within the docker container.

The update.sh and env.sh files will need to be converted to use LF line endings. This can be done in VSCode or Notepad++, or by running the following commands from the ex2_ground_station_website directory (while in the bash terminal).

sed -i 's/\r//g' update.sh
sed -i 's/\r//g' env.sh

Install pip and npm libraries by running update.sh (while in the bash terminal).

source ./update.sh

Then, run the app.

flask run --host=0.0.0.0 --port=8000

Finally, open Google Chrome and navigate to http://localhost:8000.

Manual Installation

This installation method will work on an Ubuntu operating system.

First please clone the repository and then update the submodules using the following commands:

cd <cloned-repo-location>
git submodule update --init --recursive

Ubuntu dependencies for PostgreSQL, libCSP, and scheduling tasks:

sudo apt-get install at build-essential wget curl libpq-dev python3-dev gcc-multilib g++-multilib libsocketcan-dev

To run the app's frontend (i.e. in your web browser), you will need node & npm -- at least version 8. I recommend using the Node Version Manager.

Make sure you have a Python virtual environment installed and active! To do this navigate to the root project directory and run the following commands:

python3 -m venv env
source env/bin/activate

Set the environment variables. These environment variables tell Flask which configuration settings to use. Do this in every terminal window or you'll get database errors.

source ./env.sh

Install pip and npm libraries by running update.sh.

source ./update.sh

Finally, run the app.

flask run

Useful Commands

These commands should be the same regardless of which method of installation you're using.

  • python3 manage.py recreate_db - delete the database and create a new empty one.

  • python3 manage.py seed_db - seed the database with sample data.

  • cd groundstation/static && npm run build - build the React JS frontend.

  • source ./env.sh - set the environment variables for Flask's config. Without it you'll get weird SQLAlchemy errors.

  • source ./run_comm.sh - start the comm module. This will enable the app to send data to whatever socket is specified in comm.py. For example, ex2_services.

  • source ./automate.sh - run the automation module. It will automatically send whatever commands are inside automation.txt to the socket. (Note: the commands first have to be specified in manage.py, which the app refers to as "telecommands"). Not necessary for testing.

  • flask run - run the app.

  • python3 manage.py test - run the unit tests.

  • python3 manage.py test frontend_test - run the GUI frontend tests with Selenium. Please note that you will need to install the appropriate driver here.

  • python3 manage.py test groundstation_test - run ground station integration testing. Please note that you will need to have built libcsp in this repo's submodule and have set the appropriate env variables with source ./env.sh