Pixyz Scenario Processor to SDK guidelines

Tip

Transitioning from Pixyz Scenario Processor (a standalone application executing commands) to the Pixyz SDK opens up a new range of integration possibilities. Consider re-designing your existing CAD/3D pipeline to take full advantage of this.

Steps to Transition

If your team currently relies on a Pixyz Scenario Processor script for automated transformations, follow these steps:

  1. Extract your existing transformation script (.py file(s)).
  2. Download Pixyz SDK (see setup section).
  3. Setup your favorite development environment (using PyCharm, Visual Code or other).
  4. Review the Pixyz SDK 2024.x changeLog and the updated Python API for any changes in method or function parameters. Please note that significant API cleaning has been performed, including various feature renaming.
  5. Adapt your existing Pixyz python script(s) to the new 2024.x API.
  6. Instead of calling [...]/PiXYZScenarioProcessor.exe myPythonScript.py simply run python myPythonScript.py
  7. Redeploy your data pipeline, now executing Pixyz SDK instance(s).

References