Skip to content

Commit

Permalink
remove pygraphviz install steps
Browse files Browse the repository at this point in the history
  • Loading branch information
chrizzFTD committed Aug 19, 2024
1 parent c9bb5b4 commit a171047
Showing 1 changed file with 7 additions and 80 deletions.
87 changes: 7 additions & 80 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Extra Dependencies

The following optional dependencies should be installed separately.

- `graphviz <http://graphviz.org/>`_ and `pygraphviz`_ for graph widgets. See conda example below for instructions.
- `graphviz`_ for graph widgets. See conda example below for instructions.
- `usdview <https://openusd.org/release/toolset.html#usdview>`_
(hopefully will be available soon via `pypi <https://pypi.org/>`_). In the meantime, it can be built from USD source
(`conda recipe <https://github.com/PixarAnimationStudios/USD/issues/1260#issuecomment-656985888>`_).
Expand All @@ -69,11 +69,11 @@ walk-through on how to start using ``The Grill`` tools with a fresh
2. Launch `Anaconda Prompt <https://docs.anaconda.com/anaconda/user-guide/getting-started/#open-anaconda-prompt>`_
(it came as part of the `miniconda`_ installation).

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

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

Expand All @@ -88,84 +88,11 @@ walk-through on how to start using ``The Grill`` tools with a fresh
(grilldemo01) C:\>python -m pip install grill[full]
6. If missing, (optionally) install `pygraphviz`_ via ``conda``:
6. If missing, (optionally) install `graphviz`_ via ``conda``:

.. warning::

At the moment, installing `pygraphviz`_ can be tricky. Hopefully a simpler pip+wheel based solution comes with `pygraphviz#167 <https://github.com/pygraphviz/pygraphviz/issues/167>`_.

Versions older than ``pip-23.3.2`` may have trouble installing `pygraphviz`_ in Windows for DCCs like ``Maya`` and ``Houdini``.
If you come through this trouble, visit `pygraphviz#468 <https://github.com/pygraphviz/pygraphviz/pull/468>`_ and try to install with this exact particular version of ``pip``.
The below tests ran successfully with ``Maya-2024`` and ``Houdini-20.0`` on ``Windows-10`` and ``pip-23.3.2``.

The current ``pip`` version can be extracted like so:

.. tab:: Standalone Python

.. code:: PowerShell
python -m pip -V
.. tab:: Houdini

.. code:: PowerShell
hython -m pip -V
.. tab:: Maya

.. code:: PowerShell
mayapy -m pip -V
To update to ``23.3.2``, update the interpreter command to run:

.. tab:: Standalone Python

.. code:: PowerShell
python -m pip install -U pip==23.3.2
.. tab:: Houdini

.. code:: PowerShell
hython -m pip install -U pip==23.3.2
.. tab:: Maya

.. code:: PowerShell
mayapy -m pip install -U pip==23.3.2
.. tab:: Standalone Python

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

.. code:: PowerShell
(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
.. tab:: Houdini

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

.. code:: PowerShell
(grilldemo01) C:\>conda install --channel conda-forge pygraphviz
(grilldemo01) C:\Program Files\Side Effects Software\Houdini 19.5.534\bin>hython -m pip install -vvv --use-pep517 --config-settings="--global-option=build_ext" --config-settings="--global-option=-IC:\Users\Christian\.conda\envs\pygraphviz310\Library\include" --config-settings="--global-option=-LC:\Users\Christian\.conda\envs\pygraphviz310\Library\lib" pygraphviz
.. tab:: Maya

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:

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

Expand All @@ -191,7 +118,7 @@ walk-through on how to start using ``The Grill`` tools with a fresh
The manual execution of this step might be removed in the future.

.. _pygraphviz: https://pygraphviz.github.io/documentation/stable/install.html
.. _graphviz: http://graphviz.org
.. _miniconda: https://docs.conda.io/en/latest/miniconda.html
.. _Anaconda: https://docs.anaconda.com/anaconda/user-guide/getting-started/
.. _conda: https://docs.conda.io/projects/conda/en/latest/index.html

0 comments on commit a171047

Please sign in to comment.