D4rkCrypto/openfhe-python

Official Python wrapper for OpenFHE

Official Python wrapper for OpenFHE

Table of Contents

• Building
  • Prerequisites
  • Linux Install
    • Installing the .so: Conda
    • Installing the .so: System
• Running Examples
• OpenFHE Python Wrapper Documentation

Building

Requirements

Before building, make sure you have the following dependencies installed:

• OpenFHE
• Python 3.6+
• pybind11

We recommend following OpenFHE C++ installation instructions first (which covers Linux, Windows and MacOS) and then get back to this repo.

You can install pybind11 by runnning:

pip install "pybind11[global]" # or alternatively, if you use conda:
conda install -c conda-forge pybind11

For custom installation or any other issues, please refer to the official pybind11 documentation in the link above.

Linux

With all the dependencies set up, clone the repository, open a terminal in the repo folder and run the following commands:

mkdir build
cd build
cmake ..  # Alternatively, cmake .. -DOpenFHE_DIR=/path/to/installed/openfhe
make

At this point the .so file has been built. Your exact installation process will depend on your virtual environment. Cmake will automatically find the python installation path, if unwanted, you can specify the python path by adding -DPYTHON_EXECUTABLE_PATH=/path/to/python to the cmake command.

Conda

conda create -n ${ENV_NAME} python=3.{X} anaconda

where ${ENV_NAME} should be replaced with the name of your environment, and {X} should be replaced with your desired python version. For example you might have conda create -n openfhe_python python=3.9 anaconda

It's recommended to specify the python path to avoid any issues with conda environments. To do this, run the following commands:

mkdir build
cd build
cmake ..  # Or cmake .. -DPYTHON_EXECUTABLE_PATH=$CONDA_PREFIX/bin/python
make

The CONDA_PREFIX variable is set by conda, and points to the root of your active conda environment.

Then, you can develop the library:

mkdir lib
mv *.so lib
conda develop lib

which creates a lib folder, moves the built .so file into that lib folder, and tells conda where to look for external libraries.

Note You may wish to copy the .so file to any projects of your own, or add it to your system path to source from.

System install

make install  # You may have to run sudo make install

Code Examples

To get familiar with the OpenFHE Python API, check out the examples:

• FHE for arithmetic over integers (BFV):
  • Simple Code Example
• FHE for arithmetic over integers (BGV):
  • Simple Code Example
• FHE for arithmetic over real numbers (CKKS):
  • Simple Code Example
  • Advanced Code Example
  • Advanced Code Example for High-Precision CKKS
  • Arbitrary Smooth Function Evaluation
  • Simple CKKS Bootstrapping Example
  • Advanced CKKS Bootstrapping Example
  • Double-Precision (Iterative) Bootstrapping Example
• FHE for Boolean circuits and larger plaintext spaces (FHEW/TFHE):
  • Simple Code Example
  • Truth Table Example

OpenFHE Python Wrapper Documentation

OpenFHE Python Wrapper API Reference