checkpoint_schedules

Authors:: Daiane I. Dolci, James R. Maddison, David A. Ham, Guillaume Pallez, Julien Herrmann
Contact:: d.dolci@imperial.ac.uk
GitHub:: https://github.com/firedrakeproject/checkpoint_schedules
Date:: Oct 24, 2024

Quickstart

If you want to quickly get up and running with checkpoint_schedules your adjoint problem, follow these steps:

Install checkpoint_schedules via pip
```
$  pip install checkpoint-schedules
```
Familiarise with checkpoint_schedules by acessing the introduction.
Go through to an illustrative example that explains the usage of checkpoint_schedules for step-based incremental checkpointing of the adjoints.
See here for an adjoint problem solved using checkpoint_schedules.

API documentation

The complete list of all the classes and methods in checkpoint_schedules is available at the API reference.

Contributing

We welcome contributions to checkpoint_schedules! To contribute please consider the following steps:

Fork the repository.
Make your changes.
Make sure that the tests pass by running pytest test and pytest –nbval-lax docs/notebooks/.
Add tests for your changes (if applicable).
Add documentation for your changes that follows the Sphinx format.
Submit a pull request.

Bug reports

Please report bugs on the issue tracker.

Citing

If you use checkpoint_schedules in your research, please cite JOSS paper.