Skip to content

Commit d3ebeed

Browse files
committed
Reference parallel in install guide
1 parent a94e6d2 commit d3ebeed

File tree

2 files changed

+48
-8
lines changed

2 files changed

+48
-8
lines changed

docs/source/install.rst

Lines changed: 47 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ For the Python library, the easiest method of installation is to install it dire
1313
or
1414

1515
.. code-block:: bash
16-
16+
1717
pip install 'raffle[ase]'
1818
1919
Once this is done, RAFFLE is ready to be used.
@@ -24,10 +24,6 @@ Alternatively, to install RAFFLE from source, follow the instructions below.
2424
RAFFLE can be installed in one of three ways; as a Python package, as a Fortran library, or as a standalone Fortran executable.
2525
All versions rely on the core Fortran code, with the Python package and standalone executable wrapping this code in a Python and Fortran interface, respectively.
2626

27-
.. note::
28-
Currently, RAFFLE is not available on any hosted package manager (e.g. PyPI, conda-forge or fpm), so you will need to download it manually from the Git repository.
29-
30-
3127
The code is hosted on `GitHub <https://github.com/ExeQuantCode/raffle>`_.
3228

3329
This can be done by cloning the repository:
@@ -41,7 +37,7 @@ This can be done by cloning the repository:
4137
Notes on the different versions of RAFFLE:
4238

4339
- The Python package is the most user-friendly way to use RAFFLE, as it provides a high-level interface to the Fortran code and allows for easy implementation into existing workflows.
44-
40+
4541
- The Fortran library provides the same functionality as the Python package, but in Fortran instead, enabling slightly more (but not recommended) access to the underlying code.
4642

4743
- The standalone executable enables the use of RAFFLE without any Python dependencies and no need to code, just editing of a parameter file.
@@ -79,7 +75,23 @@ Installation using pip
7975
-----------------------
8076

8177
The easiest way to install RAFFLE is via pip.
82-
Currently, the package is not available on PyPI, so you will need to install it from the source code.
78+
The package is directly available via PyPI, so can be installed without downloading the repository. To do so, run:
79+
80+
.. code-block:: bash
81+
82+
pip install 'raffle[ase]'
83+
84+
This will install the RAFFLE package and all its dependencies in the default location.
85+
This is the recommended method of installation, as it is the easiest and most straightforward way to get started with RAFFLE.
86+
By default, this will install the parallel version of RAFFLE.
87+
To install the serial version of RAFFLE, include the ``--config-settings`` flag in the pip install command:
88+
.. code-block:: bash
89+
90+
pip install --upgrade raffle --config-settings="cmake.define.CMAKE_BUILD_TYPE=Serial"
91+
92+
93+
Another option is to install RAFFLE from the source code, which is recommended if you want to use the latest version of RAFFLE or if you want to contribute to the development of RAFFLE.
94+
To do this, you will need to clone the repository from GitHub.
8395

8496
Once the library is cloned, navigate to the root directory of the repository and run:
8597

@@ -88,7 +100,12 @@ Once the library is cloned, navigate to the root directory of the repository and
88100
pip install --upgrade .[ase]
89101
90102
91-
The optional ``[ase]`` flag is used to install the ASE interface, which is not required for the core functionality of RAFFLE, but is recommended
103+
The optional ``[ase]`` flag is used to install the ASE interface, which is not required for the core functionality of RAFFLE, but is recommended (and examples rely on it).
104+
105+
To install the serial version of RAFFLE, include the ``--config-settings`` flag in the pip install command:
106+
.. code-block:: bash
107+
108+
pip install --upgrade . --config-settings="cmake.define.CMAKE_BUILD_TYPE=Serial"
92109
93110
.. note::
94111
If you are installing RAFFLE on a computer where you do not have root access, you may need to add the ``--user`` flag to the above command.
@@ -122,6 +139,16 @@ For Unix systems, this will typically be in:
122139
123140
~/.local/raffle
124141
142+
Like with the pip installation, this will install the parallel version of RAFFLE by default.
143+
To install the serial version of RAFFLE, run the following commands:
144+
.. code-block:: bash
145+
146+
mkdir build
147+
cd build
148+
cmake [-DBUILD_PYTHON=On] -DBUILD_EXECUTABLE=Off -DCMAKE_BUILD_TYPE=Serial ..
149+
make
150+
make install
151+
125152
126153
Fortran
127154
=======
@@ -155,6 +182,8 @@ This can also be set up as a dependency in your own fpm project by adding the fo
155182
[dependencies]
156183
raffle = { git = "https://github.com/ExeQuantCode/RAFFLE" }
157184
185+
The Fortran libray has openmp dependencies.
186+
158187
Installation using cmake
159188
------------------------
160189

@@ -182,6 +211,16 @@ To install the standalone executable, run:
182211
183212
This will build the Fortran library and install it in the default location (``~/.local/raffle``).
184213

214+
The default installation is the parallel version of RAFFLE.
215+
To install the serial version of RAFFLE, run the following commands:
216+
.. code-block:: bash
217+
218+
mkdir build
219+
cd build
220+
cmake -DBUILD_PYTHON=Off -DBUILD_EXECUTABLE=On -DCMAKE_BUILD_TYPE=Serial ..
221+
make
222+
make install
223+
185224
186225
Installing on MacOS (Homebrew)
187226
==============================
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
mace-torch==0.3.12
22
chgnet==0.4.0
33
joblib==1.4.2
4+
ase>=3.23.0

0 commit comments

Comments
 (0)