Bash Scripts

Notes on each .sh file within the scripts folder

build.sh

This script builds the Docker container with all its requirements. Should not be modified unless the Dockerfile or requirements need to be changed. Only needs to be run once on a profile on a computer when the initial setup is performed. Only needs to be rerun if requirements are changed.

download_models.sh

Downloads the Gold Digger trained models (checkpoints) from SharePoint links where they are shared online. Places trained model checkpoints into their respective folders in media/PIX2PIX/checkpoints/. Add to this folder when there are additional trained models that are available online to be included in the web tool.

run_celery.sh

Runs the Gold Digger docker container and starts Celery (asynchronous task manager). Messages and errors from Celery will appear in this terminal window. Run this script after run_redis.sh.

run_django.sh

Runs the Django server (in a new terminal after run_celery.sh and run_redis.sh have been run).

run_docker_detached.sh

Runs the webtool without producing terminal outputs. After running this script, the terminal window can be closed and the user can log out without shutting down the webtool. If a Docker container is started using this script, it will need to be manually closed.

run_redis.sh

Runs the Redis server, used to communicate between Django and Celery. Does not provide terminal output.