Matching step is public under three different names on model results
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Refactor
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- developer-experience
Research direction
Read the match() implementations and the PointModelResult, TrackModelResult, and VerticalModelResult APIs to locate calls to interp_time, subset_to, and align. Make those methods private while keeping extract public; check that matching still works and the API reference no longer presents those methods as public.
Written by the indexing model from the issue text.
Description
Matching a model result to an observation is one step, but each model result type exposes it publicly under its own name:
| type | method |
|---|---|
PointModelResult |
interp_time(observation, **kwargs) |
TrackModelResult |
subset_to(observation, *, spatial_tolerance) |
VerticalModelResult |
align(vo, temporal_tolerance=None) |
DfsuModelResult, GridModelResult, NetworkModelResult, DummyModelResult |
extract(observation, spatial_method=None) |
interp_time, subset_to and align are called only from match(), take arguments that match() normally sets, and return different things (a model result, or an xr.Dataset). They show up in tab completion and in the API reference (PointModelResult, VerticalModelResult), where a user sees four ways to do what match() already does.
extract is different: it turns a spatial model result into a point/track one, which is useful on its own.
Proposal: make interp_time, subset_to and align private. Keep extract public.
- Dominant language
- Python
- Stars
- 58
- Forks
- 10
- Avg merge
- 28m
- Merged PRs (30d)
- 1
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from DHI/modelskill
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
DHI/modelskill#731 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 69/100
DHI/modelskill#728 ·
Maintainers usually reply within 1 day
-
NSE and R2 return 1.0 when model values are NaNMay be free again A pull request for this issue was closed without being merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
DHI/modelskill#720 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
DHI/modelskill#628 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
DHI/modelskill#734 ·
Maintainers usually reply within 1 day
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
fossasia/visdom-dev#77 ·
Maintainers usually reply within 4 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
aws-cloudformation/cfn-lint#4890 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
volcengine/OpenViking#6521 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
AstrBotDevs/AstrBot#10720 ·
Maintainers usually reply within 1 day