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 &
from agave_pyclient import AgaveRenderer

# 1. connect to the agave server
r = agave_pyclient.AgaveRenderer()
# 2. tell it what data to load
r.load_volume_from_file("my_favorite.ome.tiff", 0, 0)
# 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.

Files for agave-pyclient, version 1.1.2
Filename, size File type Python version Upload date Hashes
Filename, size agave_pyclient-1.1.2-py2.py3-none-any.whl (13.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size agave_pyclient-1.1.2.tar.gz (18.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page