Skip to content

Commit

Permalink
Revert "docs: update rocky8 docs"
Browse files Browse the repository at this point in the history 
This reverts commit fa0833c.
  • Loading branch information
@beatreichenbach
beatreichenbach committed Sep 27, 2024
1 parent fa0833c commit 5d3b077
Showing 1 changed file with 180 additions and 108 deletions.
288 changes: 180 additions & 108 deletions docs/build_system/config_linux_rocky8.md
View file
Original file line number Diff line number Diff line change
@@ -1,152 +1,224 @@
# Building OpenRV on Rocky Linux 8.7
# Building Open RV on Rocky 8

## Manual Build
## Summary

1. [Install Dependencies](#install-dependencies)
2. [Install Qt5](#install-qt5)
3. [Build and Install OpenRV](#build-and-install-openrv)
1. [Install Basics](#install-basics)
2. [Install tools and build dependencies](#install-tools-and-build-dependencies)
3. [Install CMake](#install-cmake)
4. [Install Qt5](#install-qt)
5. [Build Open RV](build_rocky8_openrv)
1. [Building from command line](building_rocky8_from_command_line)
2. [Building with Docker](building_rocky8_with_docker)

### Install Dependencies
## Install Basics

Make sure we have some basic tools available on the workstation:

```shell
sudo dnf install wget git cmake
```bash
sudo dnf install wget git
```

## Install tools and build dependencies

Some of the build dependencies come from outside the main AppStream repo. So first we will enable those and then install our dependencies:

```shell
```bash
sudo dnf install epel-release
sudo dnf config-manager --set-enabled powertools
sudo dnf install alsa-lib-devel autoconf automake avahi-compat-libdns_sd-devel bison bzip2-devel cmake-gui curl-devel flex gcc gcc-c++ libXcomposite libXi-devel libaio-devel libffi-devel nasm ncurses-devel nss libtool libxkbcommon libXcomposite libXdamage libXrandr libXtst libXcursor mesa-libOSMesa mesa-libOSMesa-devel meson ninja-build openssl-devel patch pulseaudio-libs pulseaudio-libs-glib2 ocl-icd ocl-icd-devel opencl-headers python3 python3-devel readline-devel sqlite-devel tcl-devel tcsh tk-devel yasm zip zlib-devel
sudo dnf install alsa-lib-devel autoconf automake avahi-compat-libdns_sd-devel bison bzip2-devel cmake-gui curl-devel flex gcc gcc-c++ libXcomposite libXi-devel libaio-devel libffi-devel nasm ncurses-devel nss libtool libxkbcommon libXcomposite libXdamage libXrandr libXtst libXcursor mesa-libOSMesa mesa-libOSMesa-devel meson ninja-build openssl-devel patch pulseaudio-libs pulseaudio-libs-glib2 ocl-icd ocl-icd-devel opencl-headers python3 python3-devel qt5-qtbase-devel readline-devel sqlite-devel tcl-devel tcsh tk-devel yasm zip zlib-devel
```

You can disable the devel repo afterwards since dnf will warn about it:
```bash
sudo dnf config-manager --set-disabled devel
```

### GLU

You may or may not have libGLU on your system depending on your graphics driver setup. To know you can check if you have the lib /usr/lib64/libGLU.so.1. If it's there you can skip this step, there's nothing further to do in this section. If not, you can install the graphics drivers for your system. As as last resort, you can install a software (mesa) libGLU version, but you may not have ideal performance with this option. To do so:

```shell
```bash
sudo dnf install mesa-libGLU mesa-libGLU-devel
```

Ensure that your `python3` packages are installed and up to date:
```shell
dnf install -y python3-setuptools
python3 -m pip install --upgrade pip setuptools wheel
### Install the python requirements

Some of the RV build scripts requires extra python packages. They can be installed using the requirements.txt at the root of the repository.

```bash
python3 -m pip install -r requirements.txt
```

Ensure that you have a symlink to `python3` at `/usr/bin/python`.
```shell
ln -sf /usr/bin/python3 /usr/bin/python
## Install CMake

You need CMake version 3.27+ to build RV. The dnf-installable version is not quite recent enough, you'll to build and install CMake from sources.

```bash
wget https://github.com/Kitware/CMake/releases/download/v3.30.3/cmake-3.30.3.tar.gz
tar -zxvf cmake-3.30.3.tar.gz
cd cmake-3.30.3
./bootstrap --parallel=32 # 32 or whatever your machine allows
make -j 32 # 32 or whatever your machine allows
sudo make install

cmake --version # confirm the version of your newly installed version of CMake
cmake version3.30.3
```

### Install Qt5
## Install Qt

Download the last version of Qt 5.15.x that you can get using the online installer on the [Qt page](https://www.qt.io/download-open-source). Logs, Android, iOS and WebAssembly are not required to build OpenRV.

WARNING: If you fetch Qt from another source, make sure to build it with SSL support, that it contains everything required to build PySide2, and that the file structure is similar to the official package.

```shell
./qt-unified-linux-x64-4.6.1-online.run --email "<email>" --password "<password>" --platform minimal --confirm-command --accept-licenses --accept-obligations --accept-messages install qt.qt5.5152.qtpdf qt.qt5.5152.qtpurchasing qt.qt5.5152.qtvirtualkeyboard qt.qt5.5152.qtquicktimeline qt.qt5.5152.qtlottie qt.qt5.5152.debug_info qt.qt5.5152.qtscript qt.qt5.5152.qtcharts qt.qt5.5152.qtwebengine qt.qt5.5152.qtwebglplugin qt.qt5.5152.qtnetworkauth qt.qt5.5152.qtwaylandcompositor qt.qt5.5152.qtdatavis3d qt.qt5.5152.logs qt.qt5.5152 qt.qt5.5152.src qt.qt5.5152.gcc_64 qt.qt5.5152.qtquick3d
```

### Build and Install OpenRV
(build_rocky8_openrv)=
## Build Open RV

(building_rocky8_from_command_line)=
### Building from command line

(build_rocky8_openrv1)=
#### Before executing any commands

To maximize your chances of successfully building Open RV, you must:
- Fully update your code base to the latest version (or the version you want to use) with a command like `git pull`.
- Fix all conflicts due to updating the code.
- Revisit all modified files to ensure they aren't using old code that changed during the update such as when the Visual Studio version changes.

(build_rocky8_openrv2)=
#### Get Open RV source code

Get the repository:
Clone the Open RV repository and change directory into the newly created folder. Typically, the command would be:

Using a password-protected SSH key:
```shell
git clone --recursive https://github.com/AcademySoftwareFoundation/OpenRV.git
git clone --recursive git@github.com:AcademySoftwareFoundation/OpenRV.git
cd OpenRV
```

Some of the RV build scripts requires extra python packages.
They can be installed using the requirements.txt at the root of the repository.
Using the web URL:
```shell
python3 -m pip install -r requirements.txt
git clone --recursive https://github.com/AcademySoftwareFoundation/OpenRV.git
cd OpenRV
```

Set the QT_HOME to the install location, build and install:
(build_rocky8_openrv3)=
#### Load aliases for Open RV

From the Open RV directory:
```shell
export QT_HOME=/opt/Qt/5.15.2/gcc_64
source rvcmds.sh
rvbootstrap
rvinst
```

## Docker Build

OpenRV can also be built inside a Docker Container.

1. [Build the Image](#build-the-image)
2. [Extract the Installation Files](#extract-the-installation-files)
3. [Cleanup](#cleanup)

### Build the Image

Here's a `Dockerfile` that installs all dependencies, builds and installs OpenRV from source.
> Note: You will need an email and password for Qt and you might have to update the url to the Qt5 online installer.
```dockerfile
FROM rockylinux:8.7

# Install dependencies
RUN dnf install -y epel-release
RUN dnf config-manager --set-enabled powertools
RUN dnf install -y alsa-lib-devel autoconf automake avahi-compat-libdns_sd-devel bison \
bzip2-devel cmake-gui curl-devel flex gcc gcc-c++ libXcomposite libXi-devel \
libaio-devel libffi-devel nasm ncurses-devel nss libtool libxkbcommon libXcomposite \
libXdamage libXrandr libXtst libXcursor mesa-libOSMesa mesa-libOSMesa-devel meson \
ninja-build openssl-devel patch pulseaudio-libs pulseaudio-libs-glib2 ocl-icd \
ocl-icd-devel opencl-headers qt5-qtbase-devel readline-devel \
sqlite-devel tcl-devel tcsh tk-devel yasm zip zlib-devel
RUN dnf install -y mesa-libGLU mesa-libGLU-devel
RUN dnf install -y cmake git wget

# Note: /usr/bin/python needs to exist for OpenRV to build correctly.
RUN dnf install -y python3-setuptools && \
python3 -m pip install --upgrade pip setuptools wheel && \
ln -sf /usr/bin/python3 /usr/bin/python

# Install Qt5
ARG QT_EMAIL
ARG QT_PASSWORD
RUN wget https://d13lb3tujbc8s0.cloudfront.net/onlineinstallers/qt-unified-linux-x64-4.6.1-online.run && \
chmod a+x qt-unified-linux-x64-4.6.1-online.run && \
./qt-unified-linux-x64-4.6.1-online.run \
--email "$QT_EMAIL" --password "$QT_PASSWORD" --platform minimal \
--confirm-command --accept-licenses --accept-obligations --accept-messages \
install qt.qt5.5152.qtpdf qt.qt5.5152.qtpurchasing qt.qt5.5152.qtvirtualkeyboard \
qt.qt5.5152.qtquicktimeline qt.qt5.5152.qtlottie qt.qt5.5152.debug_info \
qt.qt5.5152.qtscript qt.qt5.5152.qtcharts qt.qt5.5152.qtwebengine \
qt.qt5.5152.qtwebglplugin qt.qt5.5152.qtnetworkauth \
qt.qt5.5152.qtwaylandcompositor qt.qt5.5152.qtdatavis3d qt.qt5.5152.logs \
qt.qt5.5152 qt.qt5.5152.src qt.qt5.5152.gcc_64 qt.qt5.5152.qtquick3d

# Get OpenRV Git Repo
RUN git clone --recursive https://github.com/AcademySoftwareFoundation/OpenRV.git
RUN python3 -m pip install -r /OpenRV/requirements.txt

# Build and Install OpenRV
WORKDIR /OpenRV
# Note: Aliases only work in interactive shells. Use bash script with expand_aliases to
# use commands set in rvcmds.sh
RUN echo "#!/bin/bash" > install.sh && \
echo "set -e" >> install.sh && \
echo "shopt -s expand_aliases" >> install.sh && \
echo "export QT_HOME=/opt/Qt/5.15.2/gcc_64" >> install.sh && \
echo "source /OpenRV/rvcmds.sh" >> install.sh && \
echo "rvbootstrap" >> install.sh && \
echo "rvinst" >> install.sh
RUN bash ./install.sh
```

### Extract the Installation Files

Next mount the image and copy the `_install` directory from it:
```

(build_rocky8_openrv4)=
#### Install Python dependencies

````{note}
This section needs to be done only one time when a fresh Open RV repository is cloned.
The first time the `rvsetup` is executed, it will create a Python virtual environment in the current directory under `.venv`.
````

From the Open RV directory, the following command will download and install the Python dependencies.
```shell
docker cp $(docker create --name temp_container openrv):/OpenRV/_install install && docker rm temp_container
rvsetup
```

(build_rocky8_openrv5)=
#### Configure the project

From the Open RV directory, the following command will configure CMake for the build:

````{tabs}
```{code-tab} bash Release
rvcfg
```
```{code-tab} bash Debug
rvcfgd
```
````

(build_rocky8_openrv6)=
#### Build the dependencies

From the Open RV directory, the following command will build the dependencies:

````{tabs}
```{code-tab} bash Release
rvbuildt dependencies
```
```{code-tab} bash Debug
rvbuildtd dependencies
```
````

(build_rocky8_openrv7)=
#### Build the main executable

From the Open RV directory, the following command will build the main executable:

````{tabs}
```{code-tab} bash Release
rvbuildt main_executable
```
```{code-tab} bash Debug
rvbuildtd main_executable
```
````

(build_rocky8_openrv8)=
#### Opening Open RV executable

````{tabs}
```{tab} Release
Once the build is completed, the Open RV application can be found in the Open RV directory under `_build/stage/app/bin/rv`.
```
```{tab} Debug
Once the build is completed, the Open RV application can be found in the Open RV directory under `_build_debug/stage/app/bin/rv``.
```
````

(building_rocky8_with_docker)=
### Building with Docker (Optional)

To build Open RV using Docker, utilize the provided Dockerfile, which includes all required dependencies.

(build_rocky8_image)=
#### Build the image
```bash
cd dockerfiles
docker build -t openrv-rocky8 -f Dockerfile.Linux-Rocky8 .
```

(run_rocky8_image)=
#### Create the container
```bash
docker run -d openrv-rocky8 /bin/bash -c "sleep infinity"
```

(go_into_the_rocky8_container)=
#### Go into the container
```bash
# Lookup the container id for openrv-rocky8
docker container ls

# Use the container id to go into it.
# e.g.
# CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
# 59e7878debc4 openrv-rocky8 "/bin/bash -c 'sleep…" 21 minutes ago Up 21 minutes crazy_pare
# In this example, the <container id> would be 59e7878debc4.
docker container exec -it <container id> /bin/bash
```

Once you are into the container, you can follow the [standard process](build_rocky8_openrv2).

#### Copy the stage folder outside of the container

If you are on a host that is compatible with Rocky Linux 8, you can copy the stage folder outside of the container and
execute Open RV.

### Cleanup
Container id is the same as the one used in the step [Go into the container](go_into_the_rocky8_container).

To clean up, simply remove the image:
```bash
docker image rm openrv
docker cp <container id>:/home/rv/OpenRV/_build/stage ./openrv_stage
```

0 comments on commit 5d3b077

Please sign in to comment.