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 #157

Closed ascibisz closed 12 months ago

ascibisz commented 1 year ago

Problem

It'd be nice to have simularium data objects that are designed for providing frame data for a trajectory, so that the octopus repo doesn't have to define it's own. Should match what is defined in this miro board under "New SimulariumIO Data Types (pseudo code)"

Ticket

There will be a forthcoming PR for using these new data objects in Octopus

Type of change

codecov-commenter commented 1 year ago

Codecov Report

Attention: 14 lines in your changes are missing coverage. Please review.

Comparison is base (983c99b) 92.56% compared to head (4eec799) 93.05%. Report is 60 commits behind head on main.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #157 +/- ## ========================================== + Coverage 92.56% 93.05% +0.49% ========================================== Files 101 106 +5 Lines 4546 4941 +395 ========================================== + Hits 4208 4598 +390 - Misses 338 343 +5 ``` | [Files](https://app.codecov.io/gh/simularium/simulariumio/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None) | Coverage Δ | | |---|---|---| | [simulariumio/data\_objects/\_\_init\_\_.py](https://app.codecov.io/gh/simularium/simulariumio/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-c2ltdWxhcml1bWlvL2RhdGFfb2JqZWN0cy9fX2luaXRfXy5weQ==) | `100.00% <100.00%> (ø)` | | | [simulariumio/data\_objects/frame\_data.py](https://app.codecov.io/gh/simularium/simulariumio/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-c2ltdWxhcml1bWlvL2RhdGFfb2JqZWN0cy9mcmFtZV9kYXRhLnB5) | `100.00% <100.00%> (ø)` | | | [simulariumio/tests/test\_simularium\_file\_data.py](https://app.codecov.io/gh/simularium/simulariumio/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-c2ltdWxhcml1bWlvL3Rlc3RzL3Rlc3Rfc2ltdWxhcml1bV9maWxlX2RhdGEucHk=) | `100.00% <100.00%> (ø)` | | | [simulariumio/data\_objects/trajectory\_data.py](https://app.codecov.io/gh/simularium/simulariumio/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-c2ltdWxhcml1bWlvL2RhdGFfb2JqZWN0cy90cmFqZWN0b3J5X2RhdGEucHk=) | `97.05% <75.00%> (+0.18%)` | :arrow_up: | | [simulariumio/data\_objects/binary\_data.py](https://app.codecov.io/gh/simularium/simulariumio/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-c2ltdWxhcml1bWlvL2RhdGFfb2JqZWN0cy9iaW5hcnlfZGF0YS5weQ==) | `97.22% <97.22%> (ø)` | | | [simulariumio/data\_objects/json\_data.py](https://app.codecov.io/gh/simularium/simulariumio/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-c2ltdWxhcml1bWlvL2RhdGFfb2JqZWN0cy9qc29uX2RhdGEucHk=) | `93.87% <93.87%> (ø)` | | | [simulariumio/data\_objects/simularium\_file\_data.py](https://app.codecov.io/gh/simularium/simulariumio/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-c2ltdWxhcml1bWlvL2RhdGFfb2JqZWN0cy9zaW11bGFyaXVtX2ZpbGVfZGF0YS5weQ==) | `71.42% <71.42%> (ø)` | | ... and [24 files with indirect coverage changes](https://app.codecov.io/gh/simularium/simulariumio/pull/157/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.