BIPS/Getting Started/Building BIPS: Difference between revisions

Revision as of 19:45, 14 December 2022

Dependencies

BIPS has the following dependencies for building from source:

libboost-system
libspdlog

Core

Please, install them using (in Debian-based systems):

sudo apt install -y     \
    libboost-system-dev \
    libspdlog-dev       \
    python3-dev

Documentation (optional)

For the documentation, consider the following dependencies:

doxygen
graphviz
java

Please, install them using (in Debian-based systems):

sudo apt install -y     \
    doxygen             \
    graphviz            \
    default-jre         \

Meson building system

At the building system level:

ninja-build
python3-pip
pkg-config
meson

Please, install them using (in Debian-based systems):

sudo apt install -y \
     python3        \
     python3-pip    \
     ninja-build    \
     pkg-config

The process should be similar in other systems, not based on Debian.

Building the project

Once fulfilled the dependencies, you can run a default compilation with:

meson build
ninja -C build
sudo ninja -C build install

For additional customization, you may refer to the following table of options:

`

Configure Option	Description
-Denable-python=disabled	Skip the Python API compilation. Enabled by default.
-Dwith-python-version=3.8	Sets the Python version. It takes '3' by default.
-Denable-docs=disabled	Skip documentation generation. Enabled by default.
--prefix /usr	Set the installation path of the library

Table 1. BIPS configuration options (Meson)

Examples are compiled in the build folder for testing purposes. You can run them in build/src/examples

Index

@@ Line 6: / Line 6: @@
 == Dependencies==
-BIPS is supported for the Jetson TX1/TX2/Nano/Xavier platforms and PC systems that have an NVIDIA GPU. The following packages are needed in order to build and use BIPS:
+BIPS has the following dependencies for building from source:
-* list of dep
+* libboost-system
-* list of dep
+* libspdlog
-* list of dep
-* list of dep
-* list of dep
+=== Core ===
-=== CUDA L4T package ===
+Please, install them using (in Debian-based systems):
-<pre style=background-color:yellow>
+<syntaxhighlight lang=bash>
-The Jetpack default installation will flash and install all the necessary CUDA packages. This section describes how to perform a manual installation, which is typically __NOT__ needed
+sudo apt install -y     \
-</pre>
+    libboost-system-dev \
+    libspdlog-dev       \
+    python3-dev
+</syntaxhighlight>
+=== Documentation (optional) ===
+For the documentation, consider the following dependencies:
+* doxygen
+* graphviz
+* java
+Please, install them using (in Debian-based systems):
+<syntaxhighlight lang=bash>
+sudo apt install -y     \
+    doxygen             \
+    graphviz            \
+    default-jre         \
+</syntaxhighlight>
+=== Meson building system ===
+At the building system level:
+* ninja-build
+* python3-pip
+* pkg-config
+* meson
+Please, install them using (in Debian-based systems):
+<syntaxhighlight lang=bash>
+sudo apt install -y \
+     python3        \
+     python3-pip    \
+     ninja-build    \
+     pkg-config
+</syntaxhighlight>
+The process should be similar in other systems, not based on Debian.
 == Building the project ==
-The BIPS package must be built natively.
+Once fulfilled the dependencies, you can run a default compilation with:
+<syntaxhighlight lang=bash>
+meson build
+ninja -C build
+sudo ninja -C build install
+</syntaxhighlight>
+For additional customization, you may refer to the following table of options:
+<center>`
+{| class="wikitable"
+|-
+! Configure Option !! Description
+|-
+| -Denable-python=disabled || Skip the Python API compilation. Enabled by default.
+|-
+| -Dwith-python-version=3.8 || Sets the Python version. It takes '3' by default.
+|-
+| -Denable-docs=disabled || Skip documentation generation. Enabled by default.
+|-
+| --prefix /usr || Set the installation path of the library
+|}
+<b>Table 1.</b> BIPS configuration options (Meson)</caption>
+</center>
+Examples are compiled in the <code>build</code> folder for testing purposes. You can run them in <code>build/src/examples</code>
 <noinclude>
 {{BIPS/Foot||}}
 </noinclude>