resgroup / resgroup/wind-up

allow more config to be unspecified in yaml

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

Nobody has claimed this yet.

good first issue
Dominant language
Python
Stars
29
Forks
11
Avg merge
1d 9h
Merged PRs (30d)
11

Description

I was setting up a northing analysis today and tried to run with a yaml missing the below three settings, thinking they would just use suitable defaults. The analysis failed with a pydantic validation error unless these settings were populated in my yaml. It would be nice to not have to specify these in every yaml because they are rarely set to a non-default value.

  • years_offset_for_pre_period (default should be 1)
  • ws_bin_width (default should be 1)
  • years_for_detrend (default should be 3)

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

Search the configuration model and YAML validation code for years_offset_for_pre_period, ws_bin_width, and years_for_detrend. Confirm that omitted values are accepted with defaults of 1, 1, and 3, then run the existing configuration or analysis tests to verify YAML files without these settings succeed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.