WIP: Support for running tutorials using Docker

Dockerfiles/Makefile

@@ -0,0 +1,6 @@
+build:
+	$(MAKE) -C helics    build
+	$(MAKE) -C griddyn   build
+	$(MAKE) -C gridlab-d build
+	$(MAKE) -C psst      build
+	$(MAKE) -C runner    build

Dockerfiles/README.md

@@ -0,0 +1,8 @@
+# Dockerfiles
+
+A Dockerfile exists for each component (ie. federate) needed for the
+tutorials. The Docker Compose files for each tutorials will reference
+the relevant Dockerfiles as the `build` argument for each container.
+Alternatively, each image can be built by running `make build` in the
+relevant directory, or all the images can be built by running `make
+build` in this directory.

Dockerfiles/griddyn/Dockerfile

@@ -0,0 +1,37 @@
+FROM helics as builder
+
+RUN apt update && apt install -y \
+  libboost-dev libboost-chrono-dev \
+  libboost-date-time-dev libboost-filesystem-dev \
+  libboost-program-options-dev \
+  libboost-system-dev libboost-test-dev \
+  libboost-timer-dev libsuitesparse-dev \
+  libzmq3-dev libklu1 \
+  build-essential cmake git
+
+WORKDIR /root/develop
+
+RUN git clone --single-branch -b cmake_update https://github.com/LLNL/GridDyn.git
+
+WORKDIR /root/develop/GridDyn
+
+ADD fmi-patch.diff .
+RUN git apply fmi-patch.diff
+
+WORKDIR /root/develop/GridDyn/build
+
+RUN cmake -DHELICS_EXECUTABLE=ON .. && make -j8 install
+
+FROM ubuntu:18.04
+
+RUN apt update && apt install -y --no-install-recommends \
+  libboost-chrono1.65.1 libboost-date-time1.65.1 \
+  libboost-filesystem1.65.1 libboost-program-options1.65.1 \
+  libboost-system1.65.1 libboost-test1.65.1 \
+  libboost-timer1.65.1 libzmq5 libklu1 libgomp1 \
+  && rm -rf /var/lib/apt/lists/*
+
+COPY --from=builder /usr/local /usr/local/
+
+# FIXME
+CMD ["gridDynMain", "--version"]

Dockerfiles/griddyn/Makefile

@@ -0,0 +1,4 @@
+NAME := griddyn
+
+build:
+	docker build -t $(NAME) .

Dockerfiles/griddyn/fmi-patch.diff

@@ -0,0 +1,14 @@
+diff --git a/src/fmi/CMakeLists.txt b/src/fmi/CMakeLists.txt
+index 63f35f7..4ffd693 100644
+--- a/src/fmi/CMakeLists.txt
++++ b/src/fmi/CMakeLists.txt
+@@ -78,7 +78,7 @@ source_group("FMUImport" FILES ${fmiImport_sources} ${fmiImport_headers})
+
+ set_target_properties(fmiGDLibrary PROPERTIES FOLDER fmi)
+
+-target_link_libraries(fmiGDLibrary griddyn formatInterpreter)
++target_link_libraries(fmiGDLibrary griddyn formatInterpreter ${CMAKE_DL_LIBS})
+
+ install(
+     TARGETS fmiGDLibrary
+

Dockerfiles/gridlab-d/Dockerfile

@@ -0,0 +1,36 @@
+FROM helics as builder
+
+RUN apt update && apt install -y \
+  libboost-dev libboost-chrono-dev \
+  libboost-date-time-dev libboost-filesystem-dev \
+  libboost-program-options-dev \
+  libboost-test-dev libboost-timer-dev \
+  libzmq3-dev libtool libxerces-c-dev \
+  build-essential automake git
+
+
+WORKDIR /root/develop
+
+RUN git clone --single-branch -b develop https://github.com/gridlab-d/gridlab-d.git
+
+WORKDIR /root/develop/gridlab-d
+
+RUN autoreconf -if \
+  && ./configure --prefix=/usr/local --with-helics=/usr/local --enable-silent-rules \
+    "CFLAGS=-g -O0 -w" "CXXFLAGS=-g -O0 -w -std=c++14" "LDFLAGS=-g -O0 -w" \
+  && make -j8 install
+
+FROM ubuntu:18.04
+
+RUN apt update && apt install -y --no-install-recommends \
+  libboost-chrono1.65.1 libboost-date-time1.65.1 \
+  libboost-filesystem1.65.1 libboost-program-options1.65.1 \
+  libboost-test1.65.1 libboost-timer1.65.1 \
+  libzmq5 libxerces-c3.2 \
+  && rm -rf /var/lib/apt/lists/*
+
+COPY --from=builder /usr/local /usr/local/
+
+ENV LD_LIBRARY_PATH=/usr/local/lib
+
+CMD ["gridlabd", "--version"]

Dockerfiles/gridlab-d/Makefile

@@ -0,0 +1,4 @@
+NAME := gridlab-d
+
+build:
+	docker build -t $(NAME) .

Dockerfiles/helics/Dockerfile

@@ -0,0 +1,42 @@
+FROM ubuntu:18.04 as builder
+
+RUN apt update && apt install -y \
+  libboost-dev libboost-chrono-dev \
+  libboost-date-time-dev libboost-filesystem-dev \
+  libboost-program-options-dev \
+  libboost-test-dev libboost-timer-dev \
+  libzmq3-dev python3-dev \
+  build-essential swig cmake git
+
+WORKDIR /root/develop
+
+RUN git clone https://github.com/GMLC-TDC/HELICS-src.git helics
+
+WORKDIR /root/develop/helics/build
+
+RUN cmake \
+  -DBUILD_PYTHON_INTERFACE=ON \
+  -DBUILD_CXX_SHARED_LIB=ON \
+  -DPYTHON_INCLUDE_DIR=/usr/include/python3.6/ \
+  -DPYTHON_LIBRARY=/usr/lib/x86_64-linux-gnu/libpython3.6m.so \
+  -DCMAKE_INSTALL_PREFIX=/helics \
+  ..
+RUN make -j8 install
+
+FROM ubuntu:18.04
+
+RUN apt update && apt install -y --no-install-recommends \
+  libboost-chrono1.65.1 libboost-date-time1.65.1 \
+  libboost-filesystem1.65.1 libboost-program-options1.65.1 \
+  libboost-test1.65.1 libboost-timer1.65.1 libzmq5
+
+COPY --from=builder /helics /usr/local/
+
+ENV PYTHONPATH /usr/local/python
+
+# Python must be installed after the PYTHONPATH is set above for it to
+# recognize and import libhelicsSharedLib.so.
+RUN apt install -y --no-install-recommends python3-dev \
+  && rm -rf /var/lib/apt/lists/*
+
+CMD ["python3", "-c", "import helics; print(helics.helicsGetVersion())"]

Dockerfiles/helics/Makefile

@@ -0,0 +1,4 @@
+NAME := helics
+
+build:
+	docker build --no-cache -t $(NAME) .

Dockerfiles/psst/Dockerfile

@@ -0,0 +1,27 @@
+FROM helics as builder
+
+RUN apt update && apt install -y \
+  python3-pip git
+
+RUN pip3 install scipy
+
+WORKDIR /root/develop
+
+RUN git clone https://github.com/kdheepak/psst.git
+
+WORKDIR /root/develop/psst
+
+RUN pip3 install . \
+  && cp -a psst/* /usr/local/lib/python3.6/dist-packages/psst
+
+FROM ubuntu:18.04
+
+RUN apt update && apt install -y --no-install-recommends \
+  python3-pkg-resources python3-six python3-setuptools python3-idna \
+  && rm -rf /var/lib/apt/lists/*
+
+COPY --from=builder /usr/local /usr/local/
+
+ENV LC_ALL=C.UTF-8 LANG=C.UTF-8
+
+CMD ["psst", "--version"]

Dockerfiles/psst/Makefile

@@ -0,0 +1,4 @@
+NAME := psst
+
+build:
+	docker build -t $(NAME) .

Dockerfiles/runner/Dockerfile

@@ -0,0 +1,21 @@
+FROM helics as builder
+
+RUN apt update && apt install -y \
+  python3-pip git
+
+RUN pip3 install git+git://github.com/GMLC-TDC/helics-runner.git@master
+
+FROM ubuntu:18.04
+
+RUN apt update && apt install -y --no-install-recommends \
+  python3-pkg-resources python3-six \
+  && rm -rf /var/lib/apt/lists/*
+
+COPY --from=builder /usr/local /usr/local/
+
+ENV LC_ALL=C.UTF-8 LANG=C.UTF-8
+
+# The config file defaults to calling `python`.
+RUN ln -s /usr/bin/python3 /usr/bin/python
+
+CMD ["helics", "--version"]

Dockerfiles/runner/Makefile

@@ -0,0 +1,4 @@
+NAME := helics-runner
+
+build:
+	docker build -t $(NAME) .

README.md

@@ -9,4 +9,5 @@ that include Transmission, Distribution, Markets and Communication federates.
 Table of Contents:
 
 - [Setup](./setup/README.md)
+- [Dockerfiles](./Dockerfiles/README.md)
 - [Tutorials](./tutorials/README.md)

tutorials/1-DistributionFederation-ManualStart/docker-compose.yml

@@ -0,0 +1,30 @@
+version: '3'
+services:
+  broker:
+    build: ../../Dockerfiles/helics
+    command:
+    - helics_broker
+    - '2'
+    - --loglevel=3
+    - --name=mainbroker
+    image: helics
+  federate:
+    build: ../../Dockerfiles/helics
+    command:
+    - python3
+    - federate1.py
+    image: helics
+    volumes:
+      - ../../:/helics-tutorial
+    working_dir: /helics-tutorial/tutorials/1-DistributionFederation-ManualStart
+  gridlab-d:
+    build: ../../Dockerfiles/gridlab-d
+    command:
+    - gridlabd
+    - DistributionSim_B2_G_1.glm
+    environment:
+    - LD_LIBRARY_PATH=/usr/local/lib
+    image: gridlab-d
+    volumes:
+      - ../../:/helics-tutorial
+    working_dir: /helics-tutorial/test_system_data/gldFeeders/B2/G_1

tutorials/README.md

@@ -23,4 +23,18 @@ This is an example of 11 GridLAB-D HELICS Federates, a GridDyn HELICS Federate,
 This is an example of 11 GridLAB-D HELICS Federates, a GridDyn HELICS Federate, a FESTIVLite HELICS Federate, and a HELICS Broker.
 In addition it includes communication delay filter.
 
+### Docker Compose
 
+Each tutorial contains a `docker-compose.yml` file that can be used with
+Docker Compose to run the tutorial using Docker containers.
+
+For example:
+
+```
+$> cd tutorials/1-DistributionFederation-ManualStart
+$> docker-compose up
+```
+
+If the relevant Docker images need to be built, Docker Compose will take
+care of building them before running the tutorial. If this is the case,
+go grab some :coffee: while the images build... it'll be a while.