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 buildThis will run
toxwhich will run all your tests in both Python 3.7 and Python 3.8 as well as linting your code. -
make cleanThis will clean up various Python and build generated files so that you can ensure that you are working in a clean environment.
-
make docsThis will generate and launch a web browser to view the most up-to-date documentation for your Python package.
Allen Institute Software License
1 maintainer
Release files for agave-pyclient 1.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| agave_pyclient-1.10.0.tar.gz | 23.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| agave_pyclient-1.10.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 47.1 kB
Release files / agave_pyclient-1.10.0.tar.gz
| Download URL | agave_pyclient-1.10.0.tar.gz |
|---|---|
| Size | 23.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
91be0b0dcdfbc65b14266ba30c3edb15b71141f3abd7589347aa4b85dcb7eba2
|
|
BLAKE2b-256 checksum How to use checksums |
83cd1f768c6cdbda74b6dd31107501f2dbbd39d6f05a124d76c49f3161a67821
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / agave_pyclient-1.10.0-py3-none-any.whl
| Download URL | agave_pyclient-1.10.0-py3-none-any.whl |
|---|---|
| Size | 24.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
76a50fb4f45dca0c22cfb137b38fb63894f4a927e45de7239faf27c4b7496ba6
|
|
BLAKE2b-256 checksum How to use checksums |
305766fb1916bbe53ff386ab1e4334207624ce6ef3da61f8068c6831ca70ad36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
