From 5558be1b551c13ea3a92dd837b0f12e976aca6bd Mon Sep 17 00:00:00 2001 From: lukelabrie Date: Mon, 13 Apr 2026 17:20:33 +0200 Subject: [PATCH 1/6] add arch install option to documentation --- docs/source/usersguide/install.rst | 58 ++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 1f9a07b80c6..0a5e2177c7b 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -158,6 +158,64 @@ feature can be used to access the installed packages. .. _Spack: https://spack.readthedocs.io/en/latest/ .. _setup guide: https://spack.readthedocs.io/en/latest/getting_started.html +.. _install_aur: + +---------------------------------------- +Installing on Arch Linux via the AUR +---------------------------------------- + +On Arch Linux and Arch-based distributions, OpenMC can be installed from the +`Arch User Repository (AUR) `_. An AUR package named +``openmc-git`` is available, which builds OpenMC directly from the latest +development sources. + +This package provides a full-featured OpenMC stack, including: + +* MPI and DAGMC-enabled OpenMC build +* User-selected nuclear data libraries +* The `CAD_to_OpenMC ` meshing tool +* All required dependencies for the above components + +To install the package, you will need an AUR helper such as `yay`_ or `paru`_. +For example, using ``yay``: + +.. code-block:: sh + + yay -S openmc-git + +Alternatively, you can manually clone and build the package: + +.. code-block:: sh + + git clone https://aur.archlinux.org/openmc-git.git + cd openmc-git + makepkg -si + +The PKGBUILD will automatically handle all required dependencies and build +OpenMC with MPI and DAGMC support enabled. + +.. note:: + + The ``openmc-git`` package tracks the latest development version from the + upstream repository. As such, it may include new features and bug fixes, but + could also introduce instability compared to official releases. + +.. tip:: + + OpenMC is installed under ``/opt``. If you are installing and using it in the + same terminal session, you may need to reload your environment variables: + + .. code-block:: sh + + source /etc/profile + + Alternatively, start a new shell session. + +Once installed, the ``openmc`` executable, nuclear data libraries, and +associated tools will be available in your system PATH. + +.. _yay: https://github.com/Jguer/yay +.. _paru: https://github.com/Morganamilo/paru .. _install_source: From aac301194e7cbb6d2d40e5b902fa510c98570e80 Mon Sep 17 00:00:00 2001 From: lukelabrie Date: Mon, 13 Apr 2026 17:22:52 +0200 Subject: [PATCH 2/6] fix hyperlink --- docs/source/usersguide/install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 0a5e2177c7b..876ea312daa 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -173,7 +173,7 @@ This package provides a full-featured OpenMC stack, including: * MPI and DAGMC-enabled OpenMC build * User-selected nuclear data libraries -* The `CAD_to_OpenMC ` meshing tool +* The `CAD_to_OpenMC `_ meshing tool * All required dependencies for the above components To install the package, you will need an AUR helper such as `yay`_ or `paru`_. From d253ec88d2941508e3c8388e96991f86de2e39fe Mon Sep 17 00:00:00 2001 From: lukelabrie Date: Tue, 14 Apr 2026 14:05:05 +0200 Subject: [PATCH 3/6] suggest --nocheck flag in case of failing checks --- docs/source/usersguide/install.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 876ea312daa..783d686578b 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -183,6 +183,7 @@ For example, using ``yay``: yay -S openmc-git + Alternatively, you can manually clone and build the package: .. code-block:: sh @@ -191,9 +192,27 @@ Alternatively, you can manually clone and build the package: cd openmc-git makepkg -si +Note, `makepkg`_ uses `pacman`_ to resolve dependencies. Therefore, AUR-based +need to be installed separately with `yay`_ or `paru`_ before running `makepkg`_. The PKGBUILD will automatically handle all required dependencies and build OpenMC with MPI and DAGMC support enabled. +.. tip:: + + If there are failing checks during the build process, you can bypass them with the ``--nocheck`` flag: + + .. code-block:: sh + + yay -S openmc-git --mflags "--nocheck" + + Or + + .. code-block:: sh + + git clone https://aur.archlinux.org/openmc-git.git + cd openmc-git + makepkg -si --nocheck + .. note:: The ``openmc-git`` package tracks the latest development version from the From 0bfa8459a91e7a7473f1a091542dc9bb785dd401 Mon Sep 17 00:00:00 2001 From: lukelabrie Date: Tue, 14 Apr 2026 14:06:17 +0200 Subject: [PATCH 4/6] fix formatting --- docs/source/usersguide/install.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 783d686578b..3317e465b29 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -192,8 +192,8 @@ Alternatively, you can manually clone and build the package: cd openmc-git makepkg -si -Note, `makepkg`_ uses `pacman`_ to resolve dependencies. Therefore, AUR-based -need to be installed separately with `yay`_ or `paru`_ before running `makepkg`_. +Note, ``makepkg`` uses ``pacman`` to resolve dependencies. Therefore, AUR-based +need to be installed separately with ``yay`` or ``paru`` before running ``makepkg``. The PKGBUILD will automatically handle all required dependencies and build OpenMC with MPI and DAGMC support enabled. From 063fb9d9a61396133e10c72bfb02bdeee0c95f06 Mon Sep 17 00:00:00 2001 From: lukelabrie Date: Tue, 14 Apr 2026 14:07:03 +0200 Subject: [PATCH 5/6] fix typo --- docs/source/usersguide/install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 3317e465b29..afa7a9dc9d7 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -193,7 +193,7 @@ Alternatively, you can manually clone and build the package: makepkg -si Note, ``makepkg`` uses ``pacman`` to resolve dependencies. Therefore, AUR-based -need to be installed separately with ``yay`` or ``paru`` before running ``makepkg``. +dependencies need to be installed separately with ``yay`` or ``paru`` before running ``makepkg``. The PKGBUILD will automatically handle all required dependencies and build OpenMC with MPI and DAGMC support enabled. From e3154fae3bf623253625b4e12954b4e081b61fd7 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Sat, 18 Apr 2026 10:55:27 -0500 Subject: [PATCH 6/6] Small fixes --- docs/source/usersguide/install.rst | 38 ++++++++++++------------------ 1 file changed, 15 insertions(+), 23 deletions(-) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index afa7a9dc9d7..1ef2f574be8 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -160,9 +160,9 @@ feature can be used to access the installed packages. .. _install_aur: ----------------------------------------- +------------------------------------ Installing on Arch Linux via the AUR ----------------------------------------- +------------------------------------ On Arch Linux and Arch-based distributions, OpenMC can be installed from the `Arch User Repository (AUR) `_. An AUR package named @@ -177,37 +177,30 @@ This package provides a full-featured OpenMC stack, including: * All required dependencies for the above components To install the package, you will need an AUR helper such as `yay`_ or `paru`_. -For example, using ``yay``: - -.. code-block:: sh +For example, using ``yay``:: yay -S openmc-git -Alternatively, you can manually clone and build the package: - -.. code-block:: sh +Alternatively, you can manually clone and build the package:: git clone https://aur.archlinux.org/openmc-git.git cd openmc-git makepkg -si -Note, ``makepkg`` uses ``pacman`` to resolve dependencies. Therefore, AUR-based -dependencies need to be installed separately with ``yay`` or ``paru`` before running ``makepkg``. -The PKGBUILD will automatically handle all required dependencies and build -OpenMC with MPI and DAGMC support enabled. +Note, ``makepkg`` uses ``pacman`` to resolve dependencies. Therefore, AUR-based +dependencies need to be installed separately with ``yay`` or ``paru`` before +running ``makepkg``. The PKGBUILD will automatically handle all required +dependencies and build OpenMC with MPI and DAGMC support enabled. .. tip:: - If there are failing checks during the build process, you can bypass them with the ``--nocheck`` flag: - - .. code-block:: sh + If there are failing checks during the build process, you can bypass them + with the ``--nocheck`` flag:: yay -S openmc-git --mflags "--nocheck" - Or - - .. code-block:: sh + Or:: git clone https://aur.archlinux.org/openmc-git.git cd openmc-git @@ -221,17 +214,16 @@ OpenMC with MPI and DAGMC support enabled. .. tip:: - OpenMC is installed under ``/opt``. If you are installing and using it in the - same terminal session, you may need to reload your environment variables: - - .. code-block:: sh + OpenMC is installed under ``/opt``. If you are installing and using it in + the same terminal session, you may need to reload your environment + variables:: source /etc/profile Alternatively, start a new shell session. Once installed, the ``openmc`` executable, nuclear data libraries, and -associated tools will be available in your system PATH. +associated tools will be available in your system :envvar:`PATH`. .. _yay: https://github.com/Jguer/yay .. _paru: https://github.com/Morganamilo/paru