scnc
/
conquest
mirror of https://github.com/OrderN/CONQUEST-release.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #263 from OrderN/tk-spack-install-docs 

Add documentation for installing with Spack
This commit is contained in:
David Bowler 2024-02-19 10:26:49 +00:00 committed by GitHub
parent 5bae10a0ef 7b78a93d9d
commit cfafeb3587
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/installing.rst
View File

@ -7,6 +7,32 @@ Installation
You will need to download and compile the code before you can use it;
we do not supply binaries.
.. _install_spack:
Installing with Spack
-----------
CONQUEST and all of its dependencies can be installed with `Spack<https://spack.io/>`_.
The CONQUEST package requires Spack v0.21 or later. If Spack isn't available or up to date on your
system, it is relatively straightforward to install it with user permissions following the
`install instructions<https://spack.readthedocs.io/en/latest/getting_started.html#installation>`_.
When setting up Spack on a new system, it is recommended to configure it to use available
`system compilers<https://spack.readthedocs.io/en/latest/getting_started.html#compiler-configuration>`_
and `system packages<https://spack.readthedocs.io/en/latest/getting_started.html#system-packages>`_.
Once spack is installed and set up, install CONQUEST with:
``spack install conquest``
and load the ``Conquest`` executable to ``PATH`` with
``spack load conquest``
The build can be customized by adding options to the
`Spack spec<https://spack.readthedocs.io/en/latest/basic_usage.html#specs-dependencies>`_ ``conquest``.
The CONQUEST package includes variants for OpenMP support and different matrix multiplication kernels,
please see the `Spack package<https://spack.readthedocs.io/en/latest/package_list.html#conquest>`_ for
more details.
.. _install_down:
Downloading
@ -20,7 +46,7 @@ it can be cloned:
where ``destination-directory`` should be set by the user.
Alternatively, it can be downloaded from GitHub as a zip file and
unpacked:
unpacked:
`<https://github.com/OrderN/CONQUEST-release/archive/master.zip>`_