# 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 &
```
```python
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`<br>
## Documentation
For full package documentation please visit [allen-cell-animated.github.io/agave](https://allen-cell-animated.github.io/agave).
## Development
See [CONTRIBUTING.md](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**
Raw data
{
"_id": null,
"home_page": "https://github.com/allen-cell-animated/agave",
"name": "agave-pyclient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "agave_pyclient",
"author": "Daniel Toloudis",
"author_email": "danielt@alleninstitute.org",
"download_url": "https://files.pythonhosted.org/packages/5b/d9/47ab36d3d361010e7405ff15994626afd9b7a6b8be73ecf7185585914024/agave_pyclient-1.7.2.tar.gz",
"platform": null,
"description": "# agave_pyclient\n\nA Python client for the AGAVE 3d volume renderer\n\n---\n\n## Features\n\n- Connects to AGAVE server and sends draw commands. Receives and saves rendered images.\n\n## Quick Start\n\nYou must have AGAVE installed. On command line, run:\n\n```\nagave --server &\n```\n\nFor Linux headless operation, you need to tell the Qt library to use the offscreen platform plugin:\n\n```\nagave -platform offscreen --server &\n```\n\n```python\nfrom agave_pyclient import AgaveRenderer\n\n# 1. connect to the AGAVE server\nr = agave_pyclient.AgaveRenderer()\n# 2. tell it what data to load\nr.load_data(\"my_favorite.ome.tiff\")\n# 3. set some render settings (abbreviated list here)\nr.set_resolution(681, 612)\nr.background_color(0, 0, 0)\nr.render_iterations(128)\nr.set_primary_ray_step_size(4)\nr.set_secondary_ray_step_size(4)\nr.set_voxel_scale(0.270833, 0.270833, 0.53)\nr.exposure(0.75)\nr.density(28.7678)\n# 4. give the output a name\nr.session(\"output.png\")\n# 5. wait for render and then save output\nr.redraw()\n```\n\n## Installation\n\n**Stable Release:** `pip install agave_pyclient`<br>\n\n## Documentation\n\nFor full package documentation please visit [allen-cell-animated.github.io/agave](https://allen-cell-animated.github.io/agave).\n\n## Development\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the code.\n\n## The Four Commands You Need To Know\n\n1. `pip install -e .[dev]`\n\n This will install your package in editable mode with all the required development\n dependencies (i.e. `tox`).\n\n2. `make build`\n\n This will run `tox` which will run all your tests in both Python 3.7\n and Python 3.8 as well as linting your code.\n\n3. `make clean`\n\n This will clean up various Python and build generated files so that you can ensure\n that you are working in a clean environment.\n\n4. `make docs`\n\n This will generate and launch a web browser to view the most up-to-date\n documentation for your Python package.\n\n**Allen Institute Software License**\n",
"bugtrack_url": null,
"license": "Allen Institute Software License",
"summary": "A Python client for the Agave 3d volume renderer",
"version": "1.7.2",
"project_urls": {
"Homepage": "https://github.com/allen-cell-animated/agave"
},
"split_keywords": [
"agave_pyclient"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "735383238e3207cb397304770d45ac6856816f06914d9cbe3128a8d04158decb",
"md5": "d87523b302ef9b9c34ed246ea5ed81c7",
"sha256": "f166c954f2e302cb2e5a6e07824b873f8c7e15192078da30953238ad11f0b7fd"
},
"downloads": -1,
"filename": "agave_pyclient-1.7.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d87523b302ef9b9c34ed246ea5ed81c7",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 14483,
"upload_time": "2024-09-25T14:11:07",
"upload_time_iso_8601": "2024-09-25T14:11:07.572184Z",
"url": "https://files.pythonhosted.org/packages/73/53/83238e3207cb397304770d45ac6856816f06914d9cbe3128a8d04158decb/agave_pyclient-1.7.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5bd947ab36d3d361010e7405ff15994626afd9b7a6b8be73ecf7185585914024",
"md5": "f5594d006b0b176e733ef999c2d58ab5",
"sha256": "94a2214170b8ed4dbcd14c92b2454fa057360f8e3b9f78d8d402474d94fb669e"
},
"downloads": -1,
"filename": "agave_pyclient-1.7.2.tar.gz",
"has_sig": false,
"md5_digest": "f5594d006b0b176e733ef999c2d58ab5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19442,
"upload_time": "2024-09-25T14:11:09",
"upload_time_iso_8601": "2024-09-25T14:11:09.168467Z",
"url": "https://files.pythonhosted.org/packages/5b/d9/47ab36d3d361010e7405ff15994626afd9b7a6b8be73ecf7185585914024/agave_pyclient-1.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-25 14:11:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "allen-cell-animated",
"github_project": "agave",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "agave-pyclient"
}
JSON
