brayns 0.7.0.dev0

Brayns python API

Brayns

The brayns package provides a python API to the brayns application.

Documentation

Brayns documentation is built and hosted on readthedocs.

• latest snapshot
• latest release

Installation

It is recommended that you use pip to install Brayns into a virtualenv. The following assumes a virtualenv named venv has been set up and activated. We will see three ways to install Brayns

1. From the Python Package Index

(venv)$ pip install brayns

2. From git repository

(venv)$ pip install git+https://github.com/BlueBrain/Brayns.git#subdirectory=python

3. From source

Clone the repository and install it:

(venv)$ git clone https://github.com/BlueBrain/Brayns.git
(venv)$ pip install -e ./Brayns/python

This installs Brayns into your virtualenv in "editable" mode. That means changes made to the source code are seen by the installation. To install in read-only mode, omit the -e.

Connect to running Brayns instance

>>> from brayns import Client

>>> brayns = Client('localhost:8200')
>>> print(brayns)
Brayns version 0.7.0.c52dd4b running on http://localhost:8200/

Examples

Please find some examples how to interact with Brayns from python on Read the Docs.