The BrainFrame ecosystem includes a server for the video processing and a client to view the live results and configure the server.
The server requires a Linux machine, and the client can run on either Ubuntu 18 or Windows 10.
For this guide, we will use the
brainframe-cli (Command Line Interface) to
download and install BrainFrame. This tool requires Ubuntu 18.04.
First, let's install pip, and then use pip to install the
sudo apt update && sudo apt upgrade sudo apt install -y python3-pip sudo -H pip3 install --upgrade brainframe-cli
Starting the Server¶
With the tool installed, now you can use the
You can navigate the available commands from BrainFrame CLI by running:
Now, install BrainFrame by running the below command and following the directions:
sudo brainframe install
If you are in mainland China and downloading the BrainFrame Docker images is taking a long time, consider using a Docker mirror by following these instructions.
Once BrainFrame is downloaded, the BrainFrame CLI will ask you if you want to start BrainFrame server now or not. You can either start BrainFrame server now, or with the following command later:
sudo brainframe compose up -d
Then to view logs live:
sudo brainframe compose logs -f
If you said
Yes to adding your user to the brainframe group during the
installation, then rebooting your computer will allow you to use
brainframe commands without needing
Install BrainFrame Client¶
You can download our client app for Windows or Linux from here.
On Windows, run the BrainFrameClient.exe.
On the first run on Linux, run the installation script. Then, run the client.
bash install.sh bash brainframe_client.sh
Getting a License¶
The client will now request a license be uploaded to the server, like such:
To get a license:
- Go to the Aotu website.
- Click the "Sign In" button located near the top of the page.
- Either sign in with your existing account or click "Sign Up" to create a new account.
- On the Account Page, under the "License Key" section, click "Create a New Key". Then, click "Download Key" once the option appears.
Now on the client, select "Configure" and then "License Config". Drag in the
license_file into the window, then select "Update License". It
should complete looking like this:
Close the license config and the server config windows, and the client will open!
Now with the BrainFrame server and client installed, you can go on to use the ecosystem to your full advantage.