Skip to main content

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 allencell.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

Metadata

Release files for agave-pyclient 1.10.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for agave-pyclient 1.10.1
File Size Uploaded Provenance Actions
agave_pyclient-1.10.1.tar.gz 23.2 kB Without provenance Details for agave_pyclient-1.10.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for agave-pyclient 1.10.1
File Interpreter ABI Platform Actions
agave_pyclient-1.10.1-py3-none-any.whl Python 3 none any Details for agave_pyclient-1.10.1-py3-none-any.whl

Total release size: 47.1 kB

Release files / agave_pyclient-1.10.1.tar.gz

Download URL agave_pyclient-1.10.1.tar.gz
Size 23.2 kB
Tags Source
SHA-256 checksum
How to use checksums
40f5a00310adf679a1af60b4ad2013e6ee1c72b02b7e46de7df90a9d92d3e1d9
BLAKE2b-256 checksum
How to use checksums
238dbef8746912c1ea25a739cd43ce7101a8a8a713d740737c8a7c563477e651
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / agave_pyclient-1.10.1-py3-none-any.whl

Download URL agave_pyclient-1.10.1-py3-none-any.whl
Size 24.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e025b9141e3e3557da67a2dc01ea0cf1a70c6e865a7c08d5ad50185196f7c00c
BLAKE2b-256 checksum
How to use checksums
2c3326aacc012bdd147a7d5a90851a75acf06bcaf79841302fda5c968d8eab83
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for agave-pyclient 1.10.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.

Release history Release notifications | RSS feed

This release

1.10.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page