Skip to content

Latest commit

 

History

History
89 lines (66 loc) · 3 KB

README.md

File metadata and controls

89 lines (66 loc) · 3 KB

Local Interface

Table of Contents

About

Local Interface for simulation definition, management, and analysis. Local Interface is a part of the Agents Assembly ecosystem. Other applications are:

aasm_vis

Getting Started

Prerequisites

docker
docker-compose (dev only)

Installing

To use the application, utilize the server.sh script.
First, initialize the cluster:

./server.sh init

Alternatively, join the existing cluster using the TOKEN received from the init command:

./server.sh join TOKEN

Then, create the required networks (this step needs to be done only once inside the cluster):

./server.sh network

Finally, start the application:

./server.sh start

After starting, the application is available at http://localhost:80.

To see all the available options run the help command:

./server.sh help

Usage

The application must be used with the dedicated simulation run environment, described in About

Structure

The structure of the local interface is presented below.

User interface

React.js app used as GUI. It handles user interaction with the system.

Docker Hub

Environment variables:

  • CHOKIDAR_USEPOLLING - reload application after detecting a change in source files (i.e., true); if set to true, it requires the following volume attached: user-interface/src:/app/src
  • PORT - listen port (must be 80)

Proxy

Nginx instance that provides a gateway to the Simulation Run Environment.

Docker Hub

Host port mapping:

  • port 80 - access to user interface and simulation run environment API (/api)

Host port mapping (dev only):

  • port 8008 - simulation run environment database connection (neo4j)

Contributing

Please follow the contributing guide if you wish to contribute to the project.