Skip to content

ORCA: Genoa/Milan examples, NUMA settings, benchmarking tool link - #1485

Merged
geoffreyweal merged 5 commits into
mainfrom
orca-updates
Nov 19, 2026
Merged

geoffreyweal merged 5 commits into
mainfrom
orca-updates

Conversation

@geoffreyweal

@geoffreyweal geoffreyweal commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

What changed and why

The ORCA page's example script predates the NUMA Domains page. This brings the page in line with it, the same way #1484 does for VASP, and shortens the rest of the page.

  • Example batch scripts: one for Genoa and one for Milan, with the NUMA settings from the NUMA Domains page (the four #SBATCH options, the two export lines and the print_binding_stats step). They also gain --account, module purge and the default-version macro.
  • Input file settings (was "Requesting a parallel run"): moved up next to the examples, and now sets %maxcore as well as %pal. ORCA's default %maxcore is 4096 MB per core, and ORCA can use more than %maxcore, while the examples ask for 1 GB per core. Without it, larger calculations could run out of memory.
  • NUMA settings (new section): Genoa and Milan tabs with the NUMA lines from the example scripts, what they are for, and the print_binding_stats command with a link to how to read its output. The detail stays on the NUMA Domains page.
  • Benchmark your ORCA jobs (new section): points to the ORCA benchmarking tool, which holds its own instructions.
  • Checkpointing: now a top-level section, as "Further notes" is gone. Shorter, filenames in backticks, the restart lines in the manual's form, and a link to the manual's restart section. Its anchor is unchanged, so the link from Job Checkpointing still works.
  • Removed: the intro paragraph and homepage link. The app header already shows both, so the page showed them twice.
  • Licensing: shorter, with the same meaning. Its "ORCA licence" link returned 404 and is removed.

Page to look at on the preview site: Software → Supported Applications → ORCA.

Needs a decision

The page says ORCA's licence allows academic research only. The FACCTs ORCA page now says "ORCA is and will remain free for academic and personal use". I left the page's wording as it was. I also found no current URL for the licence text itself to replace the dead link.

Sources

Fact Source
The four #SBATCH options, the two export lines and the print_binding_stats command docs/Software/Parallel_Computing/NUMA_Domains.md. The command is copied byte for byte.
Cores per NUMA domain (21 on Genoa, 16 on Milan) slurm_limits.cpu_nodes macros, from docs/assets/slurm-limits.json
ORCA module version applications.ORCA.default macro, from docs/assets/module-list.json
NUMA domains can slow a job or make its runtime vary NUMA Domains page, "When NUMA domains matter"
%maxcore is per core in MB, defaults to 4096, ORCA can use more, give it about 80% of the memory ORCA 6.1 tutorial: Memory Settings
With --threads-per-core 1, --mem-per-cpu is memory per physical core docs/Software/Parallel_Computing/Simultaneous_Multithreading.md
GBW renaming, ! moread / %moinp, older GBW files ORCA 6.1.1 manual, 2.20.5 Restarting SCF Calculations
The app header already shows the description and homepage overrides/partials/app_header.html, and the built page, which had each twice
What the benchmarking tool does Its README

The links into the NUMA Domains page use anchors that exist both on main and in #1483.

- Example batch scripts for Genoa and Milan, with the NUMA settings from
  the NUMA Domains page, --account, module purge and the version macro
- New "NUMA settings" section that links to the NUMA Domains page
- New "Benchmark your ORCA jobs" section that links to the ORCA
  benchmarking tool
- Fix the <np> placeholder, a typo in the checkpointing warning and
  "file name", and simplify "Requesting a parallel run"

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Test deployment successful!! (2026-11-16T03:11:55Z)
Preview available at https://callumwalley.github.io/mkdocs-demo-deploy/nesi/support-docs/orca-updates

Seems the following pages differ;



See all deployed demo sites

@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

⚠️ 3 Warnings

docs/Software/Available_Applications/ORCA.md (3)
Line Check Message
55 meta: code_line_length Code line is 356 characters long, so it will scroll sideways. Code blocks fit about 80 characters.
86 meta: code_line_length Code line is 356 characters long, so it will scroll sideways. Code blocks fit about 80 characters.
157 meta: code_line_length Code line is 356 characters long, so it will scroll sideways. Code blocks fit about 80 characters.

ℹ️ 1 Notices

docs/Software/Available_Applications/ORCA.md (1)
Line Check Message
18 meta: section_length Section 'Licensing requirements' is only ~329 chars. Sections under 400 will be lumped into the next section when parsed by the RAG.

See the Checks tab for the full output.

geoffreyweal and others added 4 commits November 12, 2026 18:56
- Add %maxcore to the input file settings, at about 80% of
  --mem-per-cpu. ORCA's default (4096 MB per core in ORCA 6.1) is more
  than the examples ask for, and ORCA can use more than %maxcore
- Move the %pal line up next to the examples, as "Input file settings"
- Remove the intro paragraph and homepage link, which the app header
  already shows
- Shorten the licensing text and remove its licence link, which
  returns 404
- Make Checkpointing a top-level section and shorten it, put filenames
  in backticks (fixes the 'inp' spelling warning), and link the ORCA
  manual's restart section

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Add Genoa and Milan tabs to "NUMA settings" with the four #SBATCH
  options and the two export lines from the example batch scripts
- Show the print_binding_stats command under its explanation

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@geoffreyweal
geoffreyweal marked this pull request as ready for review November 16, 2026 03:13
@geoffreyweal
geoffreyweal merged commit c50b1a1 into main Nov 19, 2026
13 of 15 checks passed
@geoffreyweal
geoffreyweal deleted the orca-updates branch November 19, 2026 01:12
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