Huxelerate Performance Estimator
================================

Huxelerate Performance Estimator allows to:

   * Quickly estimate attainable performance on a variety of computing architectures
   * Visually compare multiple architectures to identify to most suitable for your computational workload
   * Guide you through the optimization process to achieve desired performance

The tool is based on the `Berkeley Roofline Model <https://escholarship.org/content/qt0qs3s709/qt0qs3s709.pdf>`_ adapted to account for `reconfigurable architectures <https://dl.acm.org/doi/abs/10.1145/3400302.3415730>`_ 
and extended to provide **analysis that are code and architecture dependent**.

You can run **Huxelerate Performance Estimator** directly on your local machine through a Docker container. The Estimator will produce a profiling report file, that needs to be uploaded `online <https://performance.huxelerate.it>`_ to obtain the final report.
All your reports will be accessible from your `Performance Estimation page <http://performance.huxelerate.it/performance-estimation>`_ online.
`Registration <http://performance.huxelerate.it/register>`_ is required only to upload the profiling report!

.. note::
   Huxelerate Performance Estimator is always updated with new computing architectures to provide you the most comprehensive comparison and guide your architectural choices.

Quick Start
------------

.. image:: img/performance_estimator_guide.png
   :alt: Performance Estimator Guide

To Quick Start using Huxelerate Performance Estimator, you can download the Docker container containing all the necessary software:

.. code-block:: bash
   :linenos:

   docker pull huxelerate/performance_estimator:latest

.. note::
   If you do not have Docker installed on your local machine, you can easily setup Docker following `the official Docker guide <https://docs.docker.com/get-docker/>`_.

Once the Docker container is ready, there are three steps to your performance estimate:

  #. Profile your application using the Performance Estimator
  #. Register to the `online platform <https://performance.huxelerate.it/register>`_ and upload the profiling report
  #. Analyze the profiling report

Where to start
--------------

.. toctree::
   :maxdepth: 3

   performance_estimator
   huxelerate_platform_upload
   performance_report
   architectures
   tutorial