Add example for iterating over beam lattices

Author: rycwo

docs/index.rst

@@ -110,7 +110,7 @@ Most jobs produce at least one asset. You may access them from the returned
 
 For more complete examples, please refer to the `examples`_ in the source code repo.
 
-.. _API documentation: https://metafold3d.notion.site/Metafold-REST-API-059f01a419a74811a9d2dcafe75c871b#65833c70939d4d6490f2a4defe825d46
+.. _API documentation: https://docs.metafold3d.com/lightcycle-api#65833c70939d4d6490f2a4defe825d46
 .. _examples: https://github.com/Metafold3d/metafold-python/tree/master/examples
 
 .. toctree::

examples/beam_lattice_metrics.py

@@ -0,0 +1,110 @@
+"""Example script demonstrating running multiple jobs (beam lattices).
+
+Usage:
+    python examples/beam_lattice_metrics.py -t <token> -p <project>
+
+For more details on the available job types please refer to the Metafold REST API
+documentation.
+"""
+from argparse import ArgumentParser
+from metafold import MetafoldClient
+from pprint import pprint
+from typing import TypedDict
+import os
+import requests
+
+
+class Lattice(TypedDict):
+    # There are other fields but we don't care to capture them here
+    name: str
+    display_name: str
+    other_names: str
+    positions: list[float]
+    node_ids: list[int]
+
+
+lattice_url = "https://lightcycle-static.us-southeast-1.linodeobjects.com/lib/beam_lattice.json"
+
+
+def main() -> None:
+    parser = ArgumentParser(description="Compute metrics for beam lattices")
+    parser.add_argument("-t", "--token", type=str, help="access token")
+    parser.add_argument("-p", "--project", type=str, help="project id", required=True)
+
+    args = parser.parse_args()
+
+    token = args.token or os.environ.get("METAFOLD_ACCESS_TOKEN")
+    if not token:
+        parser.error("access token is required")
+
+    metafold = MetafoldClient(token, args.project)
+
+    library = get_lattice_library()
+
+    for lattice_type in library:
+        lattice = library[lattice_type]
+        lattice_name = lattice["display_name"]
+
+        # Build arrays-of-arrays by iterating through flattened data in strides
+        nodes = [
+            lattice["positions"][i:i + 3]
+            for i in range(0, len(lattice["positions"]), 3)
+        ]
+        edges = [
+            lattice["node_ids"][i:i + 2]
+            for i in range(0, len(lattice["node_ids"]), 2)
+        ]
+
+        print(f"Running evaluate_metrics ({lattice_name}) job...")
+        job = metafold.jobs.run("evaluate_metrics", {
+            "graph": {
+                "operators": [
+                    {
+                        "type": "GenerateSamplePoints",
+                        "parameters": {
+                            "size": [1.0, 1.0, 1.0],
+                            "resolution": [64, 64, 64],
+                        },
+                    },
+                    {
+                        "type": "SampleLattice",
+                        "parameters": {
+                            "lattice_data": {
+                                "nodes": nodes,
+                                "edges": edges,
+                            },
+                            "scale": [1.0, 1.0, 1.0],
+                        },
+                    },
+                    {
+                        "type": "Redistance",
+                        "parameters": {
+                            "size": [1.0, 1.0, 1.0],
+                        },
+                    },
+                    {
+                        "type": "Threshold",
+                        "parameters": {
+                            "width": 0.04,
+                        },
+                    },
+                ],
+                "edges": [
+                    {"source": 0, "target": [1, "Points"]},
+                    {"source": 1, "target": [2, "Samples"]},
+                    {"source": 2, "target": [3, "Samples"]},
+                ],
+            },
+            "point_source": 0,
+        })
+        print(f"{lattice_type}:")
+        pprint(job.meta)
+
+
+def get_lattice_library() -> dict[str, Lattice]:
+    r = requests.get(lattice_url)
+    return r.json()
+
+
+if __name__ == "__main__":
+    main()

examples/lattice_infill.py

@@ -15,6 +15,7 @@
 
 Vec3: TypeAlias = [float, float, float]
 
+
 class Patch(TypedDict):
     offset: Vec3
     size: Vec3
@@ -95,11 +96,7 @@ def create_graph(volume_filename: str, patch: Patch) -> dict[str, Any]:
         "operators": [
             {
                 "type": "GenerateSamplePoints",
-                "parameters": {
-                    "offset": patch["offset"],
-                    "size": patch["size"],
-                    "resolution": patch["resolution"],
-                },
+                "parameters": patch,
             },
             {
                 "type": "LoadVolume",

examples/lattice_metrics.py examples/surface_lattice_metrics.pyexamples/lattice_metrics.py renamed to examples/surface_lattice_metrics.py

@@ -1,7 +1,7 @@
 """Example script demonstrating running multiple jobs.
 
 Usage:
-    python examples/lattice_metrics.py -t <token> -p <project>
+    python examples/surface_lattice_metrics.py -t <token> -p <project>
 
 For more details on the available job types please refer to the Metafold REST API
 documentation.

examples/lattice_metrics_parallel.py …ples/surface_lattice_metrics_parallel.pyexamples/lattice_metrics_parallel.py renamed to examples/surface_lattice_metrics_parallel.py examples/lattice_metrics_parallel.py renamed to examples/surface_lattice_metrics_parallel.py

@@ -4,7 +4,7 @@
 parallel will give limited performance improvements.
 
 Usage:
-    python examples/lattice_metrics_parallel.py -t <token> -p <project> -n <procs>
+    python examples/surface_lattice_metrics_parallel.py -t <token> -p <project> -n <procs>
 
 For more details on the available job types please refer to the Metafold REST API
 documentation.

tests/test_assets.py

@@ -87,7 +87,7 @@ def do_GET(self):
     def do_POST(self):
         match self.path:
             case "/projects/1/assets":
-                self.send_response(HTTPStatus.ACCEPTED)
+                self.send_response(HTTPStatus.CREATED)
                 self.send_header("Content-Type", "application/json")
                 self.end_headers()
                 self._assert_file()

tests/test_jobs.py

@@ -114,7 +114,7 @@ def do_GET(self):
                     payload = deepcopy(new_job)
                     payload["state"] = "started"
                 else:
-                    self.send_response(HTTPStatus.OK)
+                    self.send_response(HTTPStatus.CREATED)
                     payload = deepcopy(new_job)
                     payload.update({
                         "state": "success",