Communication Protocol stack design

mfahdaz commented 3 years ago

Aspect	Detail
Summary	MVP Design of the Communication Protocol
Task Area	Design
Assignee	@cjimenezromero @sontheimer
Information	A unified interface to transport the diverse nature of data.
Prerequisites	None
Dependencies	#50 #52 #54 #59 #60 #61

Summary

Design of the communication protocol for Co-Simulation, this includes the specification of the protocol stack for:

Steering channel (Probably zeroMQ)
Special purpose (Data channel, MPI)

Tasks

[x] provide first design draft of
- [x] launch and setup of the co-sim environment
- [x] the communication pattern during runtime
- [x] the protocol stack
- [x] the package format
[ ] decide on details with feedback from the team

Requirements

MVP - with TVB-NEST science usecase/showcase:

[x] The system must be able to load necessary parameters and settings before the simulation, and data transfer starts.
[x] The system must be able to receive spikes/rates from a simulator (single node / mock).
[x] The system must be able to convert spikes to rates and vice versa as specified by the science showcase.
[x] The components in the system must be able to run concurrently.
[x] Start and stop as first steering commands defined by the science showcase.
[ ] The received data should be stored in a buffer. This is necessary to allow intermediate processing and transfer in chunks of data rather than a 1:1 mapping from incoming to outgoing package sizes.

Overall:

[x] The system must be able to exchange parameters and settings before the simulation, and data transfer starts
[ ] The system must be able to receive spikes from a simulator running on multiple nodes.
[ ] The system must be able to sort the incoming spikes into spikes per neuron, transpose the data.
[ ] The system must be able to collect the output of the translation software and forward this to a second simulator.
[ ] The data from simulation should be transferred as fast as possible.
[ ] The amount of data sent per time step to analysis could be flexible.
[ ] The user could be able to request data flexible, at different rates and times.
[ ] Simulation Information about the start and the end of the simulation must be exchanged between components.
[ ] The framework should enable data access at arbitrary rates and asynchronous.

Acceptance criteria

MVP: Communication protocol for the science showcase for:

[x] Simulation data (spikes, rates)
[x] Steering commands (start, stop)

Overall: Communication protocol for:

[ ] Simulation data (big data on HPC)
[ ] Steering commands (start, stop, pause, resume, ...)
[ ] Visualization, Analysis (possibly as external plugins)
[ ] Monitoring information (transferred outside of HPC)
[ ] Provenance data

cjimenezromero commented 3 years ago

Aspect	Detail
Summary	MVP Design of the Communication Protocol
Task Area	Design
Assignee
Information
Prerequisites
Dependencies

Summary

Design of the communication protocol for Co-Simulation, this includes the specification of the protocol stack for: Steering channel Data channel

Tasks

Requirements

A large set of requirements are found in the discussion section of this card, to be copied here

Acceptance criteria

w-klijn commented 3 years ago

Copy past of the data collected by Fahad

Plugin
Services
API

A unified interface to transport the diverse nature of data.

Communication types:

Command & Control
HPC communication

Known variations of data to be transported:

Simulation data
Visualization
Steering
Monitoring information
Provenance data

Requirements

The system must be able to receive spikes from a simulator running on multiple nodes.
The system must be able to sort the incoming spikes into spikes per neuron, transpose the data.
The system must be able to format the outgoing spikes into data objects that can be injected directly into the translation software.
The system must be able to collect the output of the translation software and forward this to a second simulator.
The components in the system must be able to run concurrently.
The data from simulation should be transferred as fast as possible
The amount of data sent per time step to analysis could be flexible
The user could be able to request data flexible, at different rates and times
The system must be able to exchange of parameters and settings before the simulation, and data transfer starts
Simulation Information about the start and the end of the simulation must be exchanged between simulation and analysis.
The received data should be stored in a buffer. This is necessary to allow intermediate processing and transfer in chunks of data rather than a 1:1 mapping from incoming to outgoing package sizes.
The framework should enable data access at arbitrary rates and asynchronous.

mfahdaz commented 3 years ago

Another requirement is to facilitate the secure/encrypted communication (e.g. using PKI).

w-klijn commented 3 years ago

The secure /encrypted is to keep in mind. We should not design for

sontheimer commented 3 years ago

Update on the tasks, requirements and acceptance criteria. Split into MVP and general/overall parts. Detailed diagrams and images will be created for internal discussion and a first verion.

sontheimer commented 2 years ago

Next steps:

[ ] Check current status.
[ ] Update Card, description and tasks
[ ] Add (links to) design documents

multiscale-cosim / EBRAINS-cosim