How to install
==============

.. _installation:

.. contents:: Table of Contents

SPBench Dependencies
--------------------

The folowing packages are required to install and use SPBench:

   - build-essential
   - pkg-config
   - cmake
   - python (tested on python3 and python2.7)

You can run the command below to install theses packages or ask a system admin.

.. code-block:: bash

   sudo apt-get install -y build-essential pkg-config cmake python3

Applications Installation
------------------------

To install SPBench you can choose full installation (all applications):

.. code-block:: bash

   ./spbench install

Or choose a specific application:

.. code-block:: bash
   
   ./spbench install -app <application_name>

Run ``./spbench install -h`` for more info.

To install specific components, see ``libs/README.md`` or ``ppis/README.md``.

---------

Workload installation
----------------------

The workloads (applications inputs) natively provided by SPBench to run the applications are not automatically obtained during installation. So at this point, you may also want to download and install the workloads.


.. code-block:: bash

   ./spbench download-inputs

Or choose a specific application:

.. code-block:: bash
   
   ./spbench download-inputs -app <application_name>

Run ``./spbench download-inputs -h`` to see more options.

And see the :doc:`/workloads` page for more details.