Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions docs/source/usersguide/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,75 @@ 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) <https://aur.archlinux.org/>`_. 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 <https://github.com/united-neux/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``::

yay -S openmc-git


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.

.. tip::

If there are failing checks during the build process, you can bypass them
with the ``--nocheck`` flag::

yay -S openmc-git --mflags "--nocheck"

Or::

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
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::

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 :envvar:`PATH`.

.. _yay: https://github.com/Jguer/yay
.. _paru: https://github.com/Morganamilo/paru

.. _install_source:

Expand Down