Blue Brain BioExplorer Python SDK
The bioexplorer package provides an extended python API for the Blue Brain BioExplorer application
Installation
1. From the Python Package Index
(venv)$ pip install bioexplorer
2. From source
Clone the repository and install it:
(venv)$ git clone https://github.com/BlueBrain/BioExplorer.git
(venv)$ cd BioExplorer/bioexplorer/pythonsdk
(venv)$ pip install .
API
Connect to running Blue Brain BioExplorer instance
from bioexplorer import BioExplorer
bio_explorer = BioExplorer('localhost:5000')
Snapshot
The following example illustrates how to connect to the Blue Brain BioExplorer and export a snapshot of the current view to disk. The snapshot is exported to the /tmp folder, with a resolution of 512x512, and with 16 samples per pixel.
from bioexplorer import BioExplorer, MovieMaker
bio_explorer = BioExplorer('localhost:5000')
movie_maker = MovieMaker(bio_explorer)
movie_maker.create_snapshot(
renderer='bio_explorer', path='/tmp', base_name='test', ,size=[512, 512], samples_per_pixel=16)
Movie
The following example illustrates how to connect to the Blue Brain BioExplorer and generate a set of frames according to some given camera control points. Frames are exported to the /tmp folder.
from bioexplorer import BioExplorer, MovieMaker
bio_explorer = BioExplorer('localhost:5000')
movie_maker = MovieMaker(bio_explorer)
control_points = [
{
'apertureRadius': 0.0,
'direction': [0.0, 0.0, -1.0],
'focusDistance': 0.0,
'origin': [0.5, 0.5, 1.5],
'up': [0.0, 1.0, 0.0]
},
{
'apertureRadius': 0.0,
'direction': [-0.482, -0.351, -0.802],
'focusDistance': 0.0,
'origin': [2.020, 1.606, 3.030],
'up': [-0.199, 0.936, -0.289]
}
]
movie_maker.build_camera_path(
control_points=control_points, nb_steps_between_control_points=50,
smoothing_size=50)
movie_maker.set_current_frame(10)
movie_maker.create_movie(
path='/tmp', size=[512, 512], samples_per_pixel=16, start_frame=10, end_frame=20)
Upload to pypi
twine upload dist/*
Metadata
Release files for bioexplorer 1.7.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| bioexplorer-1.7.1.tar.gz | 67.1 kB | Without provenance | Details for bioexplorer-1.7.1.tar.gz |
Release files / bioexplorer-1.7.1.tar.gz
| Download URL | bioexplorer-1.7.1.tar.gz |
|---|---|
| Size | 67.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
10374a29e0f14fe6a0921bc08c67b43a56ded5d3b7b8d54b36cb6816abbbb057
|
|
BLAKE2b-256 checksum How to use checksums |
6fed419a125c3042c2fd4b1d3407bbb9bc0044ff18c27f79971ef0d5096eeb1b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Security for bioexplorer 1.7.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.