Skip to content

Conversation

@landinjm
Copy link
Contributor

@landinjm landinjm commented Feb 9, 2026

  • Please check if the PR fulfills these requirements
  • The PR follows our guidelines (formatting & style)
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    Created a new IO parameters file where all IO parameters will live. Currently, only the field output parameters have been written.

  • What is the current behavior? (You can also link to an open issue here)
    Currently, parameters are declared in InputFileReader, read inUserInputParameters, and packaged into their respective parameter subclasses. This is a bad way to do it because you have to edit and understand several files in order to add parameters. This makes is burdensome and more difficult to unit test individual parameter files. They are also interlinked, which adds to the issue.

  • What is the new behavior (if this is a feature change)?
    Now, each parameter class does five things.

  1. Declare parameters
  2. Read parameters
  3. Postprocess parameters
  4. Validate parameters
  5. Package parameters into a minimal struct

This allows us to do the following things more easily

  • Write unit tests
  • Add new parameters
  • Let users avoid using parameters.prm entirely

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant