.. index::
    single: bora

.. _bora-user_guide:

bora user guide
===============

**bora** takes its name from `Borá <https://en.wikipedia.org/wiki/Borá>`__, which is a small town and municipality located in the state of São Paulo in Brazil.

The `OmpSs-2\@FPGA releases <https://github.com/bsc-pm-ompss-at-fpga/ompss-2-at-fpga-releases>`__ are automatically installed in the server.
They are available through a module file for each target architecture.
This document describes how to load and use the modules to compile an example application.
Once the modules are loaded, the workflow in the server should be the same as in the Docker images.


General remarks
---------------

* The OmpSs-2\@FPGA toolchain is installed in a version folder under the ``/opt/bsc/`` directory.
* Third-party libraries required to run some programs are installed in the corresponding folder under the ``/opt/lib/`` directory.
* The rest of the software (Xilinx toolchain, modules, etc.) is installed under the ``/tools/`` directory.


.. _bora-login:

Logging into the system
-----------------------

bora is accessible at IP ``84.88.51.137``:

.. code-block:: text

    ssh 84.88.51.137

Also, this can be automated by adding a ``bora`` host into ssh config:

.. code-block:: text

    Host bora
        HostName 84.88.51.137


.. _bora-modules:

Module structure
----------------

The ompss-2 modules are:

* ``ompss-2/x86_64/*[release version]*``

This will automatically load the default Vivado version, although an arbitrary version can be loaded before ompss:

.. code-block:: text

    module load vivado/2024.2 ompss-2/x86_64/git

To list all available modules in the system run:

.. code-block:: text

    module avail


Build applications
------------------

To generate an application binary and bitstream, you could refer to :ref:`compile-ompss2atfpga-programs` as the steps are general enough.

Note that the appropriate modules need to be loaded. See :ref:`bora-modules`.