simularium / simulariumio

Python package that converts simulation outputs to the format consumed by the Simularium viewer website
Apache License 2.0
5 stars 3 forks source link

Add New Data Types for Simularium Frame Data #151

Closed ascibisz closed 12 months ago

ascibisz commented 1 year ago

Use Case

As an octopus developer, I would like to have data types to represent simularium file data, which should live in simulariumio. Although there are some differences between how binary and json simularium data is stored, there should be a universal set of functions that developers can call to get specific frames, the number of frames, overall file contents, etc.

Acceptance Criteria

Build classes in SimulariumIO that are described in this miro board, under "New SimulariumIO Data Types (pseudo code)"

Add tests for these new data objects

Push a new release of simulariumio