Skip to main content

A Python client for the Agave 3d volume renderer

Project description


A Python client for the AGAVE 3d volume renderer


  • Connects to AGAVE server and sends draw commands. Receives and saves rendered images.

Quick Start

You must have AGAVE installed. On command line, run:

agave --server &

For Linux headless operation, you need to tell the Qt library to use the offscreen platform plugin:

agave -platform offscreen --server &
from agave_pyclient import AgaveRenderer

# 1. connect to the AGAVE server
r = agave_pyclient.AgaveRenderer()
# 2. tell it what data to load
# 3. set some render settings (abbreviated list here)
r.set_resolution(681, 612)
r.background_color(0, 0, 0)
r.set_voxel_scale(0.270833, 0.270833, 0.53)
# 4. give the output a name
# 5. wait for render and then save output


Stable Release: pip install agave_pyclient


For full package documentation please visit


See for information related to developing the code.

The Four Commands You Need To Know

  1. pip install -e .[dev]

    This will install your package in editable mode with all the required development dependencies (i.e. tox).

  2. make build

    This will run tox which will run all your tests in both Python 3.7 and Python 3.8 as well as linting your code.

  3. make clean

    This will clean up various Python and build generated files so that you can ensure that you are working in a clean environment.

  4. make docs

    This will generate and launch a web browser to view the most up-to-date documentation for your Python package.

Allen Institute Software License

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agave_pyclient-1.6.4.tar.gz (19.2 kB view hashes)

Uploaded Source

Built Distribution

agave_pyclient-1.6.4-py2.py3-none-any.whl (14.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page