Merge pull request #171 from tataratat/ft-vedo-only

remove `backend` concept from Options

docs/source/extra_docs.py

@@ -12,10 +12,8 @@
 if __name__ == "__main__":
     here = os.path.dirname(os.path.abspath(__file__))
 
-    # here = pathlib.Path(__file__).parent.resolve()
     # create md dir
     md_path = os.path.abspath(os.path.join(here, "..", "md"))
-    # (here / "../md").resolve().mkdir(parents=True, exist_ok=True)
     os.makedirs(md_path, exist_ok=True)
 
     # 1. Show options.
@@ -25,19 +23,18 @@
         derived = gus.helpers.options.ShowOption.__subclasses__()
         for cls in derived:
             f.write(f"## {cls.__qualname__}\n\n")
-            for backend, options in cls._valid_options.items():
-                f.write(f"### {backend}\n\n")
-                for option in options.values():
-                    t_str = str(option.allowed_types)
-                    t_str = (
-                        t_str.replace("<class", "")
-                        .replace("'", "")
-                        .replace(">", "")
-                    )
-                    f.write(
-                        f"<details><summary><strong>{option.key}"
-                        "</strong></summary><p>\n"
-                    )
-                    f.write(f"\n{option.description}  \n")
-                    f.write(f"- _allowed types_: {t_str}  \n")
-                    f.write("</p></details> \n\n")
+            for option in cls._valid_options.values():
+                t_str = str(option.allowed_types)
+                t_str = (
+                    t_str.replace("<class", "")
+                    .replace("'", "")
+                    .replace(">", "")
+                )
+                f.write(
+                    f"<details><summary><strong>{option.key}"
+                    "</strong></summary><p>\n"
+                )
+                f.write(f"\n{option.description}  \n")
+                f.write(f"- _allowed types_: {t_str}  \n")
+                f.write(f"- _default_: {option.default}  \n")
+                f.write("</p></details> \n\n")

examples/create_boxes.py

@@ -55,7 +55,7 @@ def main():
         backslash=True,
     )
 
-    gus.show.show_vedo(
+    gus.show(
         ["faces-box", mesh_faces_box],
         ["volumes-box", mesh_volumes_box],
         ["faces-triangle", mesh_faces_triangle],

examples/mixd_to_nutils.py

@@ -20,7 +20,7 @@ def main():
     )
     mesh_npz = gus.io.nutils.load("export/export_npz.npz")
 
-    gus.show.show_vedo(
+    gus.show(
         ["gustaf-mesh", mesh],
         ["mixd-mesh", mesh_mixd],
         ["npz-mesh", mesh_npz],

examples/shrink_elements.py

@@ -17,7 +17,7 @@
     direct_toedges.show_options["as_arrows"] = True
 
     # not the most efficient way, but it is possible.
-    gus.show.show_vedo(
+    gus.show(
         ["v, Volumes", v],
         ["v.shrink()", v.shrink()],
         [

gustaf/edges.py

@@ -42,7 +42,7 @@ class EdgesShowOption(helpers.options.ShowOption):
 
     _helps = "Edges"
 
-    def _initialize_vedo_showable(self):
+    def _initialize_showable(self):
         """
         Initializes edges as either vedo.Lines or vedo.Arrows
 

gustaf/faces.py

@@ -39,7 +39,7 @@ class FacesShowOption(helpers.options.ShowOption):
 
     _helps = "Faces"
 
-    def _initialize_vedo_showable(self):
+    def _initialize_showable(self):
         """
         Initializes Faces as vedo.Mesh
 

gustaf/helpers/__init__.py

@@ -1,6 +1,7 @@
-from gustaf.helpers import data, raise_if
+from gustaf.helpers import data, options, raise_if
 
 __all__ = [
     "data",
+    "options",
     "raise_if",
 ]