search

multiscale / muscle3

The third major version of the MUltiScale Coupling Library and Environment
Apache License 2.0
25 stars 13 forks source link

Documentation for checkpointing functionality #157

Closed maarten-ic closed 1 year ago

maarten-ic commented 1 year ago

Additionally, fixes #139

LourensVeen commented 1 year ago

Looks good, I've fixed a few typos and such, but nothing major. Maybe we should consider reorganising things a bit at some point, and moving the part about defining checkpoints in with the rest of the description of how to run simulations. But we'll get to that at some point.

I really don't want to have the deep dive in the user documentation. How it works is something that the user should never ever have to think about. They use the API, they define checkpoints, they get snapshots, and that's it. So I've cut that off and moved it to a newly wrapped up section for MUSCLE3 developers. And maybe one day we'll write a paper about it, but the users need to worry about their science, not about checkpointing implementations.

I also had some issues with the Python API docs not rendering on RTD, but they seem to have magically disappeared. Oh well, time to merge this!