Table of Contents

Installation Guide - Linux

This guide is meant for users to install the package from scratch. To use this package to run the examples, you must install the additional Bonsai packages required to run each Example. Some familiarity with the terminal is necessary.

Notes on Installing Bonsai on Linux (Ubuntu)

Bonsai on Linux is not as straightforward as installing on Windows and is still being actively tested and optimized. Currently, Bonsai support has only been tested on Ubuntu 22.04. If you wish to try Bonsai on Linux, be sure to read the Linux Installation Guide for important information regarding how to install underlying Bonsai packge dependencies, such as OpenGL, OpenAL, OpenCV, etc., for use in Bonsai workflows.

Dependencies

To get started, you must install the following tools:

Warning

Be sure to check the python version and dotnet-sdk version to make sure you have the correct version of the tool installed, otherwise the steps in this guide may not work.

Creating Virtual Environments

  1. Create a folder for your project
cd ~/Desktop
mkdir LinearDynamicalSystems
cd LinearDynamicalSystems
  1. Create a python virtual environment.
Warning

This step uses the virtual env package from python to create a virtual environment. If you run into an error during this step, you may have to install the python virtual env package with sudo apt install python3.10-venv.

python3 -m venv .venv
  1. Create a bonsai environment.
Note

This step uses the bonsai linux environment template tool for easy creation of linux environments

dotnet new bonsaienvl

When prompted, enter yes to run the setup script.

Python Environment Setup Guide

  1. Activate the python environment
source .venv/bin/activate
  1. Install the lds_python package
pip install lds_python@git+https://github.com/joacorapela/lds_python@f761c201f3df883503ecb67acef35ba846e3524c

If you encounter errors during installation of the lds_python package, you will have to diagnose the issue and install the correct package dependencies manually.

  1. Check that the lds_python package has been installed correctly. Launch a python IDE:
python
  1. Check that you can correctly import the package:
import lds

If no errors appear when import lds is called in python, your python environment is ready. Exit python with the following command and move onto the next step:

exit()

Bonsai Environment Setup Guide

  1. Activate the bonsai environment and launch bonsai:
source .bonsai/activate
bonsai
  1. Open Bonsai's Package Manager from the startup menu and install the Bonsai.ML.LinearDynamicalSystems bonsai package from the menu. When installing the package, make sure to enter Accept on the prompts when asked to accept Terms and Conditions during installation.

You will now have access to Bonsai.ML.LinearDynamicalSystems modules from the Bonsai toolbox.

If all of these steps worked for you, head to the section on Getting Started.

Edit this page