Versions Compared

Old Version 16

changes.mady.by.user rachelb (Deactivated)

Saved on

compared with

New Version 17

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

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The Replicate Runner runs a single eWater Source model multiple times using an ensemble of time-series inputs . The runner can be used, for example, to run an eWater Source model with a range of alternative climate data inputs. 

There are two means of specifying the time series ensembles:

Generating variants of an existing time series

generated using the Time Series Cycle Creator (TSCC)

  • Loading a set of pre-generated time series
    • WarningOption 2 is not currently available for eWater Run Manager

    .

    eWater Source Project Setup

    To run a Replicate job, the eWater Source project must already be created with the time-series to be cycled loaded in Data Sources. It is possible to cycle a single Data Source or multiple Data Sources.

    In order to be cycled, the time-series Data Sources must be configured as follows:

    1. Reload on Run must be enabled (which instructs eWater Source to reload the data from a file on disk before simulating the model).
    2. The location of the data file must be specified as a Relative Path, and it must be in the same directory as the eWater Source project file, or a sub-directory , of the eWater Source project fileof that directory.
    3. The data file must be in the CSV csv file format.
    4. The data files must only contain data covering whole years otherwise cycled data will not match the correct day or month.

    For time series that are not to be cycled, Reload on Run must be disabled and the time series files must not be included in the uploaded zip.

    Once configured, the eWater Source project and CSV files (containing the time series the csv files to be replicated) cycled must be placed in a ZIP file. The CSV files can be located in sub-directories of the eWater Source project file zip file.

    Info

    Note that the project file must be in the root on the zip archive. It must not be within a folder. No other files other than the project file and the CSV files to be cycled should be included in the zip. In particular do not include other CSV files which are not timeseries files as the Time Series Cycle Creator tool will fail to cycle the data and the Job will fail.

    Example Replicate Project zip file: ReplicateExample.zip

    • ReplicateExample.zip
      • ReplicateTestProject.rsproj
      • Rainfall.csv
      • Demand
        • Demand.csv

    In this example there are two input timeseries files, Rainfall.csv and Demand.csv, with the latter file being in the Demand directory.

    Contents

    Table of Contents
    maxLevel3
    excludeContents
    printablefalse

    Job Setup

    Choose Project Zip

    Click "Choose project zip" and select the .zip file that contains your Replicate project. It Depending on the size of the file it may take a few seconds moment for the file to upload.

    Once the project has uploaded, the Replicate Runner configuration options will be displayed.

    Source Project

    Table 1 lists the eWater Source project configuration options

    Table 1. eWater Source project configuration options.
    Configuration OptionDescription
    ScenarioChoose the eWater Source scenario to be run
    Running Configuration

    Choose which Source Running Configuration should be simulated.

    Currently, the Run Manager is only designed to be used with Single Simulation.

    Anchor
    TSCC
    TSCC
    Time Series Cycle Creator (TSCC)

    The TSCC generates variants (called replicates) of an existing time series by repetitively 'cycling' the start of the time series to the end. The user can choose whether the data is cycled on a daily, weekly, monthly or annual basis. Table 1 lists the TSCC parameters.

    Table 1. TSCC parameters.
    ParametersRequirementDescription
    Number of ReplicatesRequiredThe number of replicates (output time-series) that will be created
    Start Cycle DateOptional

    The first data date that will be used by the TSCC to generate the replicates

    (data prior to this date is cycled to the end of the time series before generating any replicates)

    . The Start Cycle Date should be chosen so that there is an adequate amount of data in the resulting timeseries for the configured run period.

    This will default to the start date of the

    input time series

    running configuration, if not specified.

    Start Year ReplicatesOptional

    The year that the replicates will be reported as starting in (the replicates will always use the same start day and month as the input time-series). The Start Year Replicates cannot must not be after the Source simulation start date, as this will cause the simulation to fail.

    This will default to the first year of the input time-seriesrunning configuration, if not specified.


    Example

    Consider a daily time-series that spans the following 10 year period: 1/01/2000, 2/01/2000, 3/01/2000, ..., 31/12/2009. The data is used by a model that simulates a 2 5 year period from 1/1/2004 to 31/12/20052008.

    Running the TSCC with the following parameters would produce 3 4 replicates:

    • Number of Replicates = 34
    • Start Cycle Date = 1/01/20062004
    • Start Year Replicates = 2004

    The start date for all the replicates would be reported replicate timeseries files will be as 1/01/2004 (i.e. Start Year Replicates) ( and the end date would will be 31/12/20132009 (the original timeseries end date).

    The values of the replicates would be will be taken from the input timeseries files corresponding to the original values as follows:

    Replicate 1: - the time series values would correspond to the following years of the original time-series (2006 is the Start Cycle Date): timeseries files:

    2004, 2005, 2006, 2007, 2008, 2009

    , 2000, 2001, 2002, 2003, 2004, 2005. The model would simulate the original 2006 to 2007 data (although it

    The model would use the original 2004 to 2008 data for the simulation.

    Replicate 2 - the first year of replicate 1 (2000) would be moved to the end. Hence, the values of replicate 2 would correspond to the following years of the original timeseries files:

    2005, 2006, 2007, 2008, 2009, 2000

    The model would use the original 2005 to 2009 data (and would report this as being 2004 to

    2005

    2008).

    Replicate 2:3 - the first year of replicate 1 2 (2001) would be moved to the end. Hence, the values of replicate 2 3 would correspond to the following years of the original time-series: timeseries files:

    2006, 2007, 2008, 2009, 2000, 2001

    , 2002, 2003, 2004, 2005, 2006. The

    The model would

    simulate

    use the original

    2007 to 2008

    2006 to 2009 data, plus the 2000 data (and would report this as being 2004 to

    2005

    2008).

    Replicate 3:4 - the first year of replicate 2 3 (2002) would be moved to the end. Hence, the values of replicate 3 4 would correspond to the following years of the original time-series: timeseries files:

    2007, 2008, 2009, 2000, 2001, 2002

    , 2003, 2004, 2005, 2006, 2007. The

    The model would

    simulate

    use the original

    2008

    2007 to 2009 data, plus the 2000 to 2001 data (and would report this as being 2004 to

    2005).

    2008).

    Info

    Care must be taken when including timeseries data to be cycled to ensure the desired input data years are run.

    For example making changes to the above example will have the following results:

    • Start Cycle Date = 1/01/2006; Start Year Replicates = 2004
      • resulting timeseries files won't cover the run period, it will generate files from 1/01/2004 to 31/12/2007 (first replicate using original data from 1/1/2006 to 31/12/2009)
    • Start Cycle Date = 1/01/2001; Start Year Replicates = 2004
      • resulting timeseries files will cover a larger run period than required, it will generate files from 1/01/2004 to 31/12/2012 (first replicate using original data from 1/1/2001 to 31/12/2009)
    • Start Cycle Date = 1/01/2004; Start Year Replicates = 2006
      • resulting timeseries files won't cover the run period, it will generate files from 1/01/2006 to 31/12/2009 (first replicate using using original data from 1/1/2004 to 31/12/2007)


    Job Outputs

    Choose which outputs the user would like to store and be able to access on completion of the job.

    Queue

    The Queue enables the user to configure the job details, estimate costs, and send the job to the queue. Table 1 lists the configuration options.

    Table 2. Single Simulation Queue options.

    Configuration Option

    Description

    Job NameThe name given to the job when viewed in the Run Manager
    Agent EndpointsChoose which type of agents should be used to run the job (will be hidden if Run Manager is configured to only have one type of agent endpoint)
    Source VersionChoose the Source version to use for the Job
    Number of AgentsChoose the maximum number of agents used to run the job
    Model Run Estimate (Minutes)(Optional) The user's estimate of how long it will take to run the Source project once
    Estimate(Optional) Estimates the costs of running the job based on the user's Model Run Estimate, the selected agents, and the job type.
    QueueAdds the job to the queue of jobs to be run

    ...