LCPQ/quantum_package
10
0
Fork 0
mirror of https://github.com/LCPQ/quantum_package synced 2025-05-05 14:44:55 +02:00
Code Issues Releases Wiki Activity

OPAMROOT

Anthony Scemama 2017-01-04 10:02:17 +01:00
parent cd03fba64f
commit a261f9a08e
1 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Installation-instructions.md

@ -12,10 +12,12 @@ This command will :
It's not a Makefile, but a Ninja file (so don't type `make` is hopeless, type `ninja` instead) It's not a Makefile, but a Ninja file (so don't type `make` is hopeless, type `ninja` instead)
By default, the OCaml compiler and libraries will be installed in ``$HOME/.opam``. By default, the OCaml compiler and libraries will be installed in ``$HOME/.opam``.
For more info about the OCaml installation, check the Opam website : If you want to install it somewhere else, you can change this by setting the ``$OPAMROOT``
environment variable to the location of your choice.
For more info about the OCaml installation, you can visit the Opam website :
https://opam.ocaml.org/doc/Install.html https://opam.ocaml.org/doc/Install.html
####Compilation Flags (`<config_file>`) #### Compilation Flags (`<config_file>`)
`<config_file>` is the path to the file which contains all the flags useful for the compilation : optimization flags, Lapack libary, etc. We have two default configuration files in ``$QP_ROOT/config`` : ``ifort.cfg`` and ``gfortran.cfg``. You copy these files to create a new config file adapted to your architecture. `<config_file>` is the path to the file which contains all the flags useful for the compilation : optimization flags, Lapack libary, etc. We have two default configuration files in ``$QP_ROOT/config`` : ``ifort.cfg`` and ``gfortran.cfg``. You copy these files to create a new config file adapted to your architecture.
@ -69,17 +71,9 @@ If you have set the `--developement` flag in a specific module you can go in
the corresponding module `$QP_ROOT/src/module_name` directory and run `ninja` to build only this module. the corresponding module `$QP_ROOT/src/module_name` directory and run `ninja` to build only this module.
You can type `ninja all` in a module to compile all the submodules. You can type `ninja all` in a module to compile all the submodules.
### 4) Compiling the OCaml ### 4) Testing if all is OK
An important part of the quantum package is written in OCaml. You will also need to compile the OCaml source code.
(In a near future, this step will be integrated in the main ninja file).
```
cd $QP_ROOT ; make -C ocaml/
```
### 5) Testing if all is OK
Some unit tests are available in the `test` directory. To run the tests: Some unit tests are available in the `test` directory. To run the tests:
``` ```
cd $QP_ROOT/tests cd $QP_ROOT/tests
bats bats/qp.bats ./run_tests.sh
``` ```