/gridappsd-sample-app

Primary LanguagePython

GridAPPS-D Sample Application

Purpose

The purpose of this repository is to document the chosen way of registering and running applications within a GridAPPS-D deployment.

Requirements

  1. Docker ce version 17.12 or better. You can install this via the docker_install_ubuntu.sh script. (note for mint you will need to modify the file to work with xenial rather than ubuntu generically)

Quick Start

The following procedure will use the already existing containers for the gridappsd sample application.

  1. Clone the gridappsd-docker repository

    git clone https://github.com/GRIDAPPSD/gridappsd-docker
cd gridappsd-docker

  2. Run the docker containers

    ./run.sh

  3. Once inside the container start gridappsd

    ./run-gridappsd.sh

  4. Open browser to http://localhost:8080 (follow instructions https://gridappsd.readthedocs.io/en/latest/using_gridappsd/index.html to run the application)

Sample Application Layout

The following is the recommended structure for an applications working with gridappsd:

.
├── README.md
├── requirements.txt
├── sample_app
│   └── runsample.py
└── sample_app.config

IGNORE BELOW THIS!

  1. Docker ce version 17.12 or better. You can install this via the docker_install_ubuntu.sh script. (note for mint you will need to modify the file to work with xenial rather than ubuntu generically)

  2. Please clone the repository https://github.com/GRIDAPPSD/gridappsd-docker (refered to as gridappsd-docker repository) next to this repository (they should both have the same parent folder)

    git clone https://github.com/GRIDAPPSD/gridappsd-docker
git clone https://github.com/GRIDAPPSD/gridappsd-sample-app

ls -l

drwxrwxr-x  7 osboxes osboxes 4096 Sep  4 14:56 gridappsd-docker
drwxrwxr-x  5 osboxes osboxes 4096 Sep  4 19:06 gridappsd-sample-app

Creating the sample-app application container

  1. From the command line execute the following commands to build the sample-app container

    osboxes@osboxes> cd gridappsd-sample-app
osboxes@osboxes> docker build --network=host -t sample-app .

  2. Add the following to the gridappsd-docker/docker-compose.yml file

    sampleapp:
  image: sample-app
  depends_on: 
    gridappsd

  3. Run the docker application

    osboxes@osboxes> cd gridappsd-docker
osboxes@osboxes> ./run.sh

# you will now be inside the container, the following starts gridappsd

gridappsd@f4ede7dacb7d:/gridappsd$ ./run-gridappsd.sh

Next to start the application through the viz follow the directions here: https://gridappsd.readthedocs.io/en/latest/using_gridappsd/index.html#start-gridapps-d-platform