Page Comparison

Installation

Local

Software Requirements

Local Cloud Setup

Installation

Download both Source Local Cloud and the Time Series Cycle Creator (TSCC) from Teamcity: https://teamcity.ewater.org.au/project.html?projectId=SourceCloud

• Source Cloud
  • Find the desired build and download all artefacts as a zip, extract to a folder (eg. Source Cloud build63)
• TSCC
  • Find the desired build (typically the latest one on release) and downlaod all artefacts as a zip, extract contents to the same level as the previous source cloud folder

Any subsequent versions of Source Cloud can be placed in the same directory without getting another version of the TSCC

So your folder structure should look something like:

• Root Folder
  • Source Cloud build63
    
    • Agent
    • Source Cloud
  • Source Cloud build64
    
    • Agent
    • Source Cloud
  • TimeseriesCycleCreator

requires the following software to be installed:

• eWater Source version 4.5.0 or later
• .NET Core 2.1 Runtime & Hosting Bundle

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 AddedConfiguration

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 settings with Source Cloudthe 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:

{
  "BaseUrl": "http://localhost:5051",
  "UseEmbeddedDatabase": true,
  "MaxLocalAgents": 4,
  "LocalAgentExe": "..\\Agent\\SourceCloudAgent.exe",
  "TimeseriesCycleCreatorExe": "..\\..\\TimeseriesCycleCreator\\TimeseriesCycleCreator.exe"
}

• BaseUrl - The browseable URL for the local version of Source Cloud

• UseEmbeddedDatabase - Whether to use the embedded database or not

• MaxLocalAgents - The maximum number of maximum versions of Source instances to be running for a given job
• TimeseriesCycleCreatorExe - The location of the executable for the TSCC

Agent Settings file:

{
  "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

Single Project Runner

Application

This runner is for running single .rsproj files that have been configured ahead of time using Running configurations.

Instructions

Click "Choose .rsproj" and select the Source Project you wish to run. It must be a Source Project that contains project metadata (the "ProjectMetadata.xml" file inside the .rsproj). It may take a few seconds for the file to upload and parse the metdata.

Image Removed

Select which Scenario/Running Configuration you'd like to run and then enter a name for the job. Finally git the "Queue" button.

Image Removed

Replication Runner

Application

This runner is for running a single .rsproj file that has reload on run, relative path time series data that are to be regenerated with the Time Series Cycle Creator

Instructions

Click "Choose project zip" and select the .zip file that contains your Replicate Project. The Source Project file inside the zip be a Source Project that contains project metadata (the "ProjectMetadata.xml" file inside the .rsproj). It may take a few seconds for the file to upload and parse the metdata.

Image Removed

Select which Scenario/Running Configuration you'd like to run. 

Fill in the data for the TSCC:

• Number of Replicates - 
• Start Cycle Date - 
• Start Year Replicates - 
• Cycle Time Step -

Enter a name for the job. Finally git the "Queue" button.

Image Removed

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