Skip to content

Commit 5558be1

Browse files
committed
add arch install option to documentation
1 parent fd1bc26 commit 5558be1

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

docs/source/usersguide/install.rst

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,64 @@ 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+
.. code-block:: sh
183+
184+
yay -S openmc-git
185+
186+
Alternatively, you can manually clone and build the package:
187+
188+
.. code-block:: sh
189+
190+
git clone https://aur.archlinux.org/openmc-git.git
191+
cd openmc-git
192+
makepkg -si
193+
194+
The PKGBUILD will automatically handle all required dependencies and build
195+
OpenMC with MPI and DAGMC support enabled.
196+
197+
.. note::
198+
199+
The ``openmc-git`` package tracks the latest development version from the
200+
upstream repository. As such, it may include new features and bug fixes, but
201+
could also introduce instability compared to official releases.
202+
203+
.. tip::
204+
205+
OpenMC is installed under ``/opt``. If you are installing and using it in the
206+
same terminal session, you may need to reload your environment variables:
207+
208+
.. code-block:: sh
209+
210+
source /etc/profile
211+
212+
Alternatively, start a new shell session.
213+
214+
Once installed, the ``openmc`` executable, nuclear data libraries, and
215+
associated tools will be available in your system PATH.
216+
217+
.. _yay: https://github.com/Jguer/yay
218+
.. _paru: https://github.com/Morganamilo/paru
161219

162220
.. _install_source:
163221

0 commit comments

Comments
 (0)