Merge pull request #910 from compas-dev/blender-install

Simplify Blender installation

Author: tomvanmele

CHANGELOG.md

@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added `draw_node_labels` and `draw_edgelabels` to `compas_blender.artists.NetworkArtist`.
 * Added `compas_blender.artists.RobotModelArtist.clear`.
 * Added `compas_blender.geometry.booleans` as plugin for boolean pluggables.
+* Added version-based installation for Blender.
 
 ### Changed
 

docs/gettingstarted/blender.rst

@@ -22,13 +22,13 @@ the version of the bundled Python is 3.7, and for 2.93 LTS it is 3.9.
 Installation
 ============
 
-These instructions are for the latest Blender 2.83 LTS which ships with Python 3.7
-If you don't have an environment yet with Python 3.7 and COMPAS you can create one with ``conda``.
+These instructions are for the latest Blender 2.93 LTS which ships with Python 3.9
+If you don't have an environment yet with Python 3.9 and COMPAS you can create one with ``conda``.
 
 .. code-block:: bash
 
     conda config --add channels conda-forge
-    conda create -n blender python=3.7 COMPAS --yes
+    conda create -n blender python=3.9 COMPAS --yes
 
 Configuring Blender to use the newly installed environment is slightly different per OS.
 
@@ -58,9 +58,9 @@ Configuring Blender to use the newly installed environment is slightly different
 .. code-block:: bash
 
     conda activate blender
-    python -m compas_blender.install "%PROGRAMFILES%\\Blender Foundation\\Blender 2.83\\2.83"
+    python -m compas_blender.install "%PROGRAMFILES%\\Blender Foundation\\Blender 2.93\\2.93"
 
-Note that the path ``%PROGRAMFILES%\\Blender Foundation\\Blender 2.83\\2.83`` might be different on your system.
+Note that the path ``%PROGRAMFILES%\\Blender Foundation\\Blender 2.93\\2.93`` might be different on your system.
 Check your Blender installation and change the path accordingly.
 
 .. raw:: html
@@ -71,9 +71,9 @@ Check your Blender installation and change the path accordingly.
 .. code-block:: bash
 
     conda activate blender
-    python -m compas_blender.install /Applications/blender.app/Contents/Resources/2.83
+    python -m compas_blender.install /Applications/blender.app/Contents/Resources/2.93
 
-Note that the path ``/Applications/blender.app/Contents/Resources/2.83`` might be different on your system.
+Note that the path ``/Applications/blender.app/Contents/Resources/2.93`` might be different on your system.
 Check your Blender installation and change the path accordingly.
 
 .. raw:: html
@@ -84,9 +84,9 @@ Check your Blender installation and change the path accordingly.
 .. code-block:: bash
 
     conda activate blender
-    python -m compas_blender.install ~/Blender/2.83
+    python -m compas_blender.install ~/Blender/2.93
 
-Note that the path ``~/Blender/2.83`` might be different on your system.
+Note that the path ``~/Blender/2.93`` might be different on your system.
 Check your Blender installation and change the path accordingly.
 
 .. raw:: html
@@ -99,6 +99,14 @@ Check your Blender installation and change the path accordingly.
     </div>
     </div>
 
+On Windows and OSX, if Blender is installed in the default location, you can simply provide the version number.
+
+.. code-block:: bash
+
+    conda activate blender
+    python -m compas_blender.install -v 2.93
+
+
 Add-ons
 =======
 
@@ -287,3 +295,30 @@ Artists are currently only available for data structures and robots.
 
 There is also no official system yet for making custom COMPAS tools in Blender.
 Therefore, COMPAS Blender development is somewhat limited to individual scripts.
+
+Known Issues
+============
+
+On Windows, Blender sometimes has issues with finding NumPy libraries.
+If this is the case, the problem can usually be solved by reinstalling NumPy in your environment using ``pip``.
+However, to avoid issues with other packages that were already installed and depend on a specific version of NumPy,
+you should install the same version as the one installed originally by ``conda``.
+
+.. code-block:: bash
+
+    python -c "import numpy; print(numpy.__version__)"
+
+If the above is, for example, ``1.20.3``
+
+.. code-block:: bash
+
+    pip install --force-reinstall numpy==1.20.3
+
+Alternatively, you can create a new environment and simply install entire COMPAS using ``pip``.
+
+.. code-block:: bash
+
+    conda create -n blender python=3.9 cython planarity --yes
+    conda activate blender
+    pip install compas
+    python -m compas_blender.install

src/compas_blender/__init__.py

@@ -14,6 +14,9 @@
     compas_blender.utilities
 
 """
+import os
+import compas
+
 try:
     import bpy  # noqa: F401
 except ImportError:
@@ -44,6 +47,42 @@ def clear():
 __version__ = '1.8.1'
 
 
+def _check_blender_version(version):
+    supported_versions = ['2.83', '2.93']
+
+    if not version:
+        return '2.93'
+
+    if version not in supported_versions:
+        raise Exception('Unsupported Blender version: {}'.format(version))
+
+    return version
+
+
+def _get_default_blender_installation_path(version):
+    version = _check_blender_version(version)
+
+    if compas.OSX:
+        path = _get_default_blender_installation_path_mac(version)
+    elif compas.WINDOWS:
+        path = _get_default_blender_installation_path_windows(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_installation_path_mac(version):
+    return '/Applications/Blender.app/Contents/Resources/{}'.format(version)
+
+
+def _get_default_blender_installation_path_windows(version):
+    return os.path.expandvars('%PROGRAMFILES%/Blender Foundation/Blender {}/{}'.format(version, version))
+
+
 __all__ = [name for name in dir() if not name.startswith('_')]
 __all_plugins__ = [
     'compas_blender.geometry.booleans',

src/compas_blender/install.py

@@ -2,6 +2,9 @@
 import sys
 import tempfile
 
+import compas
+import compas_blender
+
 from compas._os import copy
 from compas._os import create_symlinks
 from compas._os import remove
@@ -41,27 +44,52 @@ def unregister():
 """
 
 
-def install(blender_path):
+def install(blender_path, version=None):
     """Install COMPAS for Blender.
 
     Parameters
     ----------
     blender_path : str
         The path to the folder with the version number of Blender.
         For example, on Mac: ``'/Applications/Blender.app/Contents/Resources/2.83'``.
-        On Windows: ``'%PROGRAMFILES%\\Blender Foundation\\Blender\\2.83'``.
+        On Windows: ``'%PROGRAMFILES%/Blender Foundation/Blender 2.83/2.83'``.
+    version : {'2.83', '2.93'}, optional
+        The version number of Blender.
+        Default is ``'2.93'``.
 
     Examples
     --------
     .. code-block:: bash
 
-        $ python -m compas_blender.install /Applications/Blender.app/Contents/Resources/2.83
+        $ python -m compas_blender.install
+
+    .. code-block:: bash
+
+        $ python -m compas_blender.install -v 2.93
+
+    .. code-block:: bash
+
+        $ python -m compas_blender.install /Applications/Blender.app/Contents/Resources/2.93
 
     """
     if not os.environ.get('CONDA_PREFIX'):
         print('Conda environment not found. The installation into Blender requires an active conda environment with a matching Python version to continue.')
         sys.exit(-1)
 
+    if not version and not blender_path:
+        version = '2.93'
+
+    if version and blender_path:
+        print('Both options cannot be provided simultaneously. Provide the full installation path, or the version with flag -v.')
+        sys.exit(-1)
+
+    if version:
+        if compas.LINUX:
+            print('Version-based installs are currently not supported for Linux. Please provide the full installation path with the -p option.')
+            sys.exit(-1)
+
+        blender_path = compas_blender._get_default_blender_installation_path(version)
+
     if not os.path.exists(blender_path):
         raise FileNotFoundError('Blender version folder not found.')
 
@@ -122,7 +150,9 @@ def install(blender_path):
 
     parser = argparse.ArgumentParser()
 
-    parser.add_argument('versionpath', help="The path to the folder with the version number of Blender.")
+    parser.add_argument('blenderpath', nargs='?', help="The path to the folder with the version number of Blender.")
+    parser.add_argument('-v', '--version', choices=['2.83', '2.93'], help="The version of Blender to install COMPAS in.")
+
     args = parser.parse_args()
 
-    install(args.versionpath)
+    install(args.blenderpath, version=args.version)