Skip to content

Commit 6a325d0

Browse files
docs: Add conda-forge install instructions
* Add instructions for pixi and conda for installing qcdloop from conda-forge. - c.f. https://github.com/conda-forge/qcdloop-feedstock/
1 parent 172a05a commit 6a325d0

File tree

1 file changed

+29
-8
lines changed

1 file changed

+29
-8
lines changed

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Homepage with library description: https://qcdloop.web.cern.ch
1111
If you use this code in your publication, please cite
1212
[arXiv:0712.1851](http://arxiv.org/abs/0712.1851) and
1313
[arXiv:1605.03181](http://arxiv.org/abs/1605.03181).
14-
14+
1515
## Download
1616

1717
You can obtain QCDLoop releases directly from the github repository:
@@ -31,7 +31,9 @@ git tag -l
3131
git checkout tags/tag_name
3232
```
3333

34-
## Installation
34+
## Installation
35+
36+
### From source
3537

3638
Checkout the code and compile the code using the
3739
following procedure:
@@ -44,15 +46,34 @@ make && make install
4446
```
4547

4648
By the default, if prefix is not set the program is installed in
47-
/usr/local. If you define a custom prefix, use the `-DCMAKE_INSTALL_PREFIX` option and
48-
remember to export qcdloop/lib to the LD_LIBRARY_PATH. QCDLoop requires a compiler with
49-
C++11 and quadmath features (e.g. gcc >= 5).
49+
`/usr/local`. If you define a custom prefix, use the `-DCMAKE_INSTALL_PREFIX` option and
50+
remember to export `qcdloop/lib` to the `LD_LIBRARY_PATH`. QCDLoop requires a compiler with
51+
C++11 and `quadmath` features (e.g. `gcc >= 5`).
5052

5153
Other qcdloop cmake options are:
52-
- `ENABLE_EXAMPLES`, build examples in C++, default OFF.
53-
- `ENABLE_FORTRAN_WRAPPER`, include fortran wrapper in the library, default ON.
54+
- `ENABLE_EXAMPLES`, build examples in C++, default `OFF`.
55+
- `ENABLE_FORTRAN_WRAPPER`, include fortran wrapper in the library, default `ON`.
56+
57+
The fortran wrapper follows the previous syntax in `qcdloop`, see details in table 2 of https://arxiv.org/pdf/1605.03181.pdf.
58+
59+
### From conda-forge
60+
61+
QCDLoop is distributed on [conda-forge](https://github.com/conda-forge/qcdloop-feedstock/) for the following platforms:
62+
63+
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/qcdloop.svg)](https://anaconda.org/conda-forge/qcdloop)
64+
[![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/qcdloop.svg)](https://anaconda.org/conda-forge/qcdloop)
65+
66+
To install and add QCDLoop to a project with [`pixi`](https://pixi.sh/), from the project directory run
5467

55-
The fortran wrapper follows the previous syntax in qcdloop, see details in table 2 of https://arxiv.org/pdf/1605.03181.pdf.
68+
```
69+
pixi add qcdloop
70+
```
71+
72+
and to install into a particular conda environment with [`conda`](https://docs.conda.io/projects/conda/), in the activated environment run
73+
74+
```
75+
conda install --channel conda-forge qcdloop
76+
```
5677

5778
## Contact Information
5879

0 commit comments

Comments
 (0)