Simulation.Aivika.Experiment.Types

Tested with: GHC 8.0.1

The module defines the simulation experiments. They automate the process of generating and analyzing the results. Moreover, this module is open to extensions, allowing you to define your own output views for the simulation results, for example, such views that would allow saving the results in PDF or as charts. To decrease the number of dependencies, such possible extenstions are not included in this package, although simple views are provided.

Documentation

data Experiment

It defines the simulation experiment with the specified rendering backend and its bound data.

Constructors

Experiment

Fields

• experimentSpecs :: Specs

  The simulation specs for the experiment.

• experimentTransform :: ResultTransform

  How the results must be transformed before rendering.

• experimentLocalisation :: ResultLocalisation

  Specifies a localisation applied when rendering the experiment.

• experimentRunCount :: Int

  How many simulation runs should be launched.

• experimentTitle :: String

  The experiment title.

• experimentDescription :: String

  The experiment description.

• experimentVerbose :: Bool

  Whether the process of generating the results is verbose.

• experimentNumCapabilities :: IO Int

  The number of threads used for the Monte-Carlo simulation if the executable was compiled with the support of multi-threading.

defaultExperiment :: Experiment

The default experiment.

class ExperimentRendering r where

It allows rendering the simulation results in an arbitrary way.

Minimal complete definition

liftExperiment, prepareExperiment, renderExperiment, onExperimentCompleted, onExperimentFailed

Associated Types

data ExperimentContext r :: *

Defines a context used when rendering the experiment.

type ExperimentEnvironment r :: *

Defines the experiment environment.

type ExperimentMonad r :: * -> *

Defines the experiment monad type.

Methods

liftExperiment :: r -> ExperimentMonad r a -> IO a

Lift the experiment computation.

prepareExperiment :: Experiment -> r -> ExperimentMonad r (ExperimentEnvironment r)

Prepare before rendering the experiment.

renderExperiment :: Experiment -> r -> [ExperimentReporter r] -> ExperimentEnvironment r -> ExperimentMonad r ()

Render the experiment after the simulation is finished, for example, creating the index.html file in the specified directory.

onExperimentCompleted :: Experiment -> r -> ExperimentEnvironment r -> ExperimentMonad r ()

It is called when the experiment has been completed.

onExperimentFailed :: Exception e => Experiment -> r -> ExperimentEnvironment r -> e -> ExperimentMonad r ()

It is called when the experiment rendering has failed.

Instances

ExperimentRendering (FileRenderer a)

Saving the results of simulation in files when running the experiment.

Associated Types

data ExperimentContext (FileRenderer a) :: *

type ExperimentEnvironment (FileRenderer a) :: *

type ExperimentMonad (FileRenderer a) :: * -> *

Methods

liftExperiment :: FileRenderer a -> ExperimentMonad (FileRenderer a) a -> IO a

prepareExperiment :: Experiment -> FileRenderer a -> ExperimentMonad (FileRenderer a) (ExperimentEnvironment (FileRenderer a))

renderExperiment :: Experiment -> FileRenderer a -> [ExperimentReporter (FileRenderer a)] -> ExperimentEnvironment (FileRenderer a) -> ExperimentMonad (FileRenderer a) ()

onExperimentCompleted :: Experiment -> FileRenderer a -> ExperimentEnvironment (FileRenderer a) -> ExperimentMonad (FileRenderer a) ()

onExperimentFailed :: Exception e => Experiment -> FileRenderer a -> ExperimentEnvironment (FileRenderer a) -> e -> ExperimentMonad (FileRenderer a) ()

ExperimentRendering (WebPageRenderer a)

Rendering a web page with results when running the simulation experiment.

Associated Types

data ExperimentContext (WebPageRenderer a) :: *

type ExperimentEnvironment (WebPageRenderer a) :: *

type ExperimentMonad (WebPageRenderer a) :: * -> *

Methods

liftExperiment :: WebPageRenderer a -> ExperimentMonad (WebPageRenderer a) a -> IO a

prepareExperiment :: Experiment -> WebPageRenderer a -> ExperimentMonad (WebPageRenderer a) (ExperimentEnvironment (WebPageRenderer a))

renderExperiment :: Experiment -> WebPageRenderer a -> [ExperimentReporter (WebPageRenderer a)] -> ExperimentEnvironment (WebPageRenderer a) -> ExperimentMonad (WebPageRenderer a) ()

onExperimentCompleted :: Experiment -> WebPageRenderer a -> ExperimentEnvironment (WebPageRenderer a) -> ExperimentMonad (WebPageRenderer a) ()

onExperimentFailed :: Exception e => Experiment -> WebPageRenderer a -> ExperimentEnvironment (WebPageRenderer a) -> e -> ExperimentMonad (WebPageRenderer a) ()

data ExperimentGenerator r

This is a generator of the reporter with the specified rendering backend.

Constructors

ExperimentGenerator

Fields

• generateReporter :: Experiment -> r -> ExperimentEnvironment r -> ExperimentMonad r (ExperimentReporter r)

  Generate a reporter.

class ExperimentRendering r => ExperimentView v r where

Defines a view in which the simulation results should be saved. You should extend this type class to define your own views such as the PDF document.

Minimal complete definition

outputView

Methods

outputView :: v -> ExperimentGenerator r

Create a generator of the reporter.

Instances

ExperimentView FinalStatsView (WebPageRenderer a)

Methods

outputView :: FinalStatsView -> ExperimentGenerator (WebPageRenderer a)

ExperimentView FinalTableView (FileRenderer a)

Methods

outputView :: FinalTableView -> ExperimentGenerator (FileRenderer a)

ExperimentView FinalTableView (WebPageRenderer a)

Methods

outputView :: FinalTableView -> ExperimentGenerator (WebPageRenderer a)

ExperimentView InfoView (WebPageRenderer a)

Methods

outputView :: InfoView -> ExperimentGenerator (WebPageRenderer a)

ExperimentView LastValueView (WebPageRenderer a)

Methods

outputView :: LastValueView -> ExperimentGenerator (WebPageRenderer a)

ExperimentView TableView (FileRenderer a)

Methods

outputView :: TableView -> ExperimentGenerator (FileRenderer a)

ExperimentView TableView (WebPageRenderer a)

Methods

outputView :: TableView -> ExperimentGenerator (WebPageRenderer a)

ExperimentView TimingStatsView (WebPageRenderer a)

Methods

outputView :: TimingStatsView -> ExperimentGenerator (WebPageRenderer a)

ExperimentView ExperimentSpecsView (WebPageRenderer a)

Methods

outputView :: ExperimentSpecsView -> ExperimentGenerator (WebPageRenderer a)

data ExperimentData

It describes the source simulation data used in the experiment.

Constructors

ExperimentData

Fields

• experimentResults :: Results

  The simulation results used in the experiment.

• experimentPredefinedSignals :: ResultPredefinedSignals

  The predefined signals provided by every model.

data ExperimentReporter r

Defines what creates the simulation reports by the specified renderer.

Constructors

ExperimentReporter

Fields

• reporterInitialise :: ExperimentMonad r ()

  Initialise the reporting before the simulation runs are started.

• reporterFinalise :: ExperimentMonad r ()

  Finalise the reporting after all simulation runs are finished.

• reporterSimulate :: ExperimentData -> Composite ()

  Start the simulation run in the start time.

• reporterContext :: ExperimentContext r

  Return a context used by the renderer.

runExperiment

Arguments

:: (ExperimentRendering r, Monad (ExperimentMonad r), MonadIO (ExperimentMonad r), MonadException (ExperimentMonad r))

=> Experiment

the simulation experiment to run

-> [ExperimentGenerator r]

generators used for rendering

-> r

the rendering backend

-> Simulation Results

the simulation results received from the model

-> IO (Either SomeException ())

Run the simulation experiment sequentially. For example, it can be a Monte-Carlo simulation dependentent on the external Parameter values.

runExperimentParallel

Arguments

:: (ExperimentRendering r, Monad (ExperimentMonad r), MonadIO (ExperimentMonad r), MonadException (ExperimentMonad r))

=> Experiment

the simulation experiment to run

-> [ExperimentGenerator r]

generators used for rendering

-> r

the rendering backend

-> Simulation Results

the simulation results received from the model

-> IO (Either SomeException ())

Run the simulation experiment in parallel.

Make sure that you compile with -threaded and supply +RTS -N2 -RTS to the generated Haskell executable on dual core processor, or you won't get any parallelism. Generally, the mentioned N parameter should correspond to the number of cores for your processor.

In case of need you might want to specify the number of threads directly with help of experimentNumCapabilities, although the real number of parallel threads can depend on many factors.

runExperimentWithExecutor

Arguments

:: (ExperimentRendering r, Monad (ExperimentMonad r), MonadIO (ExperimentMonad r), MonadException (ExperimentMonad r))

=> ([IO ()] -> IO a)

an executor that allows parallelizing the simulation if required

-> Experiment

the simulation experiment to run

-> [ExperimentGenerator r]

generators used for rendering

-> r

the rendering backend

-> Simulation Results

the simulation results received from the model

-> IO (Either SomeException a)

Run the simulation experiment with the specified executor.