.. _compilation:

Compilation
===========

It is possible to configure and build HANDE using CMake or using bare ``make``.

The former requires CMake 3.6 (or newer). It will generate ``Makefile``-s based
on the given configuration parameters and the detected tools and libraries on
your system. It will, in most cases, work out of the box.

The bare ``make`` build offers a higher degree of customisation. Also in this
case a ``Makefile`` will be generated based on a configuration file, of which
you can find examples in the ``config`` folder.

.. toctree::
   :maxdepth: 2
   :glob:

   compile-with-cmake
   compile-with-make
   

A Docker image is also available to try out our code. After installing Docker
(https://docs.docker.com/install/) you can run the following command: 

   docker run -it handeqmc/hande_ubuntu18.04:latest
   
to start an Ubuntu 18.04 container with the latest version of HANDE installed.
The Python dependencies of HANDE are also installed in a virtual environment, 
which you can access with pipenv shell.

To mount your local directory in common with the virtual machine use

   docker run -it -v "$PWD":/home/mightybuilder/work handeqmc/hande_ubuntu18.04:latest
   

.. _compilation:

Compilation
===========

It is possible to configure and build HANDE using CMake or using bare ``make``.

The former requires CMake 3.12 (or newer). It will generate ``Makefile``-s based
on the given configuration parameters and the detected tools and libraries on
your system. It will, in most cases, work out of the box.

The bare ``make`` build offers a higher degree of customisation. Also in this
case a ``Makefile`` will be generated based on a configuration file, of which
you can find examples in the ``config`` folder.

.. toctree::
   :maxdepth: 2
   :glob:

   compile-with-cmake
   compile-with-make
 

Remove reference to Docker image as we no longer build them.
Remove reference to Docker image as we no longer build them.
