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

Creating versions setting section #1274

Merged
merged 1 commit into from
May 24, 2023
Merged

Creating versions setting section #1274

merged 1 commit into from
May 24, 2023

Conversation

john-science
Copy link
Member

@john-science john-science commented May 23, 2023

Description

Removing metadata section of settings files and creating a "versions" section under settings. Some of the problems this attempts to solve are:

NOTE - This is SORT-OF an API-breaking change. So it comes with an ARMI version bump. However, I expect that it won't actually break anything downstream. It will allow applications and plugins to record their versions when writing a settings YAML file. But... they don't have to or anything.


Checklist

  • This PR has only one purpose or idea.
  • Tests have been added/updated to verify that the new/changed code works.
  • The release notes (location doc/release/0.X.rst) are up-to-date with any bug fixes or new features.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in setup.py.

@john-science
Copy link
Member Author

@drewj-usnctech @albeanth @sombrereau Just FYI.

@john-science
Copy link
Member Author

@opotowsky Even if everyone likes this PR, I will want to talk to you about WHEN will be a good time to merge it. (I think it wouldn't affect downstream applications, but still we'll want to touch base.)

@albeanth
Copy link
Member

I like this PR but I think it will have (very) minor implications on downstream applications. I'll touch base offline.

Copy link
Member

@opotowsky opotowsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! A couple questions.

armi/settings/fwSettings/globalSettings.py Show resolved Hide resolved
armi/settings/settingsIO.py Show resolved Hide resolved
@opotowsky opotowsky merged commit aa6b7f2 into main May 24, 2023
@opotowsky opotowsky deleted the versions_in_settings branch May 24, 2023 15:38
@john-science john-science mentioned this pull request May 24, 2023
7 tasks
drewj-usnctech added a commit to drewj-usnctech/armi that referenced this pull request Jun 1, 2023
* main: (23 commits)
  block converters preserve flags (terrapower#1271)
  Fixed float decimals v3 (terrapower#1283)
  Fixed string format error for snapshots (terrapower#1277)
  Pinning the versions of yamlize and ruamel (terrapower#1281)
  Releasing v0.2.7 (terrapower#1276)
  Creating verisons setting section (terrapower#1274)
  Adding to GlobalFluxOptions docstring (terrapower#1273)
  Harmonize material names and class names (terrapower#1270)
  Removing Component.getMassDensity (terrapower#1266)
  Cleaning up language for our versioning rules (terrapower#1175)
  Fixing the Settings Report in the Docs (terrapower#1264)
  Fixing getTemperatureAtDensity to use non-pseduo density (terrapower#1262)
  Fixing settings report docs from terrapower#1207 (terrapower#1263)
  Update test_components.py (terrapower#1261)
  Update gamma Uniform Mesh Converter (terrapower#1213)
  Updating way that settings report defaults are printed (terrapower#1207)
  Fixing UserPlugins.defineFlag (terrapower#1241)
  quick bug fix for PR 1239 (terrapower#1260)
  New Option to Control Lattice Physics Update Frequency (terrapower#1239)
  Fix a bug in database compare. (terrapower#1258)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Can we move the "version" setting out of metadata? Application version not stored in the database
3 participants