Docker and FastAPI

This page provides information on how to set up a Docker container with FastAPI for developing and testing Brightway-enabled web applications.

Docker Setup (static)

Build the Docker image based on the provided Dockerfile:

Note

Replace brightapp with your desired image name.

docker build -t brightapp:latest .

Spin up a docker container and bind the port 8000 to localhost:

docker run -d -p 8000:8000 brightapp:latest

Docker Setup (dynamic)

For a more dynamic setup, you can use the docker-compose.yml file. This allows you to easily manage the container and its dependencies. It also mounts the current directory to the /app directory in the container, allowing you to develop and test your application without rebuilding the image every time you make a change.

docker compose up --build

Test USEEIO Database Operations

The USEEIO database can be tested with the FastAPI server. The following command sets up the database in the Docker instance:

curl -X POST http://localhost:8000/setup/useeio-database

A simple path traversal calculation can be performed with the following command:

curl -X POST 'http://localhost:8000/traversal/perform' \
-H 'Content-Type: application/json' \
-d '{
    "demand": [
        {
            "code": "5877b502-e197-33c2-815a-eac0934be16e",
            "amount": 1.0
        }
    ],
    "method": [
        "Impact Potential",
        "HC"
    ]
}' \
--output traversal_result.csv

Test Ecoinvent Database Operations

The Ecoinvent database can be tested with the FastAPI server. The following command sets up the database in the Docker instance:

curl -X POST http://localhost:8000/setup/ecoinvent-database \
-H "Content-Type: application/json" \
-d '{
        "username": "MichaelWeinold",
        "password": "PASSWORD"
    }'

An arbitrary Ecoinvent node can be retrieved by its code field with the following command:

curl -X GET "http://localhost:8000/database/getnode?name=polyvinylidenchloride%20production%2C%20granulate&location=RER"

A simple path traversal calculation can be performed with the following command:

curl -X POST http://localhost:8000/traversal/perform \
-H "Content-Type: application/json" \
-d '{
        "demand": [
            {
                "code": "092e1ead370cd1fcfc6a172672b72860",
                "amount": 1
            }
        ],
        "method": [
            "ecoinvent-3.10",
            "CML v4.8 2016",
            "climate change",
            "global warming potential (GWP100)"
        ],
        "cutoff": 0.001,
        "biosphere_cutoff": 0.001,
        "max_calc": 15
    }' \
--output traversal_result.csv

Update API (Swagger UI) Documentation

The FastAPI server provides an OpenAPI documentation endpoint that can be accessed at:

http://localhost:8000/docs

with the underlying OpenAPI schema available at:

http://localhost:8000/openapi.json

A simple helper script api/_generate_openapi_schema.py is provided to generate the OpenAPI schema from the FastAPI server:

python -m api._generate_openapi_schema

The generated OpenAPI schema will be saved in a file named openapi.json in the current directory and should be moved to the docs/api directory to be included in the documentation.