You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/install.rst
+47-8Lines changed: 47 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ For the Python library, the easiest method of installation is to install it dire
13
13
or
14
14
15
15
.. code-block:: bash
16
-
16
+
17
17
pip install 'raffle[ase]'
18
18
19
19
Once this is done, RAFFLE is ready to be used.
@@ -24,10 +24,6 @@ Alternatively, to install RAFFLE from source, follow the instructions below.
24
24
RAFFLE can be installed in one of three ways; as a Python package, as a Fortran library, or as a standalone Fortran executable.
25
25
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.
26
26
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
-
31
27
The code is hosted on `GitHub <https://github.com/ExeQuantCode/raffle>`_.
32
28
33
29
This can be done by cloning the repository:
@@ -41,7 +37,7 @@ This can be done by cloning the repository:
41
37
Notes on the different versions of RAFFLE:
42
38
43
39
- 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
+
45
41
- 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.
46
42
47
43
- 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
79
75
-----------------------
80
76
81
77
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:
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.
83
95
84
96
Once the library is cloned, navigate to the root directory of the repository and run:
85
97
@@ -88,7 +100,12 @@ Once the library is cloned, navigate to the root directory of the repository and
88
100
pip install --upgrade .[ase]
89
101
90
102
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:
0 commit comments