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

Progress callback #118

Closed blairlyons closed 1 year ago

blairlyons commented 2 years ago

Use Case

As a front end developer working on autoconversion, I want to get reports on conversion progress.

Acceptance Criteria

For any conversion, if given a callback function, call it at a given progress interval, providing the current percent progress.

Details

For large datasets, especially ones that are being autoconverted over the network with a user waiting at the client website, having a report on progress would be helpful.

For converters that parse text files, determine current progress based on current line out of total lines in input txt file.