Add notebook automated testing
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Jupyter Notebook
- Stars
- 164
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
As noted in https://github.com/leap-stc/ClimSim/pull/32#issuecomment-1684436061, we currently do not run the notebooks automatically, either at website build time or as part of our CI testing. We should do that eventually to ensure reproducibility, but it will require, at minimum:
- Resolving https://github.com/leap-stc/ClimSim/issues/25 to ensure we know what dependencies are required for each notebook
- Having a smaller subset of data available, as we don't want to pull a large amount of data on every automated run. I believe this will be resolved as part of https://github.com/leap-stc/ClimSim/issues/22.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the discussion in pull request 32 and the dependency and data prerequisites tracked in issues 25 and 22. Define how the notebooks should run at website build time or in CI, then verify that automated runs use documented dependencies and a suitably small dataset while remaining reproducible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- ci-cd, data, testing
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100