1 of 4

Configure

To install Liberate.FHE, there are a few prerequisites that need to be met. First, you will need an Nvidia graphics card. Additionally, CUDA and Python must also be installed. Only after meeting these requirements can you proceed with the installation of Liberate.FHE.

Detailed steps to install Liberate.FHE can be found on How to Install. After downloading Liberate.FHE from GitHub, it needs to be installed as a Python package

GPU & CUDA

To use Liberate.FHE, a GPU is required. This document explains how to set up and install the Nvidia graphics card driver and CUDA. It provides steps to identify and install the GPU, update package lists, install Nvidia drivers, verify the installation, install the CUDA toolkit, set environment variables, and verify the CUDA installation.

Setting graphic card

GPU

Step 1: Identify your GPU

Before you begin, it's essential to identify the Nvidia GPU model in your system. You can use the following commands to check:

If the Nvidia graphics card is not installed or an incompatible version of CUDA is installed, install a new version.

Step 2: Update package lists

Ensure that your package lists are up to date.

Check available graphic cards.

Step 3: Install nvidia driver

Automatically install the recommended drivers.

Alternatively, manually install the desired version.

Don't forget to restart the server after installing the graphic card driver.

Step 4: Verify installation

Please ensure that the graphics card is in working order.

CUDA

Step 1: Verify your GPU

Step 2: Install the nvidia GPU drivers

Please refer to the instructions provided above.

Step 3: Download CUDA toolkit

Step 4: Install the CUDA toolkit

Assuming you've downloaded the toolkit:

Step 5: Set environment variables

Add CUDA to your PATH and update LD_LIBRARY_PATH. You can do this by adding the following lines to your ~/.bashrc or ~/.zshrc file:

Remember to provide the source for your updated profile:

Step 6: Verify installation

Please verify if CUDA has been installed correctly by executing the following command:

This should display the CUDA compiler version.

Python

Installing python

This document offers comprehensive guidelines for installing Python on Ubuntu. It discusses multiple installation methods, such as utilizing APT, Anaconda, or pyenv for Python version management. The document also provides detailed instructions for installing Anaconda, setting up a virtual environment with Anaconda, and installing and configuring pyenv for Python version and virtual environment management.

Installing python using apt

Before installing on Ubuntu, it is important to check if Python is already installed on your system. You can do this by running the following command:

If Python ^3.10 is not already installed, you have the option to use APT to install it on your system. To do so, please follow these steps:

To update the system repository list, use the following command:sudo apt install python3

To set up Python, install the required dependencies using the following command:sudo apt
Install the latest version of Python with the command:

(Recommended) Using Anaconda or pyenv

Instead of directly installing Python on your system, it is recommended to use Python version management tools like Anaconda or pyenv.

Installing python using anaconda

If you are using Linux and want to use GUI packages, you will need to install additional dependencies for Qt.

To install the latest version of Anaconda, follow these steps:

Download the latest version of Anaconda from the official website:shasum -a 256
(Recommended) Ensure the integrity of the installer's data by verifying it with SHA-256. For additional details on hash verification, please refer to the documentation on cryptographic hash validation.
Install Anaconda by running the downloaded installer :
Update all packages in Anaconda
Set up a Python Virtual Environment using Anaconda :
Activate the virtual environment :

Installing python using pyenv

To configure pyenv, you can simply follow these steps :

Download pyenv using the following command:
Update pyenv to the latest version :
To ensure proper configuration, please add the necessary settings to your shell startup file (~/.bashrc, ~/.zshrc, etc.), based on your shell environment.
- For Bash :
- For Zsh :
To install the Python version you want, you can use pyenv. First check the available Python versions using the command pyenv install --list. Then, install a specific version by running the appropriate command.
To start, create a Python virtual environment and activate it :

Liberate

Prerequisite Package

GPU

Please refer to the respective page for instructions on how to install a GPU.

CUDA

Please refer to the respective page for instructions on how to install a CUDA.

Python

Please refer to the respective page for instructions on how to install a Python.

Liberate.FHE

Step 1: Clone the github repository

Clone the Github repository of Liberate.FHE to obtain the latest source code.

git clone https://github.com/Desilo/liberate-fhe.git

Step 2: Install dependencies

Use poetry to install the project dependencies. Open the terminal and run the command poetry install. This will automatically install all the required packages for the Liberate.FHE.

poetry install

Step 3: Run CUDA build script

To build CUDA by running the setup.py file. In the terminal, run the command poetry run python setup.py install. This command will build CUDA files.

python setup.py install
# poetry run python setup.py install

Step 4: Install Liberate.FHE library

Install the Liberate.FHE by running the command poetry run python -m pip install .in the terminal. This will install the Liberate.FHE library into your system.

pip install .
# poetry run python -m pip install .

Liberate

Prerequisite Package

GPU

Please refer to the respective page for instructions on how to install a GPU.

CUDA

Please refer to the respective page for instructions on how to install a CUDA.

Python

Please refer to the respective page for instructions on how to install a Python.

Liberate.FHE

Step 1: Clone the github repository

Clone the Github repository of Liberate.FHE to obtain the latest source code.

git clone https://github.com/Desilo/liberate-fhe.git

Step 2: Install dependencies

Use poetry to install the project dependencies. Open the terminal and run the command poetry install. This will automatically install all the required packages for the Liberate.FHE.

poetry install

Step 3: Run CUDA build script

To build CUDA by running the setup.py file. In the terminal, run the command poetry run python setup.py install. This command will build CUDA files.

python setup.py install
# poetry run python setup.py install

Step 4: Install Liberate.FHE library

Install the Liberate.FHE by running the command poetry run python -m pip install .in the terminal. This will install the Liberate.FHE library into your system.

pip install .
# poetry run python -m pip install .

GPU & CUDA

Setting graphic card

GPU

Step 1: Identify your GPU

Before you begin, it's essential to identify the Nvidia GPU model in your system. You can use the following commands to check:

If the Nvidia graphics card is not installed or an incompatible version of CUDA is installed, install a new version.

Step 2: Update package lists

Ensure that your package lists are up to date.

Check available graphic cards.

Step 3: Install nvidia driver

Automatically install the recommended drivers.

sudo ubuntu-drivers autoinstall

Alternatively, manually install the desired version.

sudo apt install nvidia-driver-535-server

Don't forget to restart the server after installing the graphic card driver.

Step 4: Verify installation

Please ensure that the graphics card is in working order.

nvidia-smi

If you encounter any issues during the installation or need further customization, you can refer to the official or seek help from the Ubuntu community forums.

CUDA

Step 1: Verify your GPU

Make sure your GPU is CUDA-compatible. You can find a list of CUDA-enabled GPUs on the .

Step 2: Install the nvidia GPU drivers

Please refer to the instructions provided above.

Step 3: Download CUDA toolkit

Visit the Nvidia download page.

Step 4: Install the CUDA toolkit

Assuming you've downloaded the toolkit:

# ex)cuda 12.1.0
wget https://developer.download.nvidia.com/compute/cuda/12.1.0/local_installers/cuda_12.1.0_530.30.02_linux.run
sudo sh cuda_12.1.0_530.30.02_linux.run

Step 5: Set environment variables

Add CUDA to your PATH and update LD_LIBRARY_PATH. You can do this by adding the following lines to your ~/.bashrc or ~/.zshrc file:

export PATH=/usr/local/cuda-12.1/bin${PATH:+:${PATH}}
export LD_LIBRARY_PATH=/usr/local/cuda-12.1/lib64${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}

Remember to provide the source for your updated profile:

source ~/.bashrc

Step 6: Verify installation

Please verify if CUDA has been installed correctly by executing the following command:

nvcc --version

This should display the CUDA compiler version.

Python

Installing python

Installing python using apt

Before installing on Ubuntu, it is important to check if Python is already installed on your system. You can do this by running the following command:

If Python ^3.10 is not already installed, you have the option to use APT to install it on your system. To do so, please follow these steps:

To update the system repository list, use the following command:sudo apt install python3

To set up Python, install the required dependencies using the following command:sudo apt
Install the latest version of Python with the command:

(Recommended) Using Anaconda or pyenv

Instead of directly installing Python on your system, it is recommended to use Python version management tools like Anaconda or pyenv.

Installing python using anaconda

is a software package that includes Python and R programming languages. It is widely used in scientific computing for various fields like data science, machine learning, and large-scale data processing.

If you are using Linux and want to use GUI packages, you will need to install additional dependencies for Qt.

apt-get install libgl1-mesa-glx libegl1-mesa libxrandr2 libxrandr2 libxss1 libxcursor1 libxcomposite1 libasound2 libxi6 libxtst6

To install the latest version of Anaconda, follow these steps:

Download the latest version of Anaconda from the official website:shasum -a 256

apt-get install libgl1-mesa-glx libegl1-mesa libxrandr2 libxrandr2 libxss1 libxcursor1 libxcomposite1 libasound2 libxi6 libxtst6

(Recommended) Ensure the integrity of the installer's data by verifying it with SHA-256. For additional details on hash verification, please refer to the documentation on cryptographic hash validation.
```
shasum -a 256 /PATH/ANACONDA
# Replace /PATH/FILENAME with your installation's path and filename.
```

Install Anaconda by running the downloaded installer :

bash ~/PATH/TO/ANACONDA
# bash ./Anaconda3-2023.09-0-Linux-x86_64.sh

Update all packages in Anaconda
```
conda update --all
```

Set up a Python Virtual Environment using Anaconda :

conda create -n <Environment Name> python=<Version>
# e.g., conda create -n Liberate python=3.11

Activate the virtual environment :

conda activate <Environment Name>
# e.g., conda activate Liberate

For more information on how to use Anaconda and its features, please refer to the .

Installing python using pyenv

is a tool that enables you to conveniently handle multiple Python versions and virtual environments.

To configure pyenv, you can simply follow these steps :

Download pyenv using the following command:

curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash

Update pyenv to the latest version :
```
pyenv update
```

To ensure proper configuration, please add the necessary settings to your shell startup file (~/.bashrc, ~/.zshrc, etc.), based on your shell environment.

For Bash :

echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc
echo 'command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(pyenv init -)"' >> ~/.bashrc

For Zsh :

echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.zshrc
echo '[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.zshrc
echo 'eval "$(pyenv init -)"' >> ~/.zshrc

To install the Python version you want, you can use pyenv. First check the available Python versions using the command pyenv install --list. Then, install a specific version by running the appropriate command.
```
pyenv install --list
pyenv install <PYTHON VERSION>
# ex) pyenv install 3.11.6
```

To start, create a Python virtual environment and activate it :

pyenv virtualenv <PYTHON VERSION> <VIRTULAENV NAME>
# ex) pyenv virtualenv 3.11.6 liberate
pyenv activate <VIRTUALENV NAME>
# ex) pyenv activate liberate

To learn more about using pyenv and its features, please refer to the .