Versions Compared

Old Version 5

changes.mady.by.user Kuan Bartel (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Teamcity

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Edit through the REST API
Warning

This draft documentation is in progress and is visible to eWater Internal and Melbourne Water only

Overview

Overview of Source Cloud TBA...

Source Cloud can be installed as a local application, or accessed via the cloud.

Contents

Table of Contents
maxLevel3
excludeContents

Local Cloud Setup

Installation

Local Cloud requires the following software to be installed:

Local Cloud itself is distributed as a ZIP file that should be extracted to your local drive. 

The locations of the Local Cloud executables can be configured by the user, but it is easiest if they are placed in the following directory structure:

  • /Root Folder
    • /Source Cloud build01
      • /Agent
      • /Source Cloud
    • /TimeseriesCycleCreator

Subsequent releases of the Local Cloud can be placed in the same root directory without needing to replace the Time Series Cycle Creator, e.g.:

Image RemovedConfiguration

Inside the Agent and Source Cloud directories are files called "appSettings.json". These files can be opened in a text editor and allow you to configure the Source Cloud settings. If you use the directory structure illustrated above, the only setting that will require editing is the location of the eWater Source installation directory.

Source Cloud settings file:

Code Block
languagejava
titleSource Cloud appsettings.json
{
  "BaseUrl": "http://localhost:5051",
  "MaxLocalAgents": 4,
  "LocalAgentExe": "..\\Agent\\SourceCloudAgent.exe",
  "TimeseriesCycleCreatorExe": "..\\..\\TimeseriesCycleCreator\\TimeseriesCycleCreator.exe"
}
  • BaseUrl - The browseable URL for the local version of Source Cloud
  • MaxLocalAgents - The maximum number of Source instances to be running for a given job
  • TimeseriesCycleCreatorExe - The location of the executable for the TSCC

Agent Settings file:

Code Block
languagejava
titleAgent appsettings.json
{
  "PollingPeriodMs": "10000",
  "ServerBaseUrl": "http://localhost:5051",
  "SourceDirectory": "C:\\Source\\Source_4.5.0.7410\\"
}
  • PollingPeriodMs - How often agent will poll the server requesting for a job/task
  • ServerBaseUrl - The URL to contact the server on
  • SourceDirectory - The directory containing the version of Source to run

Launch Local Cloud

Launch the Local Cloud application by SourceCloud.exe, which is located in the /SourceCloud directory. This will launch the Local Cloud application in your default web browser.

Source Cloud Dashboard

Description of the Source Cloud Dashboard TBA.

Job Creation

  • Single Simulation Runner
  • Replicate Runner
    • Insight Runner

    Overview

    The Run Manager is designed to enable Source users to harness the power of distributed/cloud computing to tackle large simulation and multi-objective optimisation problems. The Run Manager allows users to configure and execute multiple Source simulation and optimisation jobs in parallel. The Run Manager can be used in two ways:

    1. Cloud - run on Amazon Web Services (AWS) via a service hosted by eWater
    2. Local - installed and run on your local PC - which useful for scheduling multiple Source jobs on your local PC and for testing big jobs before sending them to the cloud

    A third 'Cluster' mode is planned in the future to allow the Run Manager to be installed on a local network to utilise multiple personal computers.

    For all modes of operation, the Run Manager is accessed via the same web-browser user interface (UI).

    Contents

    Table of Contents
    maxLevel3
    excludeContents


    Access

    The process of launching the Run Manager application is described in Accessing the Run Manager.

    Run Manager Interface

    The Run Manager is accessed via a web browser interface (for both the Cloud and Local applications). The Run Manager Toolbar (Figure 1) is located at the top of the browser window and has the following items:

    Figure 1. The Run Manager Toolbar.

    Image Added