Metadata-Version: 2.1
Name: napari-animation
Version: 0.0.1rc3
Summary: A plugin to make animations with napari
Home-page: https://github.com/napari/napari-animation
Author: Nicholas Sofroniew, Alister Burt, Guillaume Witz, Faris Abouakil, Talley Lambert
License: BSD 3-Clause
Download-URL: https://github.com/napari/napari-animation
Description: # napari-animation (WIP under active development)
        
        [![License](https://img.shields.io/pypi/l/napari-animation.svg?color=green)](https://github.com/napari/napari-animation/raw/master/LICENSE)
        [![PyPI](https://img.shields.io/pypi/v/napari-animation.svg?color=green)](https://pypi.org/project/napari-animation)
        [![Python Version](https://img.shields.io/pypi/pyversions/napari-animation.svg?color=green)](https://python.org)
        [![tests](https://github.com/sofroniewn/napari-animation/workflows/tests/badge.svg)](https://github.com/sofroniewn/napari-animation/actions)
        [![codecov](https://codecov.io/gh/sofroniewn/napari-animation/branch/master/graph/badge.svg)](https://codecov.io/gh/sofroniewn/napari-animation)
        
        **napari-animation** is a plugin for making animations in [napari].
        
        ----------------------------------
        
        This [napari] plugin was generated with [Cookiecutter] using with [@napari]'s [cookiecutter-napari-plugin] template.
        
        It is built off of great work from @guiwitz in [naparimovie](https://github.com/guiwitz/naparimovie) which was initially submitted to napari in [PR#851](https://github.com/napari/napari/pull/780).
        
        ----------------------------------
        ## Overview
        
        **napari-animation** provides a framework for the creation of animations in napari and features:
        - an easy to use GUI for interactive creation of animations
        - Python tools for programmatic creation of animations
        
        This plugin is currently pre-release and under active development. APIs are likely to change before it's first 0.0.1 release,
        but feedback and contributions are welcome.
        
        ## Installation
        
        You can clone this repository with install locally with
        
            pip install -e .
        
        ## Examples
        Examples can be found in our [examples](examples) folder. Simple examples for both interactive and headless 
        use of the plugin follow.
        
        ### Interactive
        **napari-animation** can be used interactively by creating an `AnimationWidget` from a napari `Viewer` and adding it to
        the viewer as a dock widget.
        
        ```python
        from napari_animation import AnimationWidget
        
        animation_widget = AnimationWidget(viewer)
        viewer.window.add_dock_widget(animation_widget, area='right')
        ```
        
        ![AnimationWidget image](resources/screenshot-animation-widget.png)
        
        ### Headless
        **napari-animation** can also be run headless, allowing for reproducible, scripted creation of animations.
        
        ```python
        from napari_animation import Animation
        
        animation = Animation(viewer)
        
        viewer.dims.ndisplay = 3
        viewer.camera.angles = (0.0, 0.0, 90.0)
        animation.capture_keyframe()
        viewer.camera.zoom = 2.4
        animation.capture_keyframe()
        viewer.camera.angles = (-7.0, 15.7, 62.4)
        animation.capture_keyframe(steps=60)
        viewer.camera.angles = (2.0, -24.4, -36.7)
        animation.capture_keyframe(steps=60)
        viewer.reset_view()
        viewer.camera.angles = (0.0, 0.0, 90.0)
        animation.capture_keyframe()
        animation.animate('demo.mov', canvas_only=False)
        ```
        
        ## Is everything animate-able?
        
        Unfortunately, not yet! Currently differences in the following objects are tracked by the `Animation` class
        
        - `Viewer.camera`
        - `Viewer.dims`
        - `Layer.scale`
        - `Layer.translate`
        - `Layer.rotate`
        - `Layer.shear`
        - `layer.opacity`
        - `Layer.blending`
        - `Layer.visible`
        
        Support for more layer attributes will be added in future releases.
        
        ## Contributing
        
        Contributions are very welcome. Tests and additional infrastructure are being setup.
        
        ## License
        
        Distributed under the terms of the [BSD-3] license,
        "napari-animation" is free and open source software
        
        ## Issues
        
        If you encounter any problems, please [file an issue] along with a detailed description.
        
        [napari]: https://github.com/napari/napari
        [Cookiecutter]: https://github.com/audreyr/cookiecutter
        [@napari]: https://github.com/napari
        [BSD-3]: http://opensource.org/licenses/BSD-3-Clause
        [cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin
        [file an issue]: https://github.com/sofroniewn/napari-animation/issues
        [napari]: https://github.com/napari/napari
        [tox]: https://tox.readthedocs.io/en/latest/
        [pip]: https://pypi.org/project/pip/
        [PyPI]: https://pypi.org/
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Framework :: napari
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
