Is this page helpful?

Automating With Python#

In this section, we will explore a sample that automates all of the hands on sections of the content iteration cycle headlessly.

To explore the sample, clone the VFI Samples Repository and open the directory in VS Code, or your favorite IDE.

From Manual Operations to Automated Pipelines#

At facility scale—processing hundreds of components with continuous updates from multiple suppliers—these patterns must execute automatically with validation-driven quality gates.

The VFI Samples repository provides Python scripts demonstrating the transformation from pilot to platform:

Progressive Capability Implementation:

  • Aggregate sources: Automated CAD-to-USD conversion with specification-driven configuration.

  • Organize for navigability: Proper model hierarchy (kind metadata), naming conventions, payload-based composition.

  • Optimize for scale: Validation-driven optimization where presets are automatically selected based on detected issues.

  • Automate with validation: Repeatable pipelines with quality gates ensuring ecosystem interoperability.

Pipeline Integration Patterns:

  • Batch processing suitable for CI/CD workflows.

  • Validation contracts enabling multi-tool integration without custom preprocessing.

  • Non-destructive composition supporting parallel workstreams across teams.

  • Instance-ready composition where referenced assets use consistent structure to enable automatic prototype sharing.

These samples implement [asset structure principles](https://docs.omniverse.nvidia.com/usd/latest/learn-openusd/independent/asset-structure-principles.html) best practices – legibility, modularity, performance, navigability. Showing how structure enables digital twins to scale from planning through operations and evolve through lifecycle phases without reconstruction.

To explore the samples, clone the VFI Samples Repository and open the directory in VS Code, or your favorite IDE.

  1. Open a command prompt.

# cd into the directory where you want to clone the repository
cd D:/vfi

# clone the repository
git clone https://github.com/NVIDIA-Omniverse/VFI-Samples.git

# cd into the repository
cd vfi-samples

  1. Open the repository in VS Code or your favorite IDE.

  2. Open the automate.bat file and update the paths specified in the file.

:: Update this path to your Kit executable
set KIT_PATH=C:/Omniverse/kit-app-template/_build/windows-x86_64/release/kit/kit.exe

:: Update this path to the sample data folder
set VFI_WORKFLOW_DATA_FOLDER=C:/Omniverse/vfi/vfi_workflow_data

:: Update this path to your desired output location
set OUTPUT_ROOT=C:/Omniverse/vfi/output

  1. Execute the automate.bat file to run the complete VFI pipeline:

automate.bat

Note

The batch file includes 5 workflow sections. You can comment out sections you don’t want to run by adding REM` or `::` before the relevant lines:

- Section 1: CAD Conversion (JT to USD)
- Section 2: USD Validation
- Section 3: USD Optimization
- Section 4: Material Assignment
- Section 5: Component Aggregation

For detailed information about individual scripts, see the VFI Samples README in the repository.