https://hub.docker.com/r/dynawo/dynawo
This repository contains Dynaωo's Docker images.
Dynaωo is an hybrid C++/Modelica open source suite of simulation tools for power systems. It aims at providing power system stakeholders with a transparent, flexible, interoperable and robust suite of simulation tools that could ease collaboration and cooperation in the power system community. To achieve this goal, Dynaωo is based on two mains principles: the use of a high-level modeling language Modelica and a strict separation between modeling and solving parts.
We provide this repository to ease users with Dynaωo' installation and provide a quick way to try the simulation tool.
Dynaωo-docker is an open-source project and as such, questions, discussions, feedbacks and more generally any form of contribution are very welcome and greatly appreciated!
For further informations about contributing guidelines, please refers to the contributing documentation.
Under the Users folder we provide a Dockerfile to build an image integrating the latest Dynaωo version. This image is available on Docker Hub. Then if you already have docker installed on your machine you can directly execute the following command:
$> docker run -it dynawo/dynawoThe previous command is a very basic one to just test Dynaωo very quickly. We recommend you to create a container by sharing a folder of your host machine so that you can access it inside and outside the container to create your own test cases. You can launch the following command (FOLDER_PATH needs to be modified with appropriate value):
$> docker run -it -e LOCAL_USER_ID=`id -u $USER` -e LOCAL_GROUP_ID=`id -g $USER` -v FOLDER_PATH:/home/dynawo_user/SharedFolder dynawo/dynawo> docker run -it -v FOLDER_PATH:/home/dynawo_user/SharedFolder dynawo/dynawoFor FOLDER_PATH syntax on Windows you can find help here.
Once inside the container the user can use the dynawo alias and launch:
dynawo_user@contaiderID:dynawo$> dynawo nrtYou can also build your image from sources by following these instructions.
Under the Developers folder we provide a Dockerfile to build an image containing all necessary tools to compile Dynaωo. This time the approach is to store the sources on your machine, so that you can use your favorite IDE to develop, and use the container to compile the code.
First you have to build an image with the following commands:
$> git clone https://github.com/dynawo/dynawo-docker.git dynawo-docker
$> cd dynawo-docker/Developers
$> ./build_docker_image.shThen you need to create the container, this time we create a mirror user of you inside the container to be able to access files inside and outside the container. We share your entire HOME inside the container as the HOME of the mirror user in the container. We also provide this account with sudo privileges.
$> ./create_container.shNow you can connect to the newly created container with:
$> ./connect_to_container.shYou can now download and install Dynaωo were you want to on your system, your home folder has been shared inside the container as the home folder of the user in the container (user with the same name uid and gid as you). For this you can use the script provided in the container and launch, we call MY_DYNAWO_PATH the path were you want to install Dynaωo on your machine:
your_user_name@contaiderID:~$> /opt/install_dynawo.sh --prefix MY_DYNAWO_PATHAt the end of the script Dynaωo source code is available on your machine and has been fully compiled, you can then launch:
your_user_name@contaiderID:MY_DYNAWO_PATH/dynawo$> dynawo nrt
your_user_name@contaiderID:MY_DYNAWO_PATH/dynawo$> dynawo helpThe Developers image is built on Docker Hub and you can use it like this (replace MY_FOLDER below):
$> docker run -it -d --name=dynawo-dev -v MY_FOLDER:/home/dynawo_developer/dynawo dynawo/dynawo-dev
$> LOCAL_USER_ID=`id -u $USER`
$> LOCAL_GROUP_ID=`id -g $USER`
$> docker exec dynawo-dev usermod -u $LOCAL_USER_ID dynawo_developer
$> docker exec dynawo groupmod -o -g $LOCAL_GROUP_ID dynawo_developer || usermod -g $LOCAL_GROUP_ID dynawo_developer || usermod -a -G $LOCAL_GROUP_ID dynawo_developer
$> docker exec dynawo-dev chown -R dynawo_developer:dynawo_developer /home/dynawo_developer
$> docker exec -u dynawo_developer -it dynawo-dev bash
dynawo_developer@dynawo-dev $> /opt/install_dynawo.sh --prefix /home/dynawo_developer/dynawoThis time you need to launch a Windows command line interpreter. You also need to have Git for Windows installed to first checkout this repository. Then execute the following commands to create the image and a container:
> cd PATH_TO_THIS_REPOSITORY/Developers
> docker build docker build -t dynawo-dev --no-cache .
> docker run -it --name=dynawo-dev -v c:/Users/myName:/home/dynawo_developer dynawo-devYou need to enable sharing of your C drive, follow official instructions here. Inside the container we created a user named dynawo_developer. You can then install Dynaωo inside the container with the following command:
dynawo_developer@contaiderID:~$> /opt/install_dynawo.sh --prefix MY_DYNAWO_PATHFor MacOS or Windows users we recommend using this solution as no toolchain is provided to compile Dynaωo natively on those OS. In this approach the Docker container is used as a substitute bash, with Linux compiler, to compile the code while still being able to edit Dynaωo source code natively on your machine with your favorite IDE. We also warn about the resources you allowed to the Docker deamon as it could result in very slow compilation or even failures, if it occurs we recommend to increase CPU and RAM allowed to Docker in the settings.
Dynaωo is licensed under the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, you can obtain one at http://mozilla.org/MPL/2.0. You can also see the LICENSE file for more information.
See here for external libraries licenses.
Dynaωo is currently maintained by people at RTE, in case of questions or issues, you can also send an e-mail to [email protected].
For more information about Dynaωo:
- Consult Dynaωo website
- Contact us at [email protected]