{"data":{"markdownRemark":{"html":"

2.1.0

\n

7th November 2018

\n

This major release of the Simudyne SDK is focused on three main themes:

\n
    \n
  1. Improved data input / output for simulation models.
    2. \n
  2. An enhanced console for better visualisation of agent-based model output.
    3. \n
  3. Better modelling APIs for agent-based models, and the introduction of a new System Dynamics modelling API.
    4. \n
\n

Breaking Changes

\n\n

Licensing

\n

The Simudyne SDK now requires an individually issued license file to operate. This license contains certain characteristics and restrictions, such as validity dates and contractual CPU core limits. This file must be placed and referenced correctly in a Simudyne project for the Simudyne libraries to function. These license files should be requested from Simudyne. Detailed information on licensing restrictions for the SDK can be seen under Licensing Documentation.

\n

Data Import and Export

\n

Data about the current state of a simulation can be retrieved as JSON via the REST API. The Simudyne SDK can also export all simulation data to Parquet files for further analysis.

\n

Console

\n

Network visualisation view

\n

The network visualisation tile has been removed. Network visualisation now has its own tab, which paves the way for enhanced network visualisations and analytics in forthcoming releases.

\n

Agent Attribute Aggregation

\n

Agent attributes can now be aggregated (mean or total) and represented as line charts on the console.

\n

Agent Attribute Time-Series

\n

Agent attributes can be represented as line charts on the console. This allows the user to observe the evolution of an agent attribute (e.g. income) through time.

\n

Tile Search Tool

\n

Tiles are made available through a new search tool, allowing the user to toggle on and off the visualisations they want presented on the console.

\n

Modelling API

\n\n

The default link type BlankLink has been removed. When building links via connectors, link type must always be defined and declared. This has been done to encourage the good modelling practice of naming the defined relationships, as this can become confusing when transitioning from simple models to more complicated ones.

\n

Messaging API

\n

For broadcastMessage, a new fluent API now provides the capability to filter and customise messages sent based on the link the message will be sent along. The capability to broadcast along all link types has been removed, as this was rarely the modeller's intention once multiple link types are defined. Broadcasting along links could cause confusing and unexpected behaviour.

\n
//////\n// 2.0\n//////\ncell.broadcastMessage(new Messages.Aliveness(cell.alive),\n                      Links.Neighbour.class);\n\n// Any message received is inside a wrapper Message type.\nMessage<Messages.Aliveness> m = cell.getMessageOfType(Messages.Aliveness.class);\n\n//////\n// 2.1\n//////\n\n// Using a generic message class.\ncell.getLinks(Links.Neighbour.class)\n    .send(Messages.Aliveness.class, (msg, link) -> msg.alive = cell.alive);\n\n// Using a specialised message class (shown below)\n// Here the value given is assigned into the body\n// of the constructed messages automatically.\ncell.getLinks(Links.Neighbour.class)\n    .send(Messages.Aliveness.class, cell.alive);\n\n// New functionality, customising and filtering messages sent\n// using link information.\ncell.getLinks(Links.Neighbour.class)\n    /* filter messages sent based on link */\n    .filter(link -> link.property < 100)\n    /* can set message body based on link attributes */\n    .send(Messages.Aliveness.class,\n          (msg, link) -> msg.setBody(link.property > some_condition));\n\n// Any message received is now the message type itself\nMessages.Aliveness m = cell.getMessageOfType(Messages.Aliveness.class);
\n

For direct messaging with sendMessage, use the same message construction API based around Agent#send, but use Messaging#to to define the subsequent destination.

\n
//////\n// 2.0\n//////\n\ncell.sendMessage(new Messages.Aliveness(cell.alive), sender);\n\n//////\n// 2.1\n//////\n\ncell.send(Messages.Aliveness.class, cell.alive).to(sender);
\n\n

User-defined message and link types should now extend the built-in Message and Link classes. These classes should not define any constructor that requires parameters. There are also built-in special classes for messages containing a single primitive type, e.g. Message.Boolean, Message.Double, etc. When using these types, there is a convenient shorthand when constructing messages, as shown above.

\n
//////\n// 2.0\n//////\n\npublic class Messages {\n    public static class Aliveness {\n        public boolean alive;\n\n        public Aliveness(boolean alive) {\n            this.alive = alive;\n        }\n    }\n}\n\n//////\n// 2.1\n//////\n\npublic class Messages {\n    // Generic Message\n    public static class Aliveness extends Message {\n        public boolean alive;\n    }\n\n    // Extending the special message class\n    public static class Aliveness extends Message.Boolean {}\n}
\n

Links should similarly extend the Link class. There is currently a single specialisation of link, Link.Empty, that may provide optimisation benefits in the future.

\n

System Dynamics API

\n

System Dynamics is an approach to understand complex nonlinear systems via the creation of stocks, flows, delays, and feedback loops. Originally developed in the 1950's to model industrial or factory processes, it has been used to understand and map large, complex systems to enact policies in the fields of trade, banking, regulation, and more.

\n

A new System Dynamics API has been introduced, allowing users to implement system dynamics models in Simudyne.

\n

Auto-Compilation

\n

The Simudyne auto-compiler allows models to be automatically compiled when changes are made. For now, this must be explicitly enabled via opt-in configuration of the development server.

\n

2.0.5

\n

22nd August 2018

\n

This is a minor improvement release, including a compatibility update for deployment on Spark 2.2.x.

\n

Dependency Changes

\n\n

Module changelogs

\n

core-abm

\n\n

core

\n\n

2.0.4

\n

2nd August 2018

\n

This is a bug-fix release, most importantly fixing issues relating to execution on Spark using YARN.

\n

Dependency Changes

\n\n

Module Changelogs

\n

core-abm

\n\n

nexus-server

\n\n

core-graph-spark

\n\n

2.0.3

\n

26th June 2018

\n

This is a critical bug-fix release relating to deployment on Cloudera Spark clusters.

\n

Dependency Changes

\n\n

console

\n\n

2.0.2

\n

8th June 2018

\n

Breaking Changes

\n

This release is primarily focused on bug fixes but does include a minor API change to be aware of when upgrading. Data injectors for links now receive the agent itself rather than an InitContext. This change allows link attributes to be set based on the agent, and for agents to be altered based on their links. Access to the seeded PRNG and agent ID is then available directly from the agent, e.g. Agent#getPrng().

\n
Group<MyAgent> = generateGroup(MyAgent.class, 100)\n\n// Before\nmyGroup.fullyConnected(otherGroup, MyLink.class,\n    // receives types InitContext and MyLink\n    (initContext, myLink) -> { ... });\n\n// After\nmyGroup.fullyConnected(otherGroup, MyLink.class,\n    // receives types MyAgent and MyLink\n    (myAgent, myLink) -> { ... });
\n

Behavioural Changes

\n

This release includes some improvements which can affect the behaviour of models.

\n\n

Console

\n\n

nexus-server

\n\n

core-abm

\n\n

core-graph

\n

Note that changes within this module should not directly affect any users of the API unless noted under core-abm, unless you are using this lower level implementation directly.

\n\n

2.0.1

\n

17th May 2018

\n

This is a minor bug fix release, primarily resolving issues with the network tile display. Improvements have also been made to the ABM API, allowing more flexible definition of actions, as well as injection of attributes to agents loaded from external sources.

\n

Console

\n\n

core-abm

\n\n

2.0.0

\n

April 19th 2018

\n

First major release of the new Simudyne SDK 2.0.

","headings":[{"value":"2.1.0","depth":2},{"value":"Breaking Changes","depth":3},{"value":"Licensing","depth":3},{"value":"Data Import and Export","depth":3},{"value":"Console","depth":3},{"value":"Network visualisation view","depth":4},{"value":"Agent Attribute Aggregation","depth":4},{"value":"Agent Attribute Time-Series","depth":4},{"value":"Tile Search Tool","depth":4},{"value":"Modelling API","depth":3},{"value":"BlankLink Removal","depth":4},{"value":"Messaging API","depth":4},{"value":"Message and Link Classes","depth":4},{"value":"System Dynamics API","depth":4},{"value":"Auto-Compilation","depth":3},{"value":"2.0.5","depth":2},{"value":"Dependency Changes","depth":3},{"value":"Module changelogs","depth":3},{"value":"core-abm","depth":4},{"value":"core","depth":4},{"value":"2.0.4","depth":2},{"value":"Dependency Changes","depth":3},{"value":"Module Changelogs","depth":3},{"value":"core-abm","depth":4},{"value":"nexus-server","depth":4},{"value":"core-graph-spark","depth":4},{"value":"2.0.3","depth":2},{"value":"Dependency Changes","depth":3},{"value":"console","depth":3},{"value":"2.0.2","depth":2},{"value":"Breaking Changes","depth":3},{"value":"Behavioural Changes","depth":3},{"value":"Console","depth":4},{"value":"nexus-server","depth":4},{"value":"core-abm","depth":4},{"value":"core-graph","depth":4},{"value":"2.0.1","depth":2},{"value":"Console","depth":3},{"value":"core-abm","depth":3},{"value":"2.0.0","depth":2}],"frontmatter":{"title":"History","toc":true,"experimental":null}},"site":{"siteMetadata":{"title":"Simudyne Docs","latestVersion":"2.6"}}},"pageContext":{"absolutePath":"/home/vsts/work/1/s/content/2.2/docs/release-notes/release-history.md","versioned":true,"version":"2.2","kind":"docs","pagePath":"/release-notes/release-history","chronology":{"prev":{"name":"Release Notes","path":"/release-notes"},"next":{"name":"Libraries","path":"/release-notes/libraries"}},"lastUpdated":"2026-04-21T13:56:54.835Z"}}