Skip to content

Commit

Permalink
moving text to versionchanged
Browse files Browse the repository at this point in the history
  • Loading branch information
ljwoods2 committed Oct 9, 2024
1 parent 7535d00 commit f1d9435
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/source/protocol_v3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -483,8 +483,7 @@ Packet order

After the simulation engine sends the `Handshake`_ and `Session info`_
to the receiver and gets back a `Go`_ signal, it begins sending simulation data via
IMD. The data within each IMD frame is always sent in the same, fixed order
in IMDv3. This is a break from IMDv2 in which any packet order is acceptable.
IMD. The data within each IMD frame is always sent in the same, fixed order:

1. Time
2. Energy block
Expand All @@ -497,10 +496,18 @@ If the simulation engine is configured to send only a strict subset of all
available data packets, the fixed order of the list still applies to the
remaining packets in the session.

.. versionchanged:: 3

In IMDv2, any packet order sent by the simulation engine is acceptable
and IMD frames in the same session don't have to contain the same data packets.
For example, an IMD frame in which only energies are sent can be followed by
an IMD frame in which only coordinates are sent. In IMDv3, all packets
specified in the session info must be sent in the same order and for every IMD frame.

Units
-----

Like in IMDv2, the units in IMDv3 are fixed. The simulation engine must convert
The units in IMDv3 are fixed. The simulation engine must convert
values into these units before sending them through the socket.
The receiver must also convert forces it sends back to the simulation
engine into these units.
Expand Down

0 comments on commit f1d9435

Please sign in to comment.