doc update (dependencies, added pyclipper)

denisri · May 29, 2024 · fddd796 · fddd796
1 parent 838863c
commit fddd796
Showing 1 changed file with 17 additions and 9 deletions.
diff --git a/python/catamap/svg_to_mesh.py b/python/catamap/svg_to_mesh.py
@@ -36,15 +36,23 @@
 * numpy
 * scipy
 * optionally, soma.aims
-
-  The AIMS library is used to build and manpulate meshes.
-  (https://github.com/brainvisa/aims-free)
-  This lib is compiled (C++ + python bindings) thus is not completely
-  straightforward to install.
-  Alternately we can implement basic replacements for vector and mesh classes.
-  This allows to use the 2D part.
-  The 3D part however needs more algorithmic things in Aims, and Anatomist
-  to render depth maps.
+* optionally, pyclipper
+
+aims:
+
+    The AIMS library is used to build and manpulate meshes.
+    (https://github.com/brainvisa/aims-free)
+    This lib is compiled (C++ + python bindings) thus is not completely
+    straightforward to install.
+    Alternately we have implemented basic replacements for vector and mesh
+    classes. This allows to use the 2D part.
+    The 3D part however needs more algorithmic things in Aims, and Anatomist
+    to render depth maps.
+
+pyclipper:
+    Used to perform polygons clipping, which is now used in zoomed regions. If
+    not installed the program will print a warning message, and clipped
+    polygons will just disappear.
 '''