Skip to content

Re-work installation instructions#32971

Draft
loganharbour wants to merge 18 commits into
idaholab:nextfrom
loganharbour:better_install
Draft

Re-work installation instructions#32971
loganharbour wants to merge 18 commits into
idaholab:nextfrom
loganharbour:better_install

Conversation

@loganharbour
Copy link
Copy Markdown
Member

@loganharbour loganharbour commented May 20, 2026

Reason

The installation instructions are very out of date and need improvement.

Design

  • Separate user instructions (pre-built binaries) and developer instructions (build in-tree)
  • Explicitly state which configurations are tested
  • Setup instructions to be more compatible with including into other applications
  • Add documentation on the general use of Apptainer

Impact

Could possibly lead to ambiguity and issues with getting users started if docs aren't clear. Otherwise, it should improve the installation process due to being more detailed and explicit.

@moosebuild
Copy link
Copy Markdown
Contributor

moosebuild commented May 20, 2026

Job Documentation, step Docs: sync website on 54bef88 wanted to post the following:

View the site here

This comment will be updated on new commits.

@moosebuild
Copy link
Copy Markdown
Contributor

moosebuild commented May 20, 2026

Job Coverage, step Generate coverage on 54bef88 wanted to post the following:

Framework coverage

Coverage did not change

Modules coverage

Coverage did not change

Full coverage reports

Reports

This comment will be updated on new commits.

@moosebuild
Copy link
Copy Markdown
Contributor

Job Precheck, step Python: black format on ed1a470 wanted to post the following:

Python black formatting

Your code requires style changes.

A patch was generated and copied here.

You can directly apply the patch by running the following at the top level of your repository:

curl -s https://mooseframework.inl.gov/docs/PRs/32971/black/black.patch | git apply -v

Alternatively, you can run the following at the top level of your repository:

black --config pyproject.toml --workers 1 .

@moosebuild
Copy link
Copy Markdown
Contributor

Job Test, step Results summary on 54bef88 wanted to post the following:

Framework test summary

Compared against c6cf665 in job civet.inl.gov/job/3863056.

No change

Modules test summary

Compared against c6cf665 in job civet.inl.gov/job/3863056.

No change

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.

2 participants