Metadata-Version: 2.1
Name: zpy-zumo
Version: 1.1.3
Summary: Create synthetic data with Blender.
Home-page: https://github.com/ZumoLabs/zpy
Author: Zumo Labs
Author-email: infra@zumolabs.ai
License: UNKNOWN
Description: <div align="center">
        
        <img src="https://github.com/ZumoLabs/zpy/raw/main/docs/zl_tile_logo.png" width="100px">
        
        **`zpy`: Synthetic data in Blender.**
        
        <p align="center">
          <a href="https://www.zumolabs.ai/?utm_source=github.com&utm_medium=referral&utm_campaign=zpy">Website</a> •
          <a href="#Install">Install</a> •
          <a href="https://zumo-zpy.readthedocs.io/en/latest/index.html">Docs</a> •
          <a href="#Examples">Examples</a> •
          <a href="#CLI">CLI</a> •
          <a href="#Contribute">Contribute</a> •
          <a href="#Licence">Licence</a>
        </p>
        
        <p align="center">
          <a href="https://discord.gg/nXvXweHtG8"><img alt="Discord" title="Discord" src="https://img.shields.io/badge/-ZPY Devs-grey?style=for-the-badge&logo=discord&logoColor=white"/></a>
          <a href="https://twitter.com/ZumoLabs"><img alt="Twitter" title="Twitter" src="https://img.shields.io/badge/-@ZumoLabs-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white"/></a>
          <a href="https://www.youtube.com/channel/UCcU2Z8ArljfDzfq7SOz-ytQ"><img alt="Youtube" title="Youtube" src="https://img.shields.io/badge/-ZumoLabs-red?style=for-the-badge&logo=youtube&logoColor=white"/></a>
          <a href="https://pypi.org/project/zpy-zumo/"><img alt="PyPI" title="PyPI" src="https://img.shields.io/badge/-PyPI-yellow?style=for-the-badge&logo=PyPI&logoColor=white"/></a>
          <a href="https://zumo-zpy.readthedocs.io/en/latest/index.html"><img alt="Docs" title="Docs" src="https://img.shields.io/badge/-Docs-black?style=for-the-badge&logo=Read%20the%20docs&logoColor=white"/></a>
        </p>
        
        </div>
        
        ![Synthetic raspberry pi](https://github.com/ZumoLabs/zpy/raw/main/docs/promo_image.png)
        
        ## Abstract
        
        Collecting, labeling, and cleaning data for computer vision is a pain. Jump into the future and create your own data instead! Synthetic data is faster to develop with, effectively infinite, and gives you full control to prevent bias and privacy issues from creeping in. We created `zpy` to make synthetic data easy, by simplifying the simulation (sim) creation process and providing an easy way to generate synthetic data at scale.
        
        ## Install
        
        - [Install using pip **(Windows/Mac/Linux)**](#installpip).
        - [Install Blender Addon from .zip **(Windows/Mac/Linux)**](#installzip).
        - [Install from script **(Mac/Linux)**](#installscript_linux)
        - [Developer mode **(Linux)**](https://github.com/ZumoLabs/zpy/tree/main/docs/developer_mode.md#install-linux-developer-environment-)
        - [Developer mode **(Windows)**](https://github.com/ZumoLabs/zpy/tree/main/docs/developer_mode.md#install-windows-developer-environment-)
        
        ### Install: Using Pip <a name="installpip"></a>
        
        You can install `zpy` with pip:
        
        ``` 
        pip install zpy-zumo
        ```
        
        Note that Blender has it's own python, seperate from your system/venv/conda python. You will have to install it into both.
        
        ### Install: Blender Addon <a name="installzip"></a>
        
        Once you have installed the `zpy` module into Blender's python, download the latest [zip](https://github.com/ZumoLabs/zpy/releases) (you want the one called `zpy_addon-v*.zip`). Then open up Blender. Navigate to `Edit` -> `Preferences` -> `Add-ons`. You should be able to install and enable the addon from there.
        
        ![Enabling the addon](https://github.com/ZumoLabs/zpy/raw/main/docs/install_zpy.png)
        
        ### Install: Linux: Using Install Script <a name="installscript_linux"></a>
        
        ``` 
        $ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/ZumoLabs/zpy/main/install.sh)"
        ```
        
        Set these environment variables for specific versions:
        
        ```
        export BLENDER_VERSION="2.92"
        export BLENDER_VERSION_FULL="2.92.0"
        export ZPY_VERSION="v1.1.3"
        ```
        ## CLI
        
        We provide a simple CLI. In order to run pip install zpy-zumo and then just run commands in that python environment.
        
        You can find documentation [here](https://github.com/ZumoLabs/zpy/tree/main/docs/cli/README.md).
        
        <p align="center"><img src="docs/cli/gif/createdataset.gif?raw=true"/></p>
        
        ## Examples
        
        **Video Tutorials**
        - [Loading the zpy Blender Add-On](https://youtu.be/xipj3jFsZyY)
        - [Run a Sim](https://youtu.be/1_-6Vb2s10Y)
        - [Using Script Templates](https://youtu.be/ywaEhKGBUK0)
        - [Segmentation Images](https://youtu.be/NxFrY3EcIMA)
        - [Depth Images](https://youtu.be/G4Wa9aQSlOw)
        - [Jittering Materials](https://youtu.be/WbarQmJ9qlY)
        - [Jittering Object Pose](https://youtu.be/4Pe9B4auE1M)
        - [Random HDRI Backgrounds](https://youtu.be/QzJ6Y3jwr4w)
        
        **Projects**
        - [Raspberry Pi Component Detection](https://towardsdatascience.com/training-ai-with-cgi-b2fb3ca43929)
        - [Vote Counting](https://towardsdatascience.com/patrick-vs-squidward-training-vote-detection-ai-with-synthetic-data-d8e24eca114d)
        
        **Video Code-Alongs**
        - [Suzanne: Part 1](https://github.com/ZumoLabs/zpy/tree/main/examples/suzanne)
        - [Suzanne: Part 2](https://github.com/ZumoLabs/zpy/tree/main/examples/suzanne_2)
        - [Suzanne: Part 3](https://github.com/ZumoLabs/zpy/tree/main/examples/suzanne_3)
        
        ## Documentation
        
        Code documentation can be found [here](https://zumo-zpy.readthedocs.io/en/latest/)
        
        ## Contributing
        
        We welcome community contributions! Search through the [current issues](https://github.com/ZumoLabs/zpy/issues) or open your own.
        
        ## Licence
        
        This release of zpy is under the GPLv3 license, a free copyleft license used by Blender. TLDR: Its free, use it!
        
        ## BibTeX
        
        If you use `zpy` in your research, we would appreciate the citation!
        
        ```bibtex
        @article{zpy,
          title={zpy: Synthetic data for Blender.},
          author={Ponte, H. and Ponte, N. and Karatas, K},
          journal={GitHub. Note: https://github.com/ZumoLabs/zpy},
          volume={1},
          year={2020}
        }
        ```
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
