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

Open-Source ARMI's Requirements #2064

Open
john-science opened this issue Jan 28, 2025 · 0 comments · May be fixed by #2076
Open

Open-Source ARMI's Requirements #2064

john-science opened this issue Jan 28, 2025 · 0 comments · May be fixed by #2076
Assignees
Labels
complex Expected to be a complex issue documentation Improvements or additions to documentation

Comments

@john-science
Copy link
Member

ARMI has requirements. And there are crumbs pointing to this requirements throughout the ARMI codebase. e.g.

armi/armi/runLog.py

Lines 505 to 507 in 3049a0c

.. impl:: A simulation-wide log, with user-specified verbosity.
:id: I_ARMI_LOG
:implements: R_ARMI_LOG

But this is an incomplete picture of the ARMI requirements to the open-source community.

I recommend the following steps:

  1. Open-Source the ARMI requirements, and put them in the docs
  2. Add SQA docs to the ARMI docs (SRSD, SDID, STR, and SCR)
  3. Modify the ARMI PR process so the PR Review always includes a review of requirement/SQA-related changes
    • Institute a rolling SCR with every PR
  4. Move from our current "release notes" strategy to something to dovetails or streamlines with the SCR.

On the one hand, this might put a lot of things in that docs that many open-source users don't want to see. One the other hand, it will increase visibility and communicate the ARMI project better to the public.

@john-science john-science added complex Expected to be a complex issue documentation Improvements or additions to documentation labels Jan 28, 2025
@john-science john-science self-assigned this Jan 28, 2025
@john-science john-science linked a pull request Feb 5, 2025 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complex Expected to be a complex issue documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant