Merge pull request #323 from jonastahl/master

Add server for Weburbs

Author: merhart

.github/workflows/docker.yml

@@ -0,0 +1,49 @@
+name: Build and Push Docker Image
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  buildOptimizer:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            ghcr.io/${{ github.repository }}
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GH_PAT }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          file: ./Dockerfile
+          context: .
+          cache-from: |
+            user/app:cache
+            type=local,src=.
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

Dockerfile

@@ -0,0 +1,22 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+
+COPY urbs-env.txt .
+RUN python -m venv urbs-env
+
+RUN python -m venv urbs-env \
+    && ./urbs-env/bin/pip install --upgrade pip \
+    && ./urbs-env/bin/pip install -r urbs-env.txt \
+    && ./urbs-env/bin/pip install flask waitress
+
+
+RUN apt-get update && apt-get install -y \
+    gcc libglpk-dev glpk-utils
+RUN ./urbs-env/bin/pip install glpk
+
+COPY urbs urbs
+COPY runme.py .
+COPY server.py .
+
+CMD ["./urbs-env/bin/python", "-m", "waitress", "--port=5000", "server:app"]

Input/simple.json

@@ -0,0 +1,85 @@
+{
+    "c_timesteps": 6,
+    "global": {
+        "CO2 limit": 150000000,
+        "Cost limit": 35000000000
+    },
+    "site": {
+        "Main": {
+            "area": 20,
+            "commodity": {
+                "Solar": {
+                    "Type": "SupIm",
+                    "supim": [
+                        0, 0, 0, 1, 1, 1
+                    ]
+                },
+                "Wind": {
+                    "Type": "SupIm",
+                    "supim": [
+                        1, 1, 1, 0, 0, 0
+                    ]
+                },
+                "Elec": {
+                    "Type": "Demand",
+                    "demand": [
+                      10, 10, 10, 10, 10, 10
+                    ]
+                },
+                "CO2": {
+                    "Type": "Env",
+                    "price": 0,
+                    "max": "inf",
+                    "maxperhour": "inf"
+                }
+            },
+            "process": {
+                "Wind park": {
+                    "inst-cap": 0,
+                    "cap-lo": 0,
+                    "cap-up": 20,
+                    "max-grad": "inf",
+                    "min-fraction": 3,
+                    "inv-cost": 1000,
+                    "fix-cost": 20,
+                    "var-cost": 0,
+                    "wacc": 0,
+                    "depreciation": 25,
+                    "commodity": {
+                        "Wind": {
+                            "Direction": "In",
+                            "ratio": 1
+                        },
+                        "Elec": {
+                            "Direction": "Out",
+                            "ratio": 1
+                        }
+                    }
+                },
+                "Photovoltaics": {
+                    "inst-cap": 0,
+                    "cap-lo": 0,
+                    "cap-up": 20,
+                    "max-grad": "inf",
+                    "min-fraction": 4,
+                    "inv-cost": 300,
+                    "fix-cost": 7,
+                    "var-cost": 0,
+                    "wacc": 0,
+                    "depreciation": 25,
+                    "area-per-cap": 1,
+                    "commodity": {
+                        "Solar": {
+                            "Direction": "In",
+                            "ratio": 1
+                        },
+                        "Elec": {
+                            "Direction": "Out",
+                            "ratio": 1
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

Input/simple.xlsx

@@ -0,0 +1,7 @@
+
+services:
+  app:
+    image: ghcr.io/jonastahl/idp-urbs:0.0.4
+    build: .
+    ports:
+      - "5000:5000"

docker-compose.yaml

@@ -0,0 +1 @@
+curl http://localhost:5000/simulate -XPOST -H "Content-type: application/json" -T Input/simple.json

query.sh

@@ -0,0 +1,65 @@
+import os
+import shutil
+import urbs
+
+input_files = 'simple.xlsx'  # for single year file name, for intertemporal folder name
+input_dir = 'Input'
+input_path = os.path.join(input_dir, input_files)
+
+result_name = 'Run'
+result_dir = urbs.prepare_result_directory(result_name)  # name + time stamp
+
+# copy input file to result directory
+try:
+    shutil.copytree(input_path, os.path.join(result_dir, input_dir))
+except NotADirectoryError:
+    shutil.copyfile(input_path, os.path.join(result_dir, input_files))
+# copy run file to result directory
+shutil.copy(__file__, result_dir)
+
+# objective function
+objective = 'cost'  # set either 'cost' or 'CO2' as objective
+
+# Choose Solver (cplex, glpk, gurobi, ...)
+solver = 'glpk'
+
+# simulation timesteps
+(offset, length) = (3500, 24)  # time step selection
+timesteps = range(offset, offset+length+1)
+dt = 1  # length of each time step (unit: hours)
+
+# detailed reporting commodity/sites
+report_tuples = []
+
+# optional: define names for sites in report_tuples
+report_sites_name = {}
+
+# plotting commodities/sites
+plot_tuples = []
+
+# optional: define names for sites in plot_tuples
+plot_sites_name = {}
+
+# plotting timesteps
+plot_periods = {
+    'all': timesteps[1:]
+}
+
+# add or change plot colors
+my_colors = {}
+for country, color in my_colors.items():
+    urbs.COLORS[country] = color
+
+# select scenarios to be run
+scenarios = [
+             urbs.scenario_base
+            ]
+
+for scenario in scenarios:
+    prob = urbs.run_scenario(input_path, solver, timesteps, scenario,
+                             result_dir, dt, objective,
+                             plot_tuples=plot_tuples,
+                             plot_sites_name=plot_sites_name,
+                             plot_periods=plot_periods,
+                             report_tuples=report_tuples,
+                             report_sites_name=report_sites_name)

runexcel.py

@@ -2,64 +2,68 @@
 import shutil
 import urbs
 
-input_files = 'single_year_example.xlsx'  # for single year file name, for intertemporal folder name
-input_dir = 'Input'
-input_path = os.path.join(input_dir, input_files)
+def run():
+    input_files = 'single_year_example.xlsx'  # for single year file name, for intertemporal folder name
+    input_dir = 'Input'
+    input_path = os.path.join(input_dir, input_files)
 
-result_name = 'Run'
-result_dir = urbs.prepare_result_directory(result_name)  # name + time stamp
+    result_name = 'Run'
+    result_dir = urbs.prepare_result_directory(result_name)  # name + time stamp
 
-# copy input file to result directory
-try:
-    shutil.copytree(input_path, os.path.join(result_dir, input_dir))
-except NotADirectoryError:
-    shutil.copyfile(input_path, os.path.join(result_dir, input_files))
-# copy run file to result directory
-shutil.copy(__file__, result_dir)
+    # copy input file to result directory
+    try:
+        shutil.copytree(input_path, os.path.join(result_dir, input_dir))
+    except NotADirectoryError:
+        shutil.copyfile(input_path, os.path.join(result_dir, input_files))
+    # copy run file to result directory
+    shutil.copy(__file__, result_dir)
 
-# objective function
-objective = 'cost'  # set either 'cost' or 'CO2' as objective
+    # objective function
+    objective = 'cost'  # set either 'cost' or 'CO2' as objective
 
-# Choose Solver (cplex, glpk, gurobi, ...)
-solver = 'gurobi'
+    # Choose Solver (cplex, glpk, gurobi, ...)
+    solver = 'gurobi'
 
-# simulation timesteps
-(offset, length) = (0, 8760)  # time step selection
-timesteps = range(offset, offset+length+1)
-dt = 1  # length of each time step (unit: hours)
+    # simulation timesteps
+    (offset, length) = (0, 8760)  # time step selection
+    timesteps = range(offset, offset+length+1)
+    dt = 1  # length of each time step (unit: hours)
 
-# detailed reporting commodity/sites
-report_tuples = []
+    # detailed reporting commodity/sites
+    report_tuples = []
 
-# optional: define names for sites in report_tuples
-report_sites_name = {}
+    # optional: define names for sites in report_tuples
+    report_sites_name = {}
 
-# plotting commodities/sites
-plot_tuples = []
+    # plotting commodities/sites
+    plot_tuples = []
 
-# optional: define names for sites in plot_tuples
-plot_sites_name = {}
+    # optional: define names for sites in plot_tuples
+    plot_sites_name = {}
 
-# plotting timesteps
-plot_periods = {
-    'all': timesteps[1:]
-}
+    # plotting timesteps
+    plot_periods = {
+        'all': timesteps[1:]
+    }
 
-# add or change plot colors
-my_colors = {}
-for country, color in my_colors.items():
-    urbs.COLORS[country] = color
+    # add or change plot colors
+    my_colors = {}
+    for country, color in my_colors.items():
+        urbs.COLORS[country] = color
 
-# select scenarios to be run
-scenarios = [
-             urbs.scenario_base
-            ]
+    # select scenarios to be run
+    scenarios = [
+                 urbs.scenario_base
+                ]
 
-for scenario in scenarios:
-    prob = urbs.run_scenario(input_path, solver, timesteps, scenario,
-                             result_dir, dt, objective,
-                             plot_tuples=plot_tuples,
-                             plot_sites_name=plot_sites_name,
-                             plot_periods=plot_periods,
-                             report_tuples=report_tuples,
-                             report_sites_name=report_sites_name)
+    for scenario in scenarios:
+        prob = urbs.run_scenario(input_path, solver, timesteps, scenario,
+                                 result_dir, dt, objective,
+                                 plot_tuples=plot_tuples,
+                                 plot_sites_name=plot_sites_name,
+                                 plot_periods=plot_periods,
+                                 report_tuples=report_tuples,
+                                 report_sites_name=report_sites_name)
+
+if __name__ == "__main__":
+    run()