checkpoint_schedules
checkpoint_schedules: schedules for incremental checkpointing of adjoint simulations - Published in JOSS (2024)
Science Score: 100.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 4 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
3 of 4 committers (75.0%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Schedules for incremental checkpointing of adjoint simulations.
Basic Info
- Host: GitHub
- Owner: firedrakeproject
- License: lgpl-3.0
- Language: Python
- Default Branch: main
- Size: 985 KB
Statistics
- Stars: 4
- Watchers: 22
- Forks: 2
- Open Issues: 1
- Releases: 4
Metadata Files
README.md
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:
1. Fork the repository.
2. Make your changes.
3. Make sure that the tests pass by running pytest test and pytest --nbval-lax docs/notebooks/
4. Add tests for your changes (if applicable).
5. Add documentation for your changes that follows the Sphinx format.
6. 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
.
Owner
- Name: Firedrake
- Login: firedrakeproject
- Kind: organization
- Email: firedrake@imperial.ac.uk
- Website: https://www.firedrakeproject.org
- Repositories: 45
- Profile: https://github.com/firedrakeproject
JOSS Publication
checkpoint_schedules: schedules for incremental checkpointing of adjoint simulations
Authors
Department of Mathematics, Imperial College London, London, United Kingdom.
School of Mathematics and Maxwell Institute for Mathematical Sciences, The University of Edinburgh, United Kingdom.
Department of Mathematics, Imperial College London, London, United Kingdom.
Inria, University of Rennes, Rennes, France.
CNRS, IRIT, Université de Toulouse, Toulouse, France.
Editor
Patrick Diehl
Tags
Checkpointing methods Adjoint-based gradientCitation (CITATION.cff)
cff-version: "1.2.0"
authors:
- family-names: Dolci
given-names: Daiane I.
orcid: "https://orcid.org/0000-0002-1435-9538"
- family-names: Maddison
given-names: James R.
orcid: "https://orcid.org/0000-0001-5742-4363"
- family-names: Ham
given-names: David A.
orcid: "https://orcid.org/0000-0001-9545-9110"
- family-names: Pallez
given-names: Guillaume
orcid: "https://orcid.org/0000-0001-8862-3277"
- family-names: Herrmann
given-names: Julien
orcid: "https://orcid.org/0000-0003-4935-2368"
doi: 10.5281/zenodo.10817312
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Dolci
given-names: Daiane I.
orcid: "https://orcid.org/0000-0002-1435-9538"
- family-names: Maddison
given-names: James R.
orcid: "https://orcid.org/0000-0001-5742-4363"
- family-names: Ham
given-names: David A.
orcid: "https://orcid.org/0000-0001-9545-9110"
- family-names: Pallez
given-names: Guillaume
orcid: "https://orcid.org/0000-0001-8862-3277"
- family-names: Herrmann
given-names: Julien
orcid: "https://orcid.org/0000-0003-4935-2368"
date-published: 2024-03-22
doi: 10.21105/joss.06148
issn: 2475-9066
issue: 95
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 6148
title: "checkpoint_schedules: schedules for incremental checkpointing
of adjoint simulations"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.06148"
volume: 9
title: "checkpoint_schedules: schedules for incremental checkpointing of
adjoint simulations"
GitHub Events
Total
- Create event: 4
- Issues event: 2
- Release event: 1
- Watch event: 1
- Issue comment event: 4
- Push event: 9
- Pull request review comment event: 2
- Pull request review event: 3
- Pull request event: 5
Last Year
- Create event: 4
- Issues event: 2
- Release event: 1
- Watch event: 1
- Issue comment event: 4
- Push event: 9
- Pull request review comment event: 2
- Pull request review event: 3
- Pull request event: 5
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Iglesia Dolci | d****i@g****m | 381 |
| James R. Maddison | j****n@e****k | 17 |
| David A. Ham | D****m@i****k | 5 |
| Daniel S. Katz | d****z@i****g | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 21
- Total pull requests: 53
- Average time to close issues: about 1 month
- Average time to close pull requests: 4 days
- Total issue authors: 3
- Total pull request authors: 4
- Average comments per issue: 1.24
- Average comments per pull request: 0.28
- Merged pull requests: 49
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 4
- Average time to close issues: about 13 hours
- Average time to close pull requests: 3 days
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 2.0
- Average comments per pull request: 0.5
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jrmaddison (13)
- Ig-dolci (3)
- matt-graham (2)
Pull Request Authors
- Ig-dolci (48)
- jrmaddison (13)
- dham (2)
- danielskatz (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 2,438 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 7
- Total maintainers: 2
pypi.org: checkpoint-schedules
Schedules for incremental checkpointing of adjoint simulations.
- Homepage: https://www.firedrakeproject.org/checkpoint_schedules/
- Documentation: https://checkpoint-schedules.readthedocs.io/
- License: LGPL-3.0
-
Latest release: 1.0.4
published about 1 year ago
Rankings
Dependencies
- actions/checkout v3 composite
- actions/setup-python v3 composite
- actions/checkout v3 composite
- actions/deploy-pages v2 composite
- actions/setup-python v3 composite
- actions/upload-pages-artifact v1 composite
- actions/checkout v3 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite
- actions/checkout v3 composite
- actions/setup-python v1 composite
- rbialon/flake8-annotations v1 composite
- numpy *