Skip to content

Commit 36e70d8

Browse files
Add Arch Linux User Repository (AUR) installation instructions to documentation (#3921)
Co-authored-by: Paul Romano <paul.k.romano@gmail.com>
1 parent fd1bc26 commit 36e70d8

1 file changed

Lines changed: 69 additions & 0 deletions

File tree

docs/source/usersguide/install.rst

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,75 @@ feature can be used to access the installed packages.
158158
.. _Spack: https://spack.readthedocs.io/en/latest/
159159
.. _setup guide: https://spack.readthedocs.io/en/latest/getting_started.html
160160

161+
.. _install_aur:
162+
163+
------------------------------------
164+
Installing on Arch Linux via the AUR
165+
------------------------------------
166+
167+
On Arch Linux and Arch-based distributions, OpenMC can be installed from the
168+
`Arch User Repository (AUR) <https://aur.archlinux.org/>`_. An AUR package named
169+
``openmc-git`` is available, which builds OpenMC directly from the latest
170+
development sources.
171+
172+
This package provides a full-featured OpenMC stack, including:
173+
174+
* MPI and DAGMC-enabled OpenMC build
175+
* User-selected nuclear data libraries
176+
* The `CAD_to_OpenMC <https://github.com/united-neux/CAD_to_OpenMC>`_ meshing tool
177+
* All required dependencies for the above components
178+
179+
To install the package, you will need an AUR helper such as `yay`_ or `paru`_.
180+
For example, using ``yay``::
181+
182+
yay -S openmc-git
183+
184+
185+
Alternatively, you can manually clone and build the package::
186+
187+
git clone https://aur.archlinux.org/openmc-git.git
188+
cd openmc-git
189+
makepkg -si
190+
191+
Note, ``makepkg`` uses ``pacman`` to resolve dependencies. Therefore, AUR-based
192+
dependencies need to be installed separately with ``yay`` or ``paru`` before
193+
running ``makepkg``. The PKGBUILD will automatically handle all required
194+
dependencies and build OpenMC with MPI and DAGMC support enabled.
195+
196+
.. tip::
197+
198+
If there are failing checks during the build process, you can bypass them
199+
with the ``--nocheck`` flag::
200+
201+
yay -S openmc-git --mflags "--nocheck"
202+
203+
Or::
204+
205+
git clone https://aur.archlinux.org/openmc-git.git
206+
cd openmc-git
207+
makepkg -si --nocheck
208+
209+
.. note::
210+
211+
The ``openmc-git`` package tracks the latest development version from the
212+
upstream repository. As such, it may include new features and bug fixes, but
213+
could also introduce instability compared to official releases.
214+
215+
.. tip::
216+
217+
OpenMC is installed under ``/opt``. If you are installing and using it in
218+
the same terminal session, you may need to reload your environment
219+
variables::
220+
221+
source /etc/profile
222+
223+
Alternatively, start a new shell session.
224+
225+
Once installed, the ``openmc`` executable, nuclear data libraries, and
226+
associated tools will be available in your system :envvar:`PATH`.
227+
228+
.. _yay: https://github.com/Jguer/yay
229+
.. _paru: https://github.com/Morganamilo/paru
161230

162231
.. _install_source:
163232

0 commit comments

Comments
 (0)