Skip to main content

A Python client for the Agave 3d volume renderer

Project description

agave_pyclient

A Python client for the AGAVE 3d volume renderer


Features

  • 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
r.load_data("my_favorite.ome.tiff")
# 3. set some render settings (abbreviated list here)
r.set_resolution(681, 612)
r.background_color(0, 0, 0)
r.render_iterations(128)
r.set_primary_ray_step_size(4)
r.set_secondary_ray_step_size(4)
r.set_voxel_scale(0.270833, 0.270833, 0.53)
r.exposure(0.75)
r.density(28.7678)
# 4. give the output a name
r.session("output.png")
# 5. wait for render and then save output
r.redraw()

Installation

Stable Release: pip install agave_pyclient

Documentation

For full package documentation please visit allen-cell-animated.github.io/agave.

Development

See CONTRIBUTING.md 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.8.1.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

agave_pyclient-1.8.1-py2.py3-none-any.whl (14.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file agave_pyclient-1.8.1.tar.gz.

File metadata

  • Download URL: agave_pyclient-1.8.1.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for agave_pyclient-1.8.1.tar.gz
Algorithm Hash digest
SHA256 9ae0ad69c3f7a22f2dc226a612f8b1ac005aa29523646bee3d47dd4739519871
MD5 6a458f89b70a6f6898cc671b4bbf348f
BLAKE2b-256 6066a5a5ddba2bd2eea1477dda8be4a5943214bbd66825dae37baf24fffaf2a1

See more details on using hashes here.

File details

Details for the file agave_pyclient-1.8.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for agave_pyclient-1.8.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e296850a6208a60e0c760d7d525f0838b5868205e77fd019dfca9f59c010dda4
MD5 d682f1c5131a7f67bfa6b7c8d0010984
BLAKE2b-256 f9d1163c48adb3d50ef7621870db2c4e60c77dca74763e3f85904f6bde090f1b

See more details on using hashes here.

Supported by

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