Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve "sfincs.inp" file #212

Open
roeldegoede opened this issue Aug 28, 2024 · 1 comment
Open

Improve "sfincs.inp" file #212

roeldegoede opened this issue Aug 28, 2024 · 1 comment
Labels
Enhancement New feature or request Needs refinement Issue still needs refinement

Comments

@roeldegoede
Copy link
Collaborator

Kind of request

Changing existing functionality

Enhancement Description

Make the general input file more user-friendly, e.g.:

  • Only keep often used numerical parameters
  • Maybe add the parameters for extra output (and put the defaults to 0)
  • Add descriptions and unit as comments to the file (should first be supported by SFINCS)

Use true/false instead of 1,0.

Maybe have the possibility to write a full input file or an input file with often-used parameters.

Use case

Each model

Additional Context

To be discussed with SFINCS development team

@roeldegoede roeldegoede added Enhancement New feature or request Needs refinement Issue still needs refinement labels Aug 28, 2024
@DirkEilander
Copy link
Contributor

Pydantic_settings could really simplify and add a nice layer of validation to the current sfincs.inp functionality. You can use this to set default values, parse input to the right format (e.g. bool instead of 1), add descriptions to the settings for online documentation, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request Needs refinement Issue still needs refinement
Projects
None yet
Development

No branches or pull requests

2 participants