Skip to content

Latest commit

 

History

History
19 lines (11 loc) · 1.43 KB

README.md

File metadata and controls

19 lines (11 loc) · 1.43 KB
Raw

RenderStream-py

Python bindings for the RenderStream API, installable as an engine for .pyrs RenderStream applications.

Installing the engine

On every RX or development workstation which uses .pyrs RenderStream assets, the engine needs to be installed. To install, follow the steps below:

  1. Open Windows PowerShell
  2. Run iex (iwr https://github.com/disguise-one/RenderStream-py/raw/r1.31/scripts/install.ps1).Content

The engine is installed into RenderStream Engines which is a sibling folder of RenderStream Projects. It currently uses python 3.10, as some common packages are not yet compatible with later versions of Python. The bindings themselves are compatible with any Python version >= 3.7

Testing the engine

The engine is associated with .pyrs file extensions. There are example .pyrs assets in the samples folder of this repository. Copy the whole samples folder to your RenderStream Projects folder. The cube and schema RenderStream assets should appear immediately. Configure a RenderStream layer to use the asset.

Installing asset dependencies

Adding a requirements.txt in the same folder as a .pyrs asset will allow dependencies to be installed in a pyrs_packages folder next to the .pyrs script file. This folder can be copied as-is across RX machines.