.. highlight:: bash

.. _getstarted:

Getting Started
==================

Microchip is running an Early Access Program (EAP) for the LegUp HLS compiler
software. This program enables you to evaluate a beta version of LegUp HLS
software and provide us with valuable feedback. To participate in EAP and download
LegUp, please fill out the
`LegUp software request form here
<https://www.microsemi.com/product-directory/fpga-design-tools/5590-hls#software-download>`_
and we will contact you to support your evaluation.

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

LegUp supports Windows 10 and Linux (CentOS 7).

Windows
++++++++++++++++++++++++++++++++++++

Run the Windows installer program, ``LegUp-2021.1-Win64-Setup.exe``, and go through the steps in the installer.

Linux
+++++++++++++++++++++

CentOS
******

The CentOS installer is packaged as a self-extracting shell script that can be installed to a local
directory. To run the installer::

    cd $(INSTALLATION_DIRECTORY)
    sh /path/to/legup-2021.1-centos-installer.run

This will install LegUp into the INSTALLATION_DIRECTORY.  After the
installation is completed, please add the LegUp bin directory to your path::

    export PATH=$(INSTALLATION_DIRECTORY)/legup-2021.1/legup/bin:$PATH

Libero and ModelSim 
+++++++++++++++++++++

You will need to install the `Libero SoC software
<https://www.microsemi.com/product-directory/design-resources/1750-libero-soc>`_
to synthesize the generated hardware for Microchip FPGAs.
After installing Libero, please make sure to download all of new IP cores (open a Libero project, go to the Catalog pane, and click on "Download them now!", as shown below), as some IPs may be needed for LegUp. 

   .. image:: /images/libero_ip_download.png
        :scale: 80 %
        :align: center


Libero also comes with ModelSim which is used by LegUp to simulate the
generated Verilog. 
Please note that the first time you simulate a generated hardware block with a fresh install of LegUp, ModelSim will compile our IP libraries, which may take some time.

.. _quick_start:

Quick Start Tutorial
-----------------------

Please refer to our `LegUp HLS Tutorial for Microsemi PolarFire: Sobel Filtering for Image Edge Detection <https://www.microsemi.com/document-portal/doc_download/1245532-legup-hls-tutorial>` on how to use some of the major features and optimization techniques of LegUp HLS.