Local installation
==================

The supported local installation is done with Spack

Spack is a package management tool designed to support multiple versions 
and configurations of software on a wide variety of platforms and environments. 
It was designed for large supercomputing centers but can also be used by a regular users.

Spack installation allows to install ATHENA stack natively
on your system (as much as possible). It is easier to work with in terms of IDEs, 
OpenGL (Geant4 event display), debugging, etc. The downside of this is that it requires of 
compilation of lots of packages, which takes time (hours) and is prone to errors
depending on your system. If setup fails, it require some spack-kung-foo to debug and 
recover the installation. Thus: 

THIS TYPE OF INSTALLATION IS CONSIDERED FOR EXPERTS. DO IT ON YOUR OWN RISK. 

Installation
------------

To install Spack and EIC-Spack repository it is recommended to use master branch of spack as 
several of issues we submitted are not yet on any tag.

.. code:: bash

    git clone https://github.com/spack/spack.git
    . spack/share/spack/setup-env.sh                 # Add this to your e.g. ~/.bashrc
    git clone https://github.com/eic/eic-spack.git
    spack repo add eic-spack
    


Create environment file **athena.yaml** with the next content:

.. code:: yaml

    spack:
        specs:
        - acts +dd4hep +digitization +examples +fatras +geant4 +identification +json +tgeo +ipo
        - boost@1.76.00
        - cmake
        - clhep cxxstd=17
        - dd4hep +geant4 +assimp +hepmc3 +lcio +ipo
        - eigen
        - gaudi +ipo
        - geant4 +ipo +qt +opengl -python +threads +vecgeom cxxstd=17
        - genfit +ipo
        - hepmc3 +interfaces +python +rootio        
        - lcio +ipo
        - mesa -llvm swr=none
        - nano
        - podio +ipo
        - pythia8 +fastjet
        - root cxxstd=17 +fftw +fortran +gdml +mlp +pythia8 +root7 +tmva +vc +xrootd +ssl
        - xrootd cxxstd=17 +python
        - igprof
        - npdet +geocad
        - eicd
        - log4cxx
        - afterburner +zlib +root
        - juggler
        - athena-eic +reconstruction
        - py-pandas
        - py-matplotlib
        concretization: together
        config:
            install_missing_compilers: true
        # Optional: install path and view path
        #   install_tree:
        #    root: /opt/software
        #view: /opt/local


Create the environement from the file


.. code:: bash

    spack env create athena athena.yaml
    spack env activate athena
    spack concretize
    spack install --fail-fast -v -j8


References
----------

- `Spack main documentation <https://spack.readthedocs.io/en/latest/>`__
- `Spack environments tutorial <https://spack-tutorial.readthedocs.io/en/latest/tutorial_environments.html>`__
- `EIC-spack repository <https://github.com/eic/eic-spack>`__