MetOffice / MetOffice/PyPRECIS

follow approach of scitools/iris course for examples

Open
#141 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
20
Forks
2
PR merge metrics
No merged PRs in 30d

Description

In the scitools courses e.g. https://github.com/SciTools/courses/blob/master/course_content/iris_course/1.The_Iris_Cube.ipynb

the approach is to put each example in it's own file, and then include a way to load it inside the relevant worksheet using:

SAMPLE SOLUTION:
Un-comment and execute the following, to view a possible solution, and some code.
Then run it ...

```
# SAMPLE SOLUTION
# %load solutions/iris_exercise_1.2a
```

this has two advantages:
1. it makes it easier for the user to access the relevant answers
2. it make it easier to test (no need to cut and paste the solutions in)

Contributor guide

Open the contributing guide

Research direction

Start by comparing the referenced course_content/iris_course/1.The_Iris_Cube.ipynb with the relevant PyPRECIS worksheets and examples. Use the solutions/iris_exercise_1.2a loading pattern as the model, and consider the work complete when examples are separately accessible, loadable from the worksheets, and runnable without manual copy-and-paste.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.