Refactor into single image

Makefile

@@ -3,6 +3,7 @@ LANG = en_US.utf-8
 PYTHON = $(shell which python3 || which python)
 DOCKER = $(shell which docker)
 DOCKER_COMPOSE = $(shell which docker || echo "$(DOCKER) compose")
+DOCKER_COMPOSE_YAML = docker/docker-compose.yaml
 export LANG
 
 # Initializes submodules and copies environment file sample to env file.
@@ -14,27 +15,32 @@ init:
 # Environment file copy
 envfile:
 ifeq ($(wildcard envfile),)
- cp api.env.sample api.env; \
+ cp env.sample .env; \
  echo -e "\nDon't forget to update 'envfile' with all your secrets!";
 endif
 
 # Turn project on
 .PHONY:up
-up:docker-compose.yaml
- $(DOCKER_COMPOSE) compose up -d
+up:docker/docker-compose.yaml
+ $(DOCKER_COMPOSE) compose --file $(DOCKER_COMPOSE_YAML) up -d
 
 # Rebuild all containers and turn project on
 .PHONY:up-rebuild
-up-rebuild:docker-compose.yaml
- $(DOCKER_COMPOSE) compose up --build -d
+up-rebuild:$(DOCKER_COMPOSE_YAML)
+ $(DOCKER_COMPOSE) compose --file $(DOCKER_COMPOSE_YAML) up --build -d
+
+# Rebuild the docker image from scratch
+.PHONY:up-rebuild
+force-rebuild:$(DOCKER_COMPOSE_YAML)
+ $(DOCKER_COMPOSE) compose --file $(DOCKER_COMPOSE_YAML) build --no-cache
 
 # Turn project off
 .PHONY:down
-down:docker-compose.yaml
- $(DOCKER_COMPOSE) compose down
+down:$(DOCKER_COMPOSE_YAML)
+ $(DOCKER_COMPOSE) compose --file $(DOCKER_COMPOSE_YAML) down
 
 # Restart project
 .PHONY:restart
-restart:docker-compose.yaml
+restart:$(DOCKER_COMPOSE_YAML)
  make down && make up
 

README.md

@@ -1,6 +1,8 @@
-[![Build and Publish](https://github.com/DARPA-ASKEM/service-template/actions/workflows/publish.yaml/badge.svg?event=push)](https://github.com/DARPA-ASKEM/service-template/actions/workflows/publish.yaml)
+# PyCIEMSS Simulation Service
 
-# PyCIEMSS Simulation API
+The service is a light wrapper service around [pyciemss](https://github.com/ciemss/pyciemss).
+Both a FastAPI and RQ tasks are provided so jobs can be run asynchronously for long periods
+of time. The service must also [conform to this spec](https://github.com/DARPA-ASKEM/simulation-api-spec).
 
 ## Startup
 
@@ -12,11 +14,23 @@ in order to pull the PyCIEMSS repository in as a submodule and set up the enviro
 
 `make up`
 
-to start the containers and the API. The API url will be `http://localhost:8010` without any additional configuration changes.
+to start the containers and the API. The API url will be `http://localhost:8010` by default 
 
-## Endpoints
+## Notes
+To start an RQ worker, use the following command in the container (default)
+```
+rq worker --url redis://$REDIS_HOST:$REDIS_PORT high default low
+```
 
-WIP
+To start the API, use the following command in the container
+```
+uvicorn server:app --reload --host 0.0.0.0 --port 8000
+```
+
+Every operation saves 3 files to S3
+- `result.csv`
+- `eval.csv`
+- `visualization.json`
 
 
 ## License