metafold 0.12.dev0__tar.gz → 0.12.dev1__tar.gz

{metafold-0.12.dev0 → metafold-0.12.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: metafold
-Version: 0.12.dev0
+Version: 0.12.dev1
 Summary: Metafold SDK for Python
 Author-email: Metafold 3D <info@metafold3d.com>
 License: Copyright 2024 Metafold 3D

{metafold-0.12.dev0 → metafold-0.12.dev1}/metafold/simulation/run_experiment.py

@@ -244,6 +244,7 @@ def run_experiment(
     access_token: Optional[str] = None,
     base_url: str = "https://api.metafold3d.com/",
     credentials: Optional[dict] = None,
+    wait_for_results: bool = False,
 ) -> str:
     """Create and run a compression experiment from a config dict.
 
@@ -259,7 +260,12 @@ def run_experiment(
     - neither: CompressionSimulation reads credentials from the environment via
       dotenv (local / programmable use).
 
-    Returns the Metafold project_id for the completed experiment.
+    By default this returns as soon as the simulation workflows have been
+    dispatched (after assets are uploaded and prep workflows finish); results
+    stay server-side. Pass wait_for_results=True to block until every
+    simulation finishes and download the results into output_path.
+
+    Returns the Metafold project_id for the experiment.
     """
     project_name = config.get("project_name", "")
     if not project_name:
@@ -309,6 +315,7 @@ def run_experiment(
     CompressionExperiment(
         simulation=sim,
         varying=varying,
+        auto_download_results=wait_for_results,
     )
 
     return sim.project_id
@@ -321,6 +328,7 @@ def run_experiment_from_zip(
     access_token: Optional[str] = None,
     base_url: str = "https://api.metafold3d.com/",
     credentials: Optional[dict] = None,
+    wait_for_results: bool = False,
 ) -> str:
     """Extract a zip containing experiment.json + mesh files and run the experiment.
 
@@ -334,7 +342,11 @@ def run_experiment_from_zip(
     access_token, when provided, is forwarded to run_experiment — see its
     docstring. When omitted, credentials are loaded from the environment.
 
-    Returns the Metafold project_id for the completed experiment.
+    By default this returns once the simulation workflows are dispatched;
+    pass wait_for_results=True to block until they finish and download the
+    results into output_path (see run_experiment).
+
+    Returns the Metafold project_id for the experiment.
     """
     with tempfile.TemporaryDirectory() as tmp_dir:
         with ZipFile(zip_path) as zf:
@@ -352,4 +364,11 @@ def run_experiment_from_zip(
         if project_id:
             config["project_id"] = project_id
 
-        return run_experiment(config, output_path=output_path, access_token=access_token, base_url=base_url, credentials=credentials)
+        return run_experiment(
+            config,
+            output_path=output_path,
+            access_token=access_token,
+            base_url=base_url,
+            credentials=credentials,
+            wait_for_results=wait_for_results,
+        )

{metafold-0.12.dev0 → metafold-0.12.dev1}/metafold.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: metafold
-Version: 0.12.dev0
+Version: 0.12.dev1
 Summary: Metafold SDK for Python
 Author-email: Metafold 3D <info@metafold3d.com>
 License: Copyright 2024 Metafold 3D

{metafold-0.12.dev0 → metafold-0.12.dev1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "metafold"
-version = "0.12.dev0"
+version = "0.12.dev1"
 authors = [
     {name = "Metafold 3D", email = "info@metafold3d.com"},
 ]

{metafold-0.12.dev0 → metafold-0.12.dev1}/tests/test_run_experiment.py

@@ -414,6 +414,37 @@ class TestRunExperiment:
 
         assert captured["output_path"] == str(tmp_path / "actual")
 
+    def test_does_not_wait_for_results_by_default(self, ply_folder, tmp_path):
+        fake_sim = self._fake_sim(ply_folder)
+        with (
+            patch("metafold.simulation.run_experiment.CompressionSimulation", return_value=fake_sim),
+            patch("metafold.simulation.run_experiment.CompressionExperiment") as mock_exp_cls,
+        ):
+            run_experiment({
+                "project_name": "t",
+                "output_path": str(tmp_path / "out"),
+                "parts": [],
+            })
+
+        assert mock_exp_cls.call_args.kwargs["auto_download_results"] is False
+
+    def test_wait_for_results_downloads(self, ply_folder, tmp_path):
+        fake_sim = self._fake_sim(ply_folder)
+        with (
+            patch("metafold.simulation.run_experiment.CompressionSimulation", return_value=fake_sim),
+            patch("metafold.simulation.run_experiment.CompressionExperiment") as mock_exp_cls,
+        ):
+            run_experiment(
+                {
+                    "project_name": "t",
+                    "output_path": str(tmp_path / "out"),
+                    "parts": [],
+                },
+                wait_for_results=True,
+            )
+
+        assert mock_exp_cls.call_args.kwargs["auto_download_results"] is True
+
 
 class TestRunExperimentFromZip:
     def _make_zip(self, tmp_path, manifest: dict, mesh_files: list[str] = None) -> Path: