Merge pull request #1191 from compas-dev/bye-planarity

Replace planarity with networkx

Author: gonzalocasas

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+* Changed `Network.is_planar` to rely on `NetworkX` instead `planarity` for planarity checking.
+* Removed `planarity` from requirements.
 * Fixed argument order at `compas.geometry.cone.circle`.
 
 ### Removed

docs/userguide/configuration/blender.rst

@@ -177,7 +177,7 @@ Alternatively, you can create a new environment and simply install entire COMPAS
 
 .. code-block:: bash
 
-    conda create -n blender python=3.9 cython planarity --yes
+    conda create -n blender python=3.9 cython --yes
     conda activate blender
     pip install compas
     python -m compas_blender.install

docs/userguide/installation.rst

@@ -21,7 +21,7 @@ Create an environment named ``research`` and install COMPAS from the package cha
 
     conda create -n research -c conda-forge compas
 
-Activate the environment. 
+Activate the environment.
 
 .. code-block:: bash
 
@@ -71,17 +71,6 @@ Install an editable version from local source.
     cd path/to/compas
     pip install -e .
 
-By default, ``planarity`` is marked as an optional requirement for installation with ``pip`` on Windows.
-To include ``planarity``, add a conditional to the install command.
-
-.. code-block:: bash
-
-    pip install compas[planarity]
-
-.. code-block:: bash
-
-    pip install -e .[planarity]
-
 
 Update with conda
 =================
@@ -122,18 +111,6 @@ If you encounter a problem that is not described here,
 please file an issue using the `Issue Tracker <https://github.com/compas-dev/compas/issues>`_.
 
 
-Installing Planarity
---------------------
-
-The installation process with ``pip`` can fail while installing ``planarity``, because ``cython`` is not installed.
-If this is the case, install ``cython`` using ``pip`` (or ``conda``), before installing COMPAS.
-
-.. code-block:: bash
-
-    pip install cython --install-option="--no-cython-compile"
-    pip install compas
-
-
 Microsoft Visual C++ Build Tools
 --------------------------------
 

setup.py

@@ -66,7 +66,7 @@ def read(*names, **kwargs):
     zip_safe=False,
     install_requires=requirements,
     python_requires=">=2.7",
-    extras_require={"planarity": ["planarity"], "numba": ["numba"]},
+    extras_require={"numba": ["numba"]},
     entry_points={"console_scripts": ["compas_rpc=compas.rpc.__main__:main"]},
     ext_modules=[],
     cmdclass={},

src/compas/datastructures/network/planarity.py

@@ -164,7 +164,7 @@ def network_is_planar(network):
     Raises
     ------
     ImportError
-        If the planarity package is not installed.
+        If the networkx package is not installed.
 
     Notes
     -----
@@ -173,19 +173,15 @@ def network_is_planar(network):
     the plane exists, and, furthermore, that straight-line embedding in the plane
     exists.
 
-    Warnings
-    --------
-    This function uses the python binding of the *edge addition planarity suite*.
-    It is available on Anaconda: https://anaconda.org/conda-forge/python-planarity.
-
     """
     try:
-        import planarity
+        import networkx as nx
     except ImportError:
-        print("Planarity is not installed.")
+        print("NetworkX is not installed.")
         raise
 
-    return planarity.is_planar(list(network.edges()))
+    nxgraph = network.to_networkx()
+    return nx.is_planar(nxgraph)
 
 
 def network_is_planar_embedding(network):

tests/compas/datastructures/fixtures/non-planar.obj

@@ -0,0 +1,15 @@
+v 0.0 0.0 0.0
+v 1.0 0.0 0.0
+v 1.0 1.0 0.0
+v 0.0 1.0 0.0
+v 0.5 0.5 1.0
+l 1 2
+l 2 3
+l 3 4
+l 4 1
+l 1 3
+l 2 4
+l 1 5
+l 2 5
+l 3 5
+l 4 5

tests/compas/datastructures/fixtures/planar.obj

@@ -0,0 +1,10 @@
+v 0.0 0.0 0.0
+v 1.0 0.0 0.0
+v 1.0 1.0 0.0
+v 0.0 1.0 0.0
+l 1 2
+l 2 3
+l 3 4
+l 4 1
+l 1 3
+l 2 4

tests/compas/datastructures/test_network.py

@@ -1,16 +1,29 @@
-import pytest
-import compas
 import json
-from random import random, randint
+import os
+import random
+
+import pytest
 
+import compas
 from compas.datastructures import Network
 from compas.geometry import Pointcloud
 
-
 # ==============================================================================
 # Fixtures
 # ==============================================================================
 
+BASE_FOLDER = os.path.dirname(__file__)
+
+
+@pytest.fixture
+def planar_network():
+    return Network.from_obj(os.path.join(BASE_FOLDER, "fixtures", "planar.obj"))
+
+
+@pytest.fixture
+def non_planar_network():
+    return Network.from_obj(os.path.join(BASE_FOLDER, "fixtures", "non-planar.obj"))
+
 
 @pytest.fixture
 def k5_network():
@@ -57,7 +70,7 @@ def test_network_from_obj(filepath):
 
 
 def test_network_from_pointcloud():
-    cloud = Pointcloud.from_bounds(random(), random(), random(), randint(10, 100))
+    cloud = Pointcloud.from_bounds(random.random(), random.random(), random.random(), random.randint(10, 100))
     network = Network.from_pointcloud(cloud=cloud, degree=3)
     assert network.number_of_nodes() == len(cloud)
     for node in network.nodes():
@@ -70,7 +83,7 @@ def test_network_from_pointcloud():
 
 
 def test_network_data():
-    cloud = Pointcloud.from_bounds(random(), random(), random(), randint(10, 100))
+    cloud = Pointcloud.from_bounds(random.random(), random.random(), random.random(), random.randint(10, 100))
     network = Network.from_pointcloud(cloud=cloud, degree=3)
     other = Network.from_data(json.loads(json.dumps(network.data)))
 
@@ -123,24 +136,20 @@ def test_add_node():
 # ==============================================================================
 
 
-def test_non_planar(k5_network):
-    try:
-        import planarity  # noqa: F401
-    except ImportError:
+def test_non_planar(k5_network, non_planar_network):
+    # On IronPython, we completely skip adding the is_planar method because it depends on c-extensions (networkx)
+    if not hasattr(k5_network, "is_planar"):
         return
 
-    from compas.datastructures import network_is_planar
-
-    assert network_is_planar(k5_network) is not True
+    assert k5_network.is_planar() is not True
+    assert non_planar_network.is_planar() is not True
 
 
-def test_planar(k5_network):
-    try:
-        import planarity  # noqa: F401
-    except ImportError:
+def test_planar(k5_network, planar_network):
+    # On IronPython, we completely skip adding the is_planar method because it depends on c-extensions (networkx)
+    if not hasattr(k5_network, "is_planar"):
         return
 
-    from compas.datastructures import network_is_planar
-
     k5_network.delete_edge(("a", "b"))  # Delete (a, b) edge to make K5 planar
-    assert network_is_planar(k5_network) is True
+    assert k5_network.is_planar() is True
+    assert planar_network.is_planar() is True