Merge pull request #40 from firedrakeproject/dolci/readme

Dolci/readme
firedrakeproject · Sep 18, 2023 · c3c50d5 · c3c50d5
2 parents dbbf477 + c32495d
commit c3c50d5
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,5 @@
 # checkpoint_schedules
-Schedules for incremental checkpointing of adjoint simulations.
+*checkpointing_schedules* provides schedules for step-based incremental
+checkpointing of the adjoints to computer models. 
+
+The complete documentation for *checkpoint_schedules* is available at https://www.firedrakeproject.org/checkpoint_schedules/.
diff --git a/docs/source/intro.rst b/docs/source/intro.rst
@@ -3,8 +3,8 @@
 Introduction
 ============
 
-*checkpoint_schedules* is a Python package that provides schedules for incremental checkpointing 
-within adjoint solvers. The schedules are designed by a sequence 
+*checkpointing_schedules* provides schedules for step based incremental
+checkpointing of the adjoints to computer models. The schedules are designed by a sequence 
 of *checkpoint_schedules* actions, namely: *Forward*, *Reverse*, *EndForward*, *EndReverse*,
 *Move*, and *Copy*. In essence, these actions provide functionalities to time advancing the 
 forward and adjoint solvers, checkpoint data storage and retrieval, and indicate the solver