Skip to content

Commit

Permalink
Merge pull request #46 from firedrakeproject/dolci/improve_readme
Browse files Browse the repository at this point in the history
adding more details at README
  • Loading branch information
Ig-dolci authored Oct 4, 2023
2 parents b139d3f + 7437ef2 commit 72e4fa6
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
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.

0 comments on commit 72e4fa6

Please sign in to comment.