Deltares / Deltares/imod-python

create a decorator for functions that remove and then expand auxiliary variables

Open
#909 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
41
Forks
12
Avg merge
21h 8m
Merged PRs (30d)
1

Description

there are several functions (currently in the package class) that call remove_expanded_auxiliary_variables_from_dataset before beginning their "work", and when they are finished they call expand_transient_auxiliary_variables(self).
Examples include the function "mask" and the function "regrid_like"

We could create a decorator to deal with the removing and expanding of auxiliary variables.

Based on a review comment in PR #907

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing PR #907 and the package class functions named in the issue, especially mask and regrid_like. Trace where remove_expanded_auxiliary_variables_from_dataset and expand_transient_auxiliary_variables(self) are called. Done means the repeated handling is represented by a decorator and the affected functions retain the same auxiliary-variable behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.