Installation

This project will download and install additional third-party open source software projects. Review the license terms of these open source projects before use (e.g. OpenUSD license).

There are two ways to install scene_synthesizer: either directly installing from a PyPI server or by cloning the code repository.

Via pip

The most basic installation of scene_synthesizer will install as few dependencies as possible:

pip install scene-synthesizer

This allows you to load and export most common formats: STL, PLY, OBJ, GLB, GLTF, URDF.

For importing and exporting USD files use the recommend pip extra:

pip install scene-synthesizer[recommend]

If you want the full experience, you can try the all extra which includes all the functionality:

pip install scene-synthesizer[all]

Via git

Alternatively, if you want to make changes to scene_synthesizer, clone the repository:

# create and activate conda env or venv
git clone https://github.com/NVlabs/scene_synthesizer.git
cd scene_synthesizer/

# Again, there are the same three variations you can install:
# .
# .[recommend]
# .[all]
pip install -e .

Soft Dependencies

The function show_graph depends on pygraphviz. If required, install via

sudo apt-get install graphviz graphviz-dev
python -m pip install pygraphviz