Installation¶

Pip Install¶

By default, grill won’t install USD, PySide2 & PyOpenGL. This is because DCC apps and other environments bundle them outside of pip. To include them, use the [full] option.

python -m pip install grill
python -m pip install grill[full]

Note

For some DCC applications (e.g. Houdini, Maya) pip needs to run from their corresponding python interpreters:

If pip is missing, follow this guide.

hython -m pip install grill

Visit the official docs for more details.

mayapy -m pip install grill

Extra Dependencies¶

The following optional dependencies should be installed separately.

Conda Environment Example¶

For environment management, The Grill uses conda. This is a walk-through on how to start using The Grill tools with a fresh conda environment.

  1. If the conda command is not on the system yet, install miniconda.

    Hint

    conda installation comes in two flavors:

  2. Launch Anaconda Prompt (it came as part of the miniconda installation).

  3. Create a new conda environment with python=3.9, for example:

    (base) C:\>conda create -n grilldemo01 python=3.9
    
  4. Activate that environment:

    (base) C:\>conda activate grilldemo01
    
  5. Install grill via pip; use the full option to use standalone. Refer to the pip install instructions for more details.

    (grilldemo01) C:\>python -m pip install grill[full]
    
  6. If missing, (optionally) install pygraphviz via conda:

    Warning

    At the moment, installing pygraphviz can be tricky. Hopefully a simpler pip based solution comes with pygraphviz#167.

    Replace --global-option to the correct Include and Lib paths on the system (where graphviz\cgraph.h and cgraph.lib paths exist, respectively):

    (grilldemo01) C:\>conda install --channel conda-forge pygraphviz
    (grilldemo01) C:\>python -m pip install --global-option=build_ext --global-option="-IC:\Users\Christian\.conda\envs\glowdeps\Library\include" --global-option="-LC:\Users\Christian\.conda\envs\glowdeps\Library\lib" pygraphviz
    

    Replace --global-option to the correct Include and Lib paths on the system (where graphviz\cgraph.h and cgraph.lib paths exist, respectively):

    (grilldemo01) C:\>conda install --channel conda-forge pygraphviz
    (grilldemo01) C:\Program Files\Side Effects Software\Houdini 19.5.534\bin>hython -m pip install --global-option=build_ext --global-option="-IC:\Users\Christian\.conda\envs\glowdeps\Library\include" --global-option="-LC:\Users\Christian\.conda\envs\glowdeps\Library\lib" pygraphviz
    

    Replace --global-option to the correct Include and Lib paths on the system (where graphviz\cgraph.h and cgraph.lib paths exist, respectively) and the Maya Python include and lib paths:

    (grilldemo01) C:\>conda install --channel conda-forge pygraphviz
    (grilldemo01) C:\Program Files\Autodesk\Maya2023\bin>mayapy -m pip install --global-option=build_ext  --global-option="-IC:\Users\Christian\.conda\envs\glowdeps\Library\include;C:\Program Files\Autodesk\Maya2023\include\Python39\Python" --global-option="-LC:\Users\Christian\.conda\envs\glowdeps\Library\lib;C:\Program Files\Autodesk\Maya2023\lib" pygraphviz
    
  7. You should be able to see the 👨‍🍳 Grill menu in USDView, Maya and Houdini*.

    https://user-images.githubusercontent.com/8294116/114263497-2d57d680-9a29-11eb-8992-6b443f942263.gif
    https://user-images.githubusercontent.com/8294116/115981745-68d1d380-a5d9-11eb-8033-979d72ca0e6b.gif
    https://user-images.githubusercontent.com/8294116/115981668-bdc11a00-a5d8-11eb-9897-6061639d1c39.gif

    Important

    To see the menu in Houdini, run this additional step (which installs the grill houdini package on the Houdini’s user preferences):

    hython -c "from grill.__startup__ import houdini;houdini.install_package()"
    

    The manual execution of this step might be removed in the future.