10
1
mirror of https://gitlab.com/scemama/QCaml.git synced 2024-10-31 19:23:40 +01:00
QCaml/INSTALL.md

85 lines
1.4 KiB
Markdown
Raw Normal View History

2020-01-21 17:13:44 +01:00
# Generic installation
```bash
opam install lacaml mpi getopt alcotest zarith
```
2018-03-06 00:47:33 +01:00
# BLAS/Lapack
Install OpenBLAS from your system package manager, for example:
```bash
sudo apt-get install libopenblas-dev
```
# LaCAML
LaCAML is the OCaml binding to the LAPACK library.
```bash
opam install lacaml
```
2018-03-20 14:11:31 +01:00
To use MKL with LaCaml:
```bash
export LACAML_LIBS="-L${MKLROOT}/lib/intel64 -Wl,--no-as-needed -lmkl_rt -lpthread -lm -ldl"
opam install lacaml
```
2018-10-17 18:48:39 +02:00
# MPI
MPI is the Message Passing Interface, required for distributed parallelism.
2020-01-21 17:13:44 +01:00
For large MPI calculations, a version >= 4.09.0 of the compiler is required.
2018-10-17 18:48:39 +02:00
```bash
opam install mpi
```
2018-10-16 19:09:00 +02:00
To use Intel MPI
```bash
export MPI_INC_DIR=${I_MPI_ROOT}/include64/
export MPI_LIB_DIR=${I_MPI_ROOT}/lib64/
export MPI_BIN_PATH=${I_MPI_ROOT}/bin64/
opam install mpi
```
2018-03-06 00:47:33 +01:00
# odoc-ltxhtml
This plugin allows to embed equations in the documentation generated by Ocamldoc.
Download the source code [here](https://github.com/scemama/odoc-ltxhtml).
```bash
2018-03-06 18:25:48 +01:00
git clone https://github.com/scemama/odoc-ltxhtml
2018-03-06 00:47:33 +01:00
cd odoc-ltxhtml
make install
```
2019-02-25 14:37:20 +01:00
# Getopt
Parsing of command line arguments (similar to GNU GetOpt)
```bash
opam install getopt
```
2018-10-17 18:48:39 +02:00
# Alcotest
Lightweight and colourful test framework
```bash
opam install alcotest
```
# Zarith
Implements arithmetic and logical operations over arbitrary-precision integer
```bash
opam install zarith
```