resgroup/wind-up

allow more config to be unspecified in yaml

Open

#68 opened on Sep 18, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (11 forks)auto 404
good first issue

Repository metrics

Stars
 (28 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Locate the pydantic configuration model in the codebase. Identify the three fields: years offset for pre period, ws bin width, years for detrend. Modify the model to make them optional (Optional type) and set their default values (1, 1, 3 respectively). Update any tests that rely on these fields being required.
Tech stack
python
Domain
clidata
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80