Skip to content
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

Merged
merged 15 commits into from
Jan 16, 2023

Conversation

maarten-ic
Copy link
Collaborator

Additionally, fixes #139

@maarten-ic maarten-ic linked an issue Jan 13, 2023 that may be closed by this pull request
@LourensVeen LourensVeen force-pushed the feature/checkpointing_docs branch from 4bb4531 to e1ff028 Compare January 16, 2023 21:37
@LourensVeen
Copy link
Contributor

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!

@LourensVeen LourensVeen merged commit 38ab422 into develop Jan 16, 2023
@maarten-ic maarten-ic deleted the feature/checkpointing_docs branch February 8, 2023 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bullet lists are not correctly rendered
2 participants