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.

Sign up for GitHub

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

adding more details at README #46

Merged
merged 3 commits into from
Oct 4, 2023
Merged

adding more details at README #46

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5eff321
adding more details at README
Ig-dolci Oct 2, 2023
ccba0a2
Update README.md
Ig-dolci Oct 3, 2023
7437ef2
minor corrections
Ig-dolci Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
# checkpoint_schedules
*checkpointing_schedules* provides schedules for step-based incremental
checkpointing of the adjoints to computer models.
*checkpoint_schedules* provides schedules for step-based incremental
checkpointing of the adjoints to computer models. The schedules contain
instructions indicating the sequence of forward and adjoint steps to be
executed, and the data storage and retrieval to be performed.

The complete documentation for *checkpoint_schedules* is available at https://www.firedrakeproject.org/checkpoint_schedules/.
The schedule instructions are independent of the model implementation,
which enables the model authors to switch between checkpointing algorithms
without recoding their adjoint solvers. Conversely, *checkpoint_schedules*
provides developers of checkpointing algorithms with a direct mechanism to convey
their work to model authors.

## Installation
*checkpoint_schedules* is a Python package and can be installed using pip
```
pip install checkpoint-schedules
```

## Usage
The usage guide of *checkpoint_schedules* is available [here](https://nbviewer.org/github/firedrakeproject/checkpoint_schedules/blob/main/docs/notebooks/tutorial.ipynb).


## Documentation
The complete documentation for checkpoint_schedules is available at [Firedrake project website](https://www.firedrakeproject.org/checkpoint_schedules/).


## License
*checkpoint_schedules* is licensed under the GNU LGPL version 3. See the LICENSE file for details.
Loading