Skip to content

docs: reorganize installation guide and add HPC documentation#101

Open
yohaimagen wants to merge 9 commits intoymagen/docker-release-imagesfrom
doc-updates
Open

docs: reorganize installation guide and add HPC documentation#101
yohaimagen wants to merge 9 commits intoymagen/docker-release-imagesfrom
doc-updates

Conversation

@yohaimagen
Copy link
Copy Markdown
Collaborator

Documentation: Reorganize Installation and Add HPC Guides

Description

This PR updates and reorganizes the tandem documentation to improve clarity and include detailed instructions for several High-Performance Computing (HPC) systems.

Key Changes:

  • Reorganized Installation Guide: The installation.rst page has been streamlined to focus on manual installation.
  • Dedicated Spack Page: Created spack.rst to house all Spack-related installation and configuration details, including environment module generation.
  • New HPC Section: Added a dedicated hpc/ directory with comprehensive guides for:
    • SuperMUC-NG: Updated with environment setup, Spack repository configuration, branch-specific builds, and SLURM job submission examples.
    • LMU-HPC: for hisenbug and kernelpanic
    • Frontera: Added a guide for installation and compilation on the Frontera system.
  • Indexing Updates: Updated the main Getting Started index to reflect the new structure.

Branch Dependencies & Merge Order

This PR is branched from PR #96, as I added the docs over there for the release Docker images and changed the docs index accordingly. To avoid conflicts, this branch should be merged into #96 first, then merged downstream.

Merge Order Summary:
downstream <- PR #96 <- This PR


@yohaimagen yohaimagen requested a review from JeenaYun April 2, 2026 22:56
@yohaimagen yohaimagen force-pushed the ymagen/docker-release-images branch from c033f48 to c2e5340 Compare April 7, 2026 17:08
Copy link
Copy Markdown
Collaborator

@JeenaYun JeenaYun left a comment

Choose a reason for hiding this comment

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

Hi @yohaimagen, I finished reviewing this PR. Mostly looks great, just a few stale statements need to be removed.

@JeenaYun
Copy link
Copy Markdown
Collaborator

JeenaYun commented Apr 9, 2026

Thanks for addressing all the suggestions. The PR now looks good to me.

@JeenaYun
Copy link
Copy Markdown
Collaborator

JeenaYun commented Apr 9, 2026

@yohaimagen I pushed two commits. The first adds the tandem logo to docs/images and applies it to 1) the README.md file and 2) to the sidebar of the readthedocs page. The other is fixing minor typos in 1) BP6 example mesh generation script (was in meters while needed to use kilometers) and 2) docs/first-model/run-model.rst to correct the usage of mode="QDGreen". Please let me know if any of them need to be fixed.

@yohaimagen
Copy link
Copy Markdown
Collaborator Author

@piyushkarki

This PR is ready to merge. All review comments from @JeenaYun have been addressed, and the latest additions (Tandem logo in README/sidebar and the BP6/run-model typo fixes) look good.

Regarding the CI failures — they are not caused by any change in this PR. The failures in tests 22–27 (pre-clean-test-outputs, generate-test-outputs, etc.) are due to a missing script test/test_data/scripts/cleanup_test_outputs.sh. I am not sure how it popped up, but here we changed only docs-related files and the README

@yohaimagen
Copy link
Copy Markdown
Collaborator Author

See Branch Dependencies & Merge Order in the first message of this PR.

@Thomas-Ulrich
Copy link
Copy Markdown
Collaborator

Thomas-Ulrich commented Apr 10, 2026

Just as a quick note, there was #70
documenting installation for GPU, Leonardo and LUMI.
(but I guess this can be merged later one).

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.

3 participants