NASA-IMPACT / NASA-IMPACT/veda-docs
Consider adding an example notebook gallery
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 10
- Forks
- 16
- Avg merge
- 2d 31m
- Merged PRs (30d)
- 4
Description
The docs for the scientific compute community at COSIMA - the COSIMA Cookbook - is quite nicely laid out and has the same goal as our docs: to introduce standard practice with data discovery and analysis tooling.
A feature @wildintellect noticed as nice is the example notebook gallery: https://cosima-recipes.readthedocs.io/en/latest/documented_examples.html
Acceptance criteria
- Decided whether we should also add a visual gallery of our example notebooks
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
Review the existing example notebooks and documentation in this repository, then compare their presentation with the COSIMA example notebook gallery linked in the issue. Decide whether a visual gallery fits the project and document the decision, including any scope or presentation approach agreed upon.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100