metafold 0.12.dev0__py3-none-any.whl → 0.12.dev2__py3-none-any.whl

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:
@@ -283,9 +289,14 @@ def run_experiment(
         output_path=resolved_output_path,
         simulation_parameters=sim_params,
         project_id=project_id,
-        project_name=project_name,
         create_project_if_needed=not bool(project_id),
     )
+    # Only pass project_name when we have to create a project. When a
+    # project_id is supplied the project already exists, and passing the name
+    # would keep the find-or-create-by-name path alive — risking a duplicate
+    # project. simulation_name (set above) drives UPS/result naming regardless.
+    if not project_id:
+        sim_kwargs["project_name"] = project_name
     if "workflow_steps" in config:
         sim_kwargs["workflow_steps"] = _build_workflow_steps(config["workflow_steps"])
 
@@ -309,6 +320,7 @@ def run_experiment(
     CompressionExperiment(
         simulation=sim,
         varying=varying,
+        auto_download_results=wait_for_results,
     )
 
     return sim.project_id
@@ -321,6 +333,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 +347,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 +369,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.dist-info → metafold-0.12.dev2.dist-info}/METADATA

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

{metafold-0.12.dev0.dist-info → metafold-0.12.dev2.dist-info}/RECORD

@@ -12,9 +12,9 @@ metafold/workflows.py,sha256=Mhv3n3ChUHw1Vaj3q8HNDbOgljn03AF6WslZfXzexsI,7802
 metafold/simulation/__init__.py,sha256=siIIJv3hjiHLohSztAZcMi0eePqEkc_K5Q8Azsf90d4,776
 metafold/simulation/compression_experiment.py,sha256=Dc7EKPAmKEZsNcH5vnKuj3dQcFFeh0hsus9CIA0Ycv4,14221
 metafold/simulation/compression_simulation.py,sha256=-amZGNGJthXI4zvFlYm9xdYPjRJue04JJu8Ra2QAfaE,97589
-metafold/simulation/run_experiment.py,sha256=O-HWPmgqCV0gUU0D4ts2wKCUcQ09IesHCKhxHqKlKAo,12593
-metafold-0.12.dev0.dist-info/licenses/LICENSE,sha256=LejZXzGwe9t0Ezk6g0bRmWUuFSI9vQSk1wJAc1NrrhE,1059
-metafold-0.12.dev0.dist-info/METADATA,sha256=kDRW11XZnc2BDJTa8-bm58Kv8rzIpOPJjwPPzUwLztU,3495
-metafold-0.12.dev0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-metafold-0.12.dev0.dist-info/top_level.txt,sha256=0dvwa2N6gvl2x4T9c62V4MbYD2soFedI6hm3-lWgyew,9
-metafold-0.12.dev0.dist-info/RECORD,,
+metafold/simulation/run_experiment.py,sha256=i-ZsYDYTbo-0EFXAjCqBvmA67b8VnRtLimGQNF76z8k,13647
+metafold-0.12.dev2.dist-info/licenses/LICENSE,sha256=LejZXzGwe9t0Ezk6g0bRmWUuFSI9vQSk1wJAc1NrrhE,1059
+metafold-0.12.dev2.dist-info/METADATA,sha256=I4rXO9-j762tHilLAHCvP1yYLYkgdCqfK2CTO4XFHNM,3495
+metafold-0.12.dev2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+metafold-0.12.dev2.dist-info/top_level.txt,sha256=0dvwa2N6gvl2x4T9c62V4MbYD2soFedI6hm3-lWgyew,9
+metafold-0.12.dev2.dist-info/RECORD,,