Installation

Installation on Linux

1. Download and install the BitFlow Linux Drivers and SDK along with the BitFlow Tools for Linux (BFT4Lin) package.

   Please contact the BitFlow Sales Department (sales@bitflow.com) to purchase the SDK.

2. Download and install the latest supported Python version.

   $ sudo apt install python3
   

   Refer to the installation guide to install a different version of Python.

   The Python versions currently supported are:

   • Python 3.10

   • Python 3.8

3. Download the tarball containing the latest whl file, example programs, and the html documentation and extract the file to any location on your PC.

   • BFModule for Linux

4. Navigate to the folder location.

   $ cd [Extracted folder location]
   

5. [Optional]

   Create a virtual environment using the command:

   $ python3 -m venv [venv-name]
   

   To activate the virtual environment run the following command:

   $ source [venv-name]/bin/activate
   

6. To install BFModule using the wheel file:

   (venv-name) $ python.exe -m pip install BFModule-X.x.x-cpXX-cpXX-linux_x86_64.whl
   

   Where, BFModule-X.x.x-cpXX-cpXX-linux_x86_64.whl is the name of the WHL file in the extracted folder.

7. Add the BFT4Lin library directory to the LD_LIBRARY_PATH variable.

   $export LD_LIBRARY_PATH="/usr/local/lib/BitFlow:$LD_LIBRARY_PATH"
   

Installation on Windows

1. Download and install the desired Python version. The versions currently supported are:

   • Python 3.10

   • Python 3.8

   • Python 3.6

2. Make sure to add the path to python.exe to your PATH variable like:

   $ set PATH=c:\[PYTHON_INSTALL_DIR];%PATH%
   

3. Download the zip file containing the latest whl file, example programs, and the html documentation and unzip the file to any location on your PC.

   • BFModule for Windows

4. Navigate to the unzipped folder location.

   $ cd [Unzip folder location]
   

5. [Optional]

   Create a virtual environment using the command:

   $ python.exe -m venv [venv-name]
   

   To activate the virtual environment run the following command:

   $ [venv-name]\Scripts\activate
   

6. To install BFModule using the wheel file:

   (venv-name) $ python.exe -m pip install BFModule-X.x.x-cpXX-cpXX-win_amd64.whl
   

Where, BFModule-X.x.x-cpXX-cpXX-win_amd64.whl is the name of the WHL file in the extracted folder.