better installation instructions

Author: tomvanmele

CHANGELOG.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added Blender paths for Windows.
+* Added `compas_rhino.print_python_path`.
+* Added `compas_blender.print_python_path`.
+
 ### Changed
 
 ### Removed

docs/userguide/cad.blender.rst

@@ -26,24 +26,54 @@ The installation of COMPAS in Blender can be done in two ways:
 * by installing COMPAS in Blender's Python environment using ``pip``, or
 * by using the ``compas_blender.install`` command.
 
-Using ``pip``
--------------
+Using ``pip`` (recommended)
+---------------------------
 
 Blender comes with its own Python installation.
 This procedure simply uses that Python installation and associated ``pip`` to install COMPAS.
-It doesn't require an existing COMPAS installation on your system.
+The location of the executable is different on different platforms.
+The default locations are:
 
-You need to know the path to the Python executable that comes with Blender.
-On macOS, this is typically something like ``/Applications/Blender.app/Contents/Resources/4.0/python/bin/python3.10``.
+* Windows: ``C:\Program Files\Blender Foundation\Blender 4.0\4.0\python\bin\python.exe``
+* macOS: ``/Applications/Blender.app/Contents/Resources/4.0/python/bin/python3.10``
+* Linux: ``/usr/share/blender/4.0/python/bin/python3.10`` (i think :)
+
+.. note::
+
+    If you already have an installation of COMPAS on your system, you can try finding the Rhino 8 Python executable by running the following in a terminal or command prompt:
+
+    .. code-block:: python
+
+        python -m compas_rhino.print_python_path
+
+
+Install from PyPI
+~~~~~~~~~~~~~~~~~
+
+For example on Mac:
 
 .. code-block:: bash
 
     $ /Applications/Blender.app/Contents/Resources/4.0/python/bin/python3.10 -m pip install compas
 
 
+Install from Source
+~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: bash
+
+    $ cd path/to/compas
+    $ /Applications/Blender.app/Contents/Resources/4.0/python/bin/python3.10 -m pip install -e .
+
+
 Using ``compas_blender.install``
 --------------------------------
 
+.. warning::
+
+    This procedure will not install any of the dependencies required by COMPAS.
+    They have to already be present in the Blender Python environment.
+
 The ``compas_blender.install`` command installs COMPAS in Blender's Python ``site-packages`` folder
 by creating symlinks to COMPAS packages installed in an existing (``conda``) environment.
 Therefore, before running the command below, you should activate the environment in which you have installed COMPAS.
@@ -113,16 +143,3 @@ More info coming soon...
     blender_mesh = conversions.mesh_to_blender(mesh)
 
     mesh = conversions.mesh_to_compas(blender_mesh)
-
-
-Data Exchange
-=============
-
-
-Remote Procedure Calls
-======================
-
-
-Known Issues
-============
-

docs/userguide/cad.rhino.rst

@@ -9,14 +9,14 @@ are backwards compatible with Python 2.7 and written in pure Python,
 such that they can be used in Rhino IronPython scripts (Rhino 7 and below),
 as well as in the new Rhino CPython scripts (Rhino 8).
 
+Installation
+============
+
 .. warning::
 
     These instructions are for Rhino 6 and 7.
     For Rhino 8, please refer to :doc:`/userguide/cad.rhino8`.
 
-Installation
-============
-
 To use COMPAS in Rhino 6 or 7, you need to make Rhino aware of your COMPAS installation.
 This can be done with a simple command on the command line.
 
@@ -38,13 +38,12 @@ Once the command terminates, you should see a message like this:
 
     ...
 
-
-The default Rhino version is 7.
-To install into Rhino 6, use the ``-v`` flag.
+The default Rhino version is 8.
+To install into Rhino 7, use the ``-v`` flag.
 
 .. code-block:: bash
 
-    python -m compas_rhino.install -v 6.0
+    python -m compas_rhino.install -v 7.0
 
 Note that if COMPAS is installed in a ``conda`` environment, you need to activate it the environment before running the command.
 

docs/userguide/cad.rhino8.rst

@@ -15,65 +15,39 @@ Working in Rhino 8
 Installation
 ============
 
-The installation of COMPAS in Rhino 8 can be done in two ways:
-
-* by using the ``compas_rhino.install_with_pip`` command, or
-* by installing COMPAS in Rhino 8's Python environment using ``pip`` directly.
-
-
-Using ``pip``
--------------
-
 Rhino 8 comes with its own CPython executable (Python 3.9).
 This procedure simply uses that executable and its associated ``pip`` to install COMPAS.
 The location of the executable is different on different platforms.
 
 * Windows: ``%USERPROFILE%\.rhinocode\py39-rh8\python.exe``
 * macOS: ``~/.rhinocode/py39-rh8/python3.9``
 
-Install from PyPI
-~~~~~~~~~~~~~~~~~
-
-For example on Mac:
-
-.. code-block:: bash
-
-    $ ~/.rhinocode/py39-rh8/python3.9 -m pip install compas
-
-
-Install from Source
-~~~~~~~~~~~~~~~~~~~
-
-.. code-block:: bash
-
-    $ cd path/to/compas
-    $ ~/.rhinocode/py39-rh8/python3.9 -m pip install -e .
-
+.. note::
 
-Using ``compas_rhino.install_with_pip``
----------------------------------------
+    If you already have an installation of COMPAS on your system, you can try finding the Rhino 8 Python executable by running the following in a terminal or command prompt:
 
-To simplify the above procedure, ``compas_rhino`` provides a convnience command.
+    .. code-block:: bash
 
-.. warning::
+        python -m compas_rhino.print_python_path
 
-    This command is experimental and may not yet work properly on your system.
 
 Install from PyPI
 ~~~~~~~~~~~~~~~~~
 
+For example on Mac:
+
 .. code-block:: bash
 
-    $ python -m compas_rhino.install_with_pip compas
+    $ ~/.rhinocode/py39-rh8/python3.9 -m pip install compas
 
 
 Install from Source
 ~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: bash
 
-    $ cd /path/to/compas
-    $ python -m compas_rhino.install_with_pip "-e ."
+    $ cd path/to/compas
+    $ ~/.rhinocode/py39-rh8/python3.9 -m pip install -e .
 
 
 Verification
@@ -87,40 +61,3 @@ In Rhino 8, open the Python editor (just type ``ScriptEditor``), open an new ``P
     print(compas.__version__)
 
 If everything is installed correctly, this should print the version number of the installed COMPAS package.
-
-
-Visualisation
-=============
-
-Visualisation of COMPAS objects in Rhino 8 is handled the same way as in other Rhino version, using viualisation scenes.
-For more information on visualisation scenes, see :doc:`/userguide/basics.visualisation`.
-
-.. code-block:: python
-
-    import compas
-    from compas.datastructures import Mesh
-    from compas.scene import Scene
-
-    mesh = Mesh.from_obj(compas.get('tubemesh.obj'))
-
-    scene = Scene()
-    scene.clear()
-    scene.add(mesh)
-    scene.draw()
-
-
-Conversions
-===========
-
-
-Data Exchange
-=============
-
-
-Remote Procedure Calls
-======================
-
-
-Known Issues
-============
-

src/compas_blender/__init__.py

@@ -142,15 +142,33 @@ def _try_remove_bootstrapper(path):
 # =============================================================================
 
 
-def _get_default_blender_executable_path_mac():
+def _get_default_blender_executable_path(version):
+    version = _check_blender_version(version)
+
+    if compas.OSX:
+        path = _get_default_blender_executable_path_mac(version)
+    elif compas.WINDOWS:
+        path = _get_default_blender_executable_path_windows(version)
+    elif compas.LINUX:
+        path = _get_default_blender_executable_path_linux(version)
+    else:
+        raise Exception("Unsupported platform.")
+
+    if not os.path.exists(path):
+        raise Exception("The default installation folder for Blender doesn't exist.")
+
+    return path
+
+
+def _get_default_blender_executable_path_mac(version):
     return "/Applications/Blender.app/Contents/MacOS/Blender"
 
 
-def _get_default_blender_executable_path_windows():
-    raise NotImplementedError
+def _get_default_blender_executable_path_windows(version):
+    return "C:\\Program Files\\Blender Foundation\\Blender {}".format(version)
 
 
-def _get_default_blender_executable_path_linux():
+def _get_default_blender_executable_path_linux(version):
     raise NotImplementedError
 
 
@@ -163,12 +181,30 @@ def _get_default_blender_executable_path_linux():
 # =============================================================================
 
 
+def _get_default_blender_python_path(version):
+    version = _check_blender_version(version)
+
+    if compas.OSX:
+        path = _get_default_blender_python_path_mac(version)
+    elif compas.WINDOWS:
+        path = _get_default_blender_python_path_windows(version)
+    elif compas.LINUX:
+        path = _get_default_blender_python_path_linux(version)
+    else:
+        raise Exception("Unsupported platform.")
+
+    if not os.path.exists(path):
+        raise Exception("The default installation folder for Blender {} doesn't exist.".format(version))
+
+    return path
+
+
 def _get_default_blender_python_path_mac(version):
     return "/Applications/Blender.app/Contents/Resources/{}/python/bin/python3.10".format(version)
 
 
 def _get_default_blender_python_path_windows(version):
-    raise NotImplementedError
+    return "C:\\Program Files\\Blender Foundation\\Blender {}\\{}\\python\\bin\\python.exe".format(version, version)
 
 
 def _get_default_blender_python_path_linux(version):
@@ -207,7 +243,7 @@ def _get_default_blender_sitepackages_path_mac(version):
 
 
 def _get_default_blender_sitepackages_path_windows(version):
-    raise NotImplementedError
+    return "C:\\Program Files\\Blender Foundation\\Blender {}\\{}\\python\\lib\\site-packages".format(version, version)
 
 
 def _get_default_blender_sitepackages_path_linux(version):

src/compas_blender/print_python_path.py

@@ -0,0 +1,19 @@
+import compas_blender
+
+
+if __name__ == "__main__":
+    import argparse
+
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument(
+        "-v",
+        "--version",
+        choices=compas_blender.SUPPORTED_VERSIONS,
+        default=compas_blender.DEFAULT_VERSION,
+        help="The version of Blender.",
+    )
+
+    args = parser.parse_args()
+
+    print(compas_blender._get_default_blender_python_path(args.version))

src/compas_rhino/print_python_path.py

@@ -0,0 +1,19 @@
+import compas_rhino
+
+
+if __name__ == "__main__":
+    import argparse
+
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument(
+        "-v",
+        "--version",
+        choices=compas_rhino.SUPPORTED_VERSIONS,
+        default=compas_rhino.DEFAULT_VERSION,
+        help="The version of Rhino.",
+    )
+
+    args = parser.parse_args()
+
+    print(compas_rhino._get_default_rhino_cpython_path(version=args.version))