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
-
pip install -e .[dev]
This will install your package in editable mode with all the required development dependencies (i.e.
tox
). -
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. -
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.
-
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for agave_pyclient-1.5.0rc3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4d2b55ce395f1b009a120159208cf875a19bff11d79c3acbe40c86a3ddc9824 |
|
MD5 | f196e44af9a9a5dcf79cb6aeeb64a334 |
|
BLAKE2b-256 | 9b4dc7db264759df4b22c16bfdef4c119cdb79f0cc2f101c2c47ba88f0150e31 |