MetOffice / MetOffice/PyPRECIS
Make notebooks domain agnostic
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 20
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Currently the notebooks have a lot of hard-coded content that references SE Asia. We should aim to make the notebooks more agnostic to the input (CORDEX) data being used, so these notebooks feel more relevant to learners.
This issue is to discuss how we could do this. The major options are:
1. Create bespoke version of a principal repo, which is hard-coded to be specific to a set of learners.
2. Abstract file name, regions etc. into a top-level configuration file which can be edited by learners to tailor the main repo to their country/domain of choice.
Contributor guide
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 notebooks to catalogue hard-coded SE Asia references, including file names and regions, and understand how CORDEX input data is selected. Compare the bespoke-repository and top-level-configuration options; done means the chosen approach is agreed and the notebooks can be adapted to another country or domain without changing their core content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- data, documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100