Software page layout

Keep version lists, product metadata and installation details in the generated All Package Index includes. See All Package Index and generated includes for the available includes and Style Guide for writing conventions.

A typical handwritten software guide contains:

  • A software guidance date and the generated sidebar above the page title, with a unique reference label immediately before the title.

  • A short description of the software.

  • A Usage section with the shared interactive-session guidance, generated module list and package-specific commands.

  • An example batch submission script when it is relevant to the software.

  • Installation notes using the generated installation and dependency includes.

Keep the sections relevant to the package; a command-line build tool does not need a solver batch script. Explain any additional dependencies or resource requirements beside the commands they affect.

A handwritten guide can also reuse a custom include when the same guidance belongs on the generated package page, avoiding duplicate instructions.

Package guide labels

For a Stanage package guide, use the package identifier from its generated include filename, such as gromacs in gromacs-sdbr-el9-icelake-znver-stanage.rst. Use lower case, replace each run of punctuation with an underscore, remove any leading or trailing underscores, and append _stanage. For example, GROMACS uses gromacs_stanage and intel-compilers uses intel_compilers_stanage. Place the label immediately above the guide title:

.. _gromacs_stanage:

GROMACS
=======

The documentation build checks for this label and links the generated package page’s notice to the guide when it exists. Otherwise, the generated notice is retained. Keep labels unique and preserve existing labels used by other pages; add an alias when necessary. Filenames do not need to change.

For a package with several guides, put the package label on the overview. For example, ansys_stanage belongs on the Ansys overview, not the Fluent, Mechanical or LS-DYNA pages. A shared guide can provide labels for several packages, placed above the relevant titles or section headings. Guides without a corresponding generated package, such as locally installed Python packages, can retain their own descriptive labels.

Example source

This example uses CMake to show the normal layout without a batch section. The page reference label is immediately above the title, after the sidebar include. See the CMake guide for the maintained usage instructions.

:guidance_last_updated: 2026-10-12

.. include:: /referenceinfo/imports/stanage/packages/cmake-sdbr-el9-icelake-znver-stanage.rst

.. _cmake_stanage:

CMake
=====

CMake is a build tool commonly used when compiling other libraries.

Usage
-----

.. include:: /referenceinfo/imports/scheduler/SLURM/common_commands/srun_start_interactive_session_import_stanage.rst

CMake can be loaded with one of:

.. include:: /referenceinfo/imports/stanage/packages/cmake-ml-el9-icelake-znver-stanage.rst

For example, load ``CMake/4.2.1-GCCcore-15.2.0``, which also loads
``GCCcore/15.2.0``. From a project's source directory containing
``CMakeLists.txt``, configure a separate build directory and build the project: ::

   cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
   cmake --build build

The ``-D`` option sets a project configuration variable using ``-DNAME=value``.
The available variables and any additional dependencies depend on the project.

Installation notes
------------------

.. include:: /referenceinfo/imports/stanage/packages/cmake-inst-el9-icelake-znver-stanage.rst

.. include:: /referenceinfo/imports/stanage/packages/cmake-dpnd-el9-icelake-znver-stanage.rst

When adapting this layout to a software, choose a new reference label, use the package’s own generated include files and write usage instructions for that package. Set the guidance date as described in Guidance dates.