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

Removing support for XML Settings files #612

Merged
merged 7 commits into from
Apr 4, 2022

Conversation

john-science
Copy link
Member

@john-science john-science commented Apr 1, 2022

Description

This PR removes support for the XML CaseSettings files. From here on out we will only support the YAML format.

This is meant as a simplification step. You will notice that much code can be removed when dropping this support; and much of the code that is left is simpler.

As part of this "clean out the old stuff we don't use any more" I hope to soon drop support for XML blueprint files, and the old geomFiles.

I think ARMI could be simpler and easier to understand. Dropping complicated support for old, defunct features is an easy win toward this end. For instance, our support for XML input/data file is holding back a PR at this very moment:

#595 (comment)

Also, I think I have seen a lot of activity lately where XML input files and the old geomFiles have made our current work much slower than it needs to be.


Checklist

  • The code is understandable and maintainable to people beyond the author.
  • Tests have been added/updated to verify that the new or changed code works.
  • There is no commented out code in this PR.
  • The commit message follows good practices.
  • All docstrings are still up-to-date with these changes.

If user exposed functionality was added/changed:

  • New or updated dependencies have been added to setup.py.

@john-science john-science added architecture Issues related to big picture system architecture cleanup Code/comment cleanup: Low Priority labels Apr 1, 2022
@john-science
Copy link
Member Author

I have tested this PR against ~30 downstream ARMI-based projects, and all of their unit tests still passed.

@john-science john-science linked an issue Apr 1, 2022 that may be closed by this pull request
@keckler
Copy link
Member

keckler commented Apr 1, 2022

Very happy about this. I will take a detailed look later today, hopefully.

Copy link
Member

@jakehader jakehader left a comment

Choose a reason for hiding this comment

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

Great cleanup! Looks like the depreciation warning was there for a long time so that should've given folks time to migrate as needed.

@john-science john-science merged commit 907f2b4 into terrapower:master Apr 4, 2022
@john-science john-science deleted the rm_xml_settings branch April 4, 2022 23:34
drewj-usnctech added a commit to drewj-usnctech/armi that referenced this pull request Apr 20, 2022
…efine-system-builders

* terrapower/master: (24 commits)
  Update docstring formatting in `getPotentialParentFromSettingValue` (terrapower#627)
  Removing inherited docstrings from Docs (terrapower#628)
  Removing bare "import armi" statements (terrapower#626)
  Fixing assembly number issue in DB Load (terrapower#615)
  Making the app version more available (terrapower#624)
  Adding MPI tests to code coverage (terrapower#625)
  Removing support for XML Settings files (terrapower#612)
  Minor language cleanup in new standards and practices. (terrapower#610)
  remove extraneous `mpicov` arg from tox.ini envlist (terrapower#604)
  Swap flux param (terrapower#605)
  Fixing _fluxSwapParam for NumPy arrays (terrapower#607)
  Unshaped component (terrapower#600)
  Fixing docstring (terrapower#601)
  Adding options to settings report (terrapower#598)
  Adding coding standards and practices to Docs (terrapower#597)
  Removing defunct code from HistoryTrackerInterface (terrapower#594)
  Fix to a bug where an ARMI application could not call (terrapower#593)
  Tracking ARMI Requirements (terrapower#590)
  Remove PyYaml Dependency (terrapower#586)
  Filling out code coverage for entry points (terrapower#587)
  ...
albeanth pushed a commit to albeanth/armi that referenced this pull request Apr 21, 2022
scottyak pushed a commit to scottyak/armi that referenced this pull request Oct 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
architecture Issues related to big picture system architecture cleanup Code/comment cleanup: Low Priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Can we remove XML Settings file Support?
3 participants