checkpoint_schedules
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 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.
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 testandpytest --nbval-lax docs/notebooks/ - Add tests for your changes (if applicable).
- Add documentation for your changes that follows the Sphinx format.
- Submit your pull request.
Bug reports
Please report bugs on the issue tracker.
Documentation
The complete documentation for checkpoint_schedules is available at Firedrake project website.
License
checkpoint_schedules is licensed under the GNU LGPL version 3. See the LICENSE file for details.
Citation
If you use checkpoint_schedules in your research, please cite this paper
Release files for checkpoint-schedules 1.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| checkpoint_schedules-1.0.4.tar.gz | 34.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| checkpoint_schedules-1.0.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 76.5 kB
Release files / checkpoint_schedules-1.0.4.tar.gz
| Download URL | checkpoint_schedules-1.0.4.tar.gz |
|---|---|
| Size | 34.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
aaa9191a6da910fd1b1e0526df2ca7ecea04823fe5106360e3e23d2413dcfeeb
|
|
BLAKE2b-256 checksum How to use checksums |
c709485ed5ffc5ddf615118b6660c6a8c18430432ed0a170a0d21bd2dbb42583
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.10
|
Release files / checkpoint_schedules-1.0.4-py3-none-any.whl
| Download URL | checkpoint_schedules-1.0.4-py3-none-any.whl |
|---|---|
| Size | 41.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9191409c8fbb9710345111b99163e312a9779d73ae6d593a638ecdf48c0dfa59
|
|
BLAKE2b-256 checksum How to use checksums |
4ca0e4579dbaff503194a3c97a7bd241e65501aa547129a4c9d2a60dc807b2ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.10
|
Security for checkpoint-schedules 1.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
