Main

.gitignore

@@ -6,6 +6,7 @@ archive
 *.log
 ~$*.xlsx
 dragg/dump.rdb
+*home_logs
 dragg/outputs
 dragg.egg-info
 *.log

deploy/.dockerignore

@@ -0,0 +1,2 @@
+*.rdb
+*.log

deploy/Dockerfile

@@ -0,0 +1,13 @@
+# Install python
+FROM python:3.9
+
+# Install dragg
+RUN pip install dragg
+RUN pip install cvxopt
+
+# Copy parent directory
+ADD . /dragg
+
+# Run simulation
+WORKDIR  dragg/dragg
+CMD python main.py -r "redis://redis"

deploy/docker-compose.yml

@@ -0,0 +1,15 @@
+version: '3'
+services:
+  dragg:
+    build:
+      context: ../
+      dockerfile: ./deploy/Dockerfile
+    environment:
+    - REDIS_HOST=redis
+    - localhost=6397
+    depends_on:
+      - redis
+    volumes:
+      - ./outputs:/dragg/outputs
+  redis:
+    image: redis

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 689320c16525ab51a9c3ed3765fb6772
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/api.rst.txt

@@ -0,0 +1,7 @@
+API Reference
+=============
+
+Classes
+---------
+.. autoclass:: MPCCalc
+    :members: initialize_environmental_variables, setup_base_problem

docs/build/html/_sources/dragg.devices.rst.txt

@@ -0,0 +1,27 @@
+dragg.devices package
+=====================
+
+.. automodule:: dragg.devices.battery
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: dragg.devices.electric_vehicle
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: dragg.devices.hvac
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: dragg.devices.pv
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: dragg.devices.water_heater
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/dragg.rst.txt

@@ -0,0 +1,22 @@
+dragg package
+=============
+
+.. automodule:: dragg.aggregator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: dragg.logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: dragg.mpc_calc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: dragg.reformat
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/getting_started.rst.txt

@@ -0,0 +1,16 @@
+Getting Started
+===============
+
+Installation
+------------
+
+DRAGG is available on PyPI and can be downloaded via pip.
+
+.. code-block:: console
+
+   $ pip install dragg
+
+Dependencies
+^^^
+
+DRAGG utilizes the Redis database to communicate between individual HEMS and the Aggregator. Therefore Redis is necessary to run DRAGG. While Redis is only available for Linux based operating systems we have included a Dockerfile in /deploy for Windows installations. 

docs/build/html/_sources/index.rst.txt

@@ -0,0 +1,27 @@
+.. DRAGG documentation master file, created by
+   sphinx-quickstart on Thu Oct  6 14:58:49 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Distributed Resource AGGregator (DRAGG)
+=======================================
+
+DRAGG is a Python based package for creating approximate load profiles of single family homes. DRAGG's thermal models can be used to validate demand response from consumers (e.g. maintaining thermal comfort and safety) while providing the corresponding demand. The thermal models in DRAGG are stochastically initialized to emulate the diversity of a typical residential community.
+
+Each consumer within DRAGG is represented via a `Model Predictive Control <https://en.wikipedia.org/wiki/Model_predictive_control>`_ Home Energy Management System (HEMS) with the objective to minimize their personal cost: cost per kWh by kWh consumed over the duration of the simualtion. To manipulate consumption the base HEMS is equipped with an electric HVAC system (based on a heat pump), an electric resistance water heater, and an electric vehicle that is capable of vehicle-to-grid charging. Optionally the HEMS can be equipped with a PV array and home battery.
+
+Every system is approximated by a set of `mixed-integer linear programming <https://en.wikipedia.org/wiki/Integer_programming>`_ constraints which can be used to approximate the `duty cycle <https://en.wikipedia.org/wiki/Duty_cycle>`_ of the HVAC and water heater respectively. 
+
+.. image:: _static/thermal.png
+   :scale: 50%
+
+Contents
+---------
+.. toctree::
+   :maxdepth: 1
+
+   getting_started
+   dragg
+   dragg.devices
+
+.. note:: DRAGG is still under development and we welcome feature requests or collaboration.