search

charmplusplus / charm

The Charm++ parallel programming system. Visit https://charmplusplus.org/ for more information.
Apache License 2.0
199 stars 50 forks source link

CkIO documentation and cleanup #3805

Closed mayantaylor closed 2 months ago

mayantaylor commented 2 months ago

Adding CkIO Input documentation to the Charm++ readthedocs and updating relevant comments to address #1521 . This should be basically complete for the current status of CkIO in main. Mat implemented a FileReader streaming abstraction as well (not merged yet) - should that be merged in for this release? In this case, we should add these docs.

mayantaylor commented 2 months ago

Decided not to add FileReader impl/docs in this PR. Will add future PR for this work.

mayantaylor commented 2 months ago

We should also mention that one requirement to use CkIO input is that the file must be seekable. This is how the buffer chares find where they should read the data from and thus it won't work if the file is not seekable. Just my two cents though

Added a sentence for this disclaimer under the CkIO Overview.