Metadata-Version: 2.1
Name: agave_pyclient
Version: 1.0.3
Summary: A Python client for the Agave 3d volume renderer
Home-page: https://github.com/allen-cell-animated/agave
Author: Daniel Toloudis
Author-email: danielt@alleninstitute.org
License: Allen Institute Software License
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 &
        ```
        
        ```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_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`<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**
        
Keywords: agave_pyclient
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: GPU
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: License :: Free for non-commercial use
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Multimedia :: Graphics :: 3D Rendering
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: setup
Provides-Extra: test
Provides-Extra: dev
Provides-Extra: all
