Skip to content

Include Forcing Config Files in Python Package#166

Merged
mxkpp merged 1 commit into
ngwpc-candidatefrom
maxkipp-pyproject-add-configs
May 22, 2026
Merged

Include Forcing Config Files in Python Package#166
mxkpp merged 1 commit into
ngwpc-candidatefrom
maxkipp-pyproject-add-configs

Conversation

@mxkpp
Copy link
Copy Markdown

@mxkpp mxkpp commented May 22, 2026

Adds this block to pyproject.toml:

[tool.setuptools.package-data]
"NextGen_Forcings_Engine_BMI" = ["BMI_NextGen_Configs/**/*"]

So that config files are baked-in and do not need to be mounted from the repo files at runtime.

Within the ngen (and nwm-rte) image the config files end up at the following path:

/ngen-app/ngen-python/lib/python3.11/site-packages/NextGen_Forcings_Engine_BMI/BMI_NextGen_Configs/config_templates/

Additions

Removals

Changes

  • Forcing config files are now installed into the Python package's site-packages root.

Testing

Screenshots

Notes

Todos

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Visually tested in supported browsers and devices (see checklist below 👇)
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

  • Linux

…tGen_Forcings_Engine_BMI/BMI_NextGen_Configs/config_templates/)
@mxkpp mxkpp merged commit 46dad0d into ngwpc-candidate May 22, 2026
5 checks passed
@mxkpp mxkpp deleted the maxkipp-pyproject-add-configs branch May 22, 2026 19:30
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