-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation for checkpointing functionality #157
Conversation
Also bump RTD python version to 3.8
4bb4531
to
e1ff028
Compare
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! |
Additionally, fixes #139