EDK Examples
The purpose of the EDK examples is to provide worked usage of all aspects of ELARA using the EDK npm package. The source code for all examples can be found in the edk-examples repository.
#
ProjectsSee below for the various project categories and corresponding links.
- Gift Shop: the example as documented in the getting started documentation, demonstrating end-to-end usage to solve complex business problems.
#
General projects- Expression: usage of
Expression
s to manipulate streaming data values. - Events: usage of
Event
s and explicitdate
properties to simulate common business processes.
#
Datasource projects- File: usage of
FileUri
to createCsvDataSource
,XlsxDataSource
,JsonDataSource
to create streamingExpression
values from local files. - FTP: usage of
FtpUri
to createCsvDataSource
,XlsxDataSource
,JsonDataSource
to create streamingExpression
values from remote files. - Procedural: usage of the
RangeDataSource
,ClockDataSource
andArrayDataSource
to create procedural streamingExpression
values . - RESTFul API: usage of a
RestAPIDataSource
to create streamingExpression
values from the Github API - SQL: usage of a
SQLDataSource
to create streamingExpression
values from an example SQL database.
#
Pipeline projects- Pipelines: usage of
Pipeline
s to apply operations such asFilterOperation
,AggregateOperation
,JoinOperation
,SelectOperation
to transform data.
#
Plugin projects- AroFlo: usage of the
AroFloPlugin
to create streamingExpression
values from the AroFlo API. - Deputy: an example documenting usage of the
DeputyPlugin
to create streamingExpression
values from the Deputy API. - Holidays: usage of the
HolidaysPlugin
to create streamingExpression
values of public holiday data. - Kounta: usage of the
KountaPlugin
to create streamingExpression
values from the Kounta API. - Mailchimp: usage of the
MailchimpPlugin
to create streamingExpression
values from the Mailchimp marketing api. - Myob: usage of the
MyobPlugin
to create streamingExpression
values from the MYOB Essentials API. - Profitwell: usage of the
ProfitwellPlugin
to create streamingExpression
values from the Profitwell API. - Shopify: usage of the
ShopifyPlugin
to create streamingExpression
values from the Shopify Admin API for a private app. - Weather: usage of
WeatherPlugin
to create streamingExpression
values from the BOM API and BOM historic data sets. - Xero: usage of the
XeroPlugin
to create streamingExpression
values from the Xero API.
#
Machine learning projects- Machine Learning: usage of
MLFunction
to predict unknown functions from data records.
#
Option projects- Sensitivity: usage sensitivity
Option
s to understand how much impact pricing decisions have on maximising profit. - Automatic: usage of automatic
Option
s to find the optimal pricing choice to maximise profit. - Manual: usage of manual
Option
s to explore the impact of manually adjustying different properties of a sales process. - Queues: usage of automatic
Option
s to optimise a complex queueing process.
#
Application projects- Visuals : an example documenting usage of
Page
s,Visual
s andSeries
s to visualise data in a secure web application.
#
ReferenceFor general usage and code examples we provide the following detailed documentation:
- EDK CLI: detailed CLI usage reference and examples
- EDK API: programmatic api for the cli functionality
#
Release NotesThe following release notes summarise changes accross edk, edk-io package, edk-examples.
Version 3.x.x
- edk/lib:-edk/io:
- Application: - Added `GroupCombinedVisual` to visualise a combination column and line chart on a shared numeric y axes. - Added `VisualList` to allow secondary charts to be shown on a page using drag and drop into existing `PanelVisual` objects - Added `powered`, `ApplicationIcon` and updates to `ApplicationColors` for customised styling of UI. - Add improved UI view download, filtering and sorting- Structure: - Add `Settable``Property` to facilitate event based single-value properties. - Remove `predict` predicate in `Process`, `Resource` and `Agent` entities, to automate seperation of deterministic trajectories from probabilistic trajectories in simulation. - Improve status output for `Optimization`- Plugin: - Added `OptimizationPlugin` to diagnose state and progress of `Optimization`. - Added `OptionsPipelinePlugin` to create a pipeline flattening `Option`, `Value` and `Function` property values across defined scenarios. - Added `PredictionPlugin` to diagnose state and progress of `Prediction`.
- Store: - Added `skip` paramater to skip a number of rows for `top`. - Added `list`, `size` and `top` commands to enable interaction with the file store.
- edk-examples:
- Added customisation of
Application
andVisualList
toVisual Example
in edk-examples. - Update all examples with removal of
predict
predicate inProcess
,Resource
andAgent
entities.
- Added customisation of
- edk/lib:
Version 2.x.x
- edk
- Added
edk add visual
command to manage visual assets. - Added
edk build
speed improvements. - Added
edk links
command to view the relationships to a specificed project asset. - Seperated input/ouput (including detection) related edk functionality into edk-io package.
- Added handling of
uri
schema toedk add datasource
andedk-io detect
. - Added
version
command to view currently installed version ofedk-io
andedk
.
- Added
- edk/lib:
- Pipeline:
- Added
DistributionOperation
to generate grouped distributions in aPipeline
. - Added
OffsetOperation
to select expressions from sorted offset rows in aPipeline
.
- Added
- Structure:
- Add explicit
date
configuration forSingleEvent
andMultipleEvent
.
- Add explicit
- Application:
- Added
RowPivotVisual
to visualise ordered structs in a dense pivot grid. - Improve UI and visual styling
- Improved
Layout
andAxis
definition and helper functions. - Added
RowRidgelineVisual
to visualise high resolution stacked ridgeline charts. - Added
z_overlap
toRowRidgelineVisual
andGroupRidgelineVisual
to control ofz
vertical cutoff. - Added
key
toGroupLineVisual
to generate nested lines. - Improved
Layout
andAxis
definition and helper functions.
- Added
- Datasource:
- Added
uri
schema toDataSource
for generalised specification of the following protocols:ftp://
,sftp://
,http://
,https://
,mssql://
,file://
.
- Added
- Schema:
- Seperate
Visual
into root of schema object.
- Seperate
- Plugin:
- Added `ScenarioFlattenPlugin` to transpose multiple `Scenario` rows into value `Expression`s per `Scenario`. - Added `TimeBoundsPlugin` to calculate the temporal range accross multiple `Table`s.
- Pipeline:
- edk-examples:
- Update
Visual Example
in edk-examples to demonstrateRowPivotVisual
. - Added
Large Example
in edk-examples to demonstrate simulation for large problems. - Added
Queue Example
in edk-examples to demonstrate optimisation of service orientated work. - Added
Event Example
in edk-examples to demonstrate explicit event dates in simulation. - Added
Manual Example
in edk-examples to demonstrate practical use of manual options. - Update
Pipeline Example
in edk-examples to demonstrateOffsetOperation
andDistributionOperation
. - Initial publish of edk-examples.
- Update
- edk
Version 1.x.x
- Initial public release