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

metafold/simulation/compression_experiment.py

@@ -1,6 +1,6 @@
 import copy
 import json
-from typing import Any, List, Union, cast
+from typing import Any, List, Optional, Union, cast
 import glob
 from pathlib import Path
 from metafold.simulation.compression_simulation import (
@@ -106,6 +106,41 @@ class VarySimulationParameter(ExperimentVarying):
         setattr(obj, parts[-1], self.values[sim_index])
 
 
+class VaryVelocity(ExperimentVarying):
+    """Vary a rigid part's velocity keyframes (e.g. a piston's motion profile).
+    Each value is a full velocity profile: a list of [t, vx, vy, vz] rows."""
+
+    part_name: str
+    velocities: List[list]
+
+    def __init__(self, part_name: str, velocities: List[list]):
+        # Each element is one profile: a list of [t,vx,vy,vz] rows.
+        for i, profile in enumerate(velocities):
+            if (
+                not isinstance(profile, list)
+                or not profile
+                or not all(isinstance(row, list) and len(row) == 4 for row in profile)
+            ):
+                raise ValueError(
+                    f"velocity profile {i} for part {part_name!r} must be a list "
+                    f"of [t, vx, vy, vz] rows, got: {profile!r}"
+                )
+        self.part_name = part_name
+        self.velocities = velocities
+
+    def resolve(self, _base_dir: Path) -> None:
+        self.sim_count = len(self.velocities)
+
+    def apply_to(self, sim_index: int, sim: CompressionSimulation):
+        part_info: CompressionSimulation.PartInfo = sim.get_part_info(self.part_name)
+        if not hasattr(part_info.part, "velocity"):
+            # Only rigid (piston/support) parts consume a velocity profile.
+            raise ValueError(
+                f"Part {self.part_name!r} is not a rigid (piston/support) part "
+            )
+        part_info.part.velocity = self.velocities[sim_index]
+
+
 class CompressionExperiment:
     base_simulation: CompressionSimulation
     varying: List[ExperimentVarying] = []
@@ -124,12 +159,16 @@ class CompressionExperiment:
         auto_upload_server_manifest: bool = True,
         use_legacy_results_format: bool = False,
         write_ups: bool = True,
+        simulation_names: Optional[List[str]] = None,
     ):
         simulation.use_legacy_results_format = use_legacy_results_format
         simulation.write_ups = write_ups
         self.use_legacy_results_format = use_legacy_results_format
         self.base_simulation = simulation
         self.varying = varying
+        # Optional per-simulation display names (index-aligned). A blank/missing
+        # entry falls back to the auto "<base>_sim<index>" name.
+        self.simulation_names = simulation_names or []
         self.verbose = verbose
         self.force_rerun = force_rerun
         self.varying_part_names = []
@@ -139,12 +178,59 @@ class CompressionExperiment:
             if hasattr(v, "part_name"):
                 self.varying_part_names.append(v.part_name)
 
+        # Every varying must produce the same number of variants — prepare()
+        # sizes the sim loop from one of them and indexes into all of them.
+        counts = {v.sim_count for v in self.varying}
+        if len(counts) > 1:
+            raise ValueError(
+                "All varying entries must have the same number of values, got "
+                f"counts: {sorted(counts)}"
+            )
+
+        self._validate_simulation_names()
+
         if auto_run:
             self.prepare()
             self.run(auto_upload_server_manifest)
             if auto_download_results:
                 self.download_results()
 
+    def _sim_name(self, sim_index: int) -> str:
+        """Name for the sim at sim_index: the caller-supplied name when present,
+        otherwise the auto "<base>_sim<index>" name."""
+        custom = (
+            self.simulation_names[sim_index]
+            if sim_index < len(self.simulation_names)
+            else None
+        )
+        return custom or f"{self.base_simulation.simulation_name}_sim{sim_index}"
+
+    def _validate_simulation_names(self):
+        """Names must be a list of path-safe strings (None or "" = use the
+        auto name) and resolve to a unique name per sim (they become filenames
+        and zip member paths)."""
+        if not isinstance(self.simulation_names, list) or not all(
+            n is None or isinstance(n, str) for n in self.simulation_names
+        ):
+            raise ValueError(
+                f"simulation_names must be a list of strings, got: "
+                f"{self.simulation_names!r}"
+            )
+        self.simulation_names = [n or "" for n in self.simulation_names]
+        for name in self.simulation_names:
+            if any(c in name for c in "/\\:"):
+                raise ValueError(
+                    f"simulation name {name!r} contains a path separator"
+                )
+
+        sim_count = self.varying[0].sim_count if self.varying else 1
+        resolved = [self._sim_name(i) for i in range(sim_count)]
+        duplicates = {n for n in resolved if resolved.count(n) > 1}
+        if duplicates:
+            raise ValueError(
+                f"simulation names must be unique, duplicated: {sorted(duplicates)}"
+            )
+
     @property
     def _experiment_state_filename(self) -> Path:
         assert self.base_simulation.out_dir is not None
@@ -157,12 +243,18 @@ class CompressionExperiment:
         """Delete the experiment state file and all per-sim results files."""
         if self._experiment_state_filename.is_file():
             self._experiment_state_filename.unlink()
-        # delete per-sim results — we don't know sim names without state,
-        # so just glob for anything matching the pattern
+        # delete per-sim results: auto-named sims match the glob pattern,
+        # custom-named sims are deleted by name
         for f in self.base_simulation.out_dir.glob(
             f"{self.base_simulation.simulation_name}_sim*_results.json"
         ):
             f.unlink()
+        for name in self.simulation_names:
+            if not name:
+                continue
+            f = self.base_simulation.out_dir / f"{name}_results.json"
+            if f.is_file():
+                f.unlink()
         # delete out.zip if it exists
         out_zip = self.base_simulation.out_dir / "out.zip"
         if out_zip.is_file():
@@ -193,7 +285,7 @@ class CompressionExperiment:
         self.base_simulation.part_infos = base_part_infos
 
         # give each sim a unique name so zip paths don't collide
-        clone.simulation_name = f"{self.base_simulation.simulation_name}_sim{sim_index}"
+        clone.simulation_name = self._sim_name(sim_index)
 
         # ok now for the part infos we want to do something different, we want to keep shared elements the same but fork
         # the part infos which we are varying, that way we dont mess up other copies when experiments vary things

metafold/simulation/run_experiment.py

@@ -55,7 +55,14 @@ JSON manifest format
                 }
             }
         ]},
-        {"field": "max_time", "values": [0.02, 0.04]}
+        # A rigid part's velocity keyframes; each value is a full [t,vx,vy,vz] profile:
+        {"part": "piston", "velocity": [
+            [[0.0, 0, 0, 0.0], [0.04, 0, 0, -1.25]],
+            [[0.0, 0, 0, 0.0], [0.04, 0, 0, -2.50]],
+            [[0.0, 0, 0, 0.0], [0.04, 0, 0, -5.00]]
+        ]},
+        # Every varying entry must have the same number of values (one per variant).
+        {"field": "max_time", "values": [0.02, 0.04, 0.06]}
     ],
 
     "simulation": {
@@ -82,7 +89,12 @@ JSON manifest format
         "compress",
         "force_displacement",
         {"step": "metrics", "parts": ["midsole", "outsole"]}
-    ]
+    ],
+
+    # Optional display name per simulation variant, index-aligned with the variants
+    # the varying entries produce. A null/blank/missing entry falls back to
+    # "<name>_sim<i>". Names must be unique and must not contain path separators.
+    "simulation_names": ["slow piston", null, "fastest piston"]
 }
 
 Available material presets
@@ -137,6 +149,7 @@ from metafold.simulation.compression_experiment import (
     VaryMaterial,
     VaryMesh,
     VarySimulationParameter,
+    VaryVelocity,
 )
 from metafold.simulation.compression_simulation import (
     CompressionSimulation,
@@ -180,6 +193,8 @@ def _build_parts(parts_config: list[dict]) -> list[ExperimentPart]:
 
         if part_type == "piston_cylinder":
             kwargs = {}
+            if "name" in entry:
+                kwargs["name"] = entry["name"]
             if "velocity" in entry:
                 kwargs["velocity"] = entry["velocity"]
             if "shape_parameters" in entry:
@@ -190,6 +205,8 @@ def _build_parts(parts_config: list[dict]) -> list[ExperimentPart]:
 
         elif part_type == "piston_box":
             kwargs = {}
+            if "name" in entry:
+                kwargs["name"] = entry["name"]
             if "velocity" in entry:
                 kwargs["velocity"] = entry["velocity"]
             if "shape_parameters" in entry:
@@ -200,6 +217,8 @@ def _build_parts(parts_config: list[dict]) -> list[ExperimentPart]:
 
         elif part_type == "piston_mesh":
             kwargs = {"filename": entry["file"]}
+            if "name" in entry:
+                kwargs["name"] = entry["name"]
             if "velocity" in entry:
                 kwargs["velocity"] = entry["velocity"]
             if "material" in entry:
@@ -243,6 +262,14 @@ def _build_varying(varying_config: list[dict]) -> list[ExperimentVarying]:
                 VaryMaterial(entry["part"], [_resolve_material(m) for m in materials])
             )
 
+        elif "part" in entry and "velocity" in entry:
+            velocities = entry["velocity"]
+            if not isinstance(velocities, list):
+                raise ValueError(
+                    f"varying 'velocity' must be a list of velocity profiles, got: {velocities!r}"
+                )
+            varying.append(VaryVelocity(entry["part"], velocities))
+
         elif "field" in entry and "values" in entry:
             varying.append(VarySimulationParameter(entry["field"], entry["values"]))
 
@@ -366,6 +393,7 @@ def run_experiment(
     CompressionExperiment(
         simulation=sim,
         varying=varying,
+        simulation_names=config.get("simulation_names"),
         auto_download_results=wait_for_results,
     )
 

{metafold-0.13.dev0.dist-info → metafold-0.13.dev2.dist-info}/METADATA

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

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

@@ -10,11 +10,11 @@ metafold/projects.py,sha256=4APFtJQjycFhlIHCWTrOAuU3CLX8drSlgPz8lhVXhzI,6295
 metafold/utils.py,sha256=DnsW1Xr9mLpVHBNdPrdxNLLcjxSNMkWVvr7cH7UTAxY,1174
 metafold/workflows.py,sha256=Mhv3n3ChUHw1Vaj3q8HNDbOgljn03AF6WslZfXzexsI,7802
 metafold/simulation/__init__.py,sha256=tUW4PfyWnI6UFvIR__JKUD2FjNTM74fSeKuee7Ewjfo,816
-metafold/simulation/compression_experiment.py,sha256=9GL67vCpIJziI9D9BpFtiYfDm4EZWpdh867TuF6GppM,14489
+metafold/simulation/compression_experiment.py,sha256=kLtX6V4vc_v2l-mJqpkE29TWE-fb6fCudOqhxv1Bz9U,18442
 metafold/simulation/compression_simulation.py,sha256=pnAgadKWMj4Yexitz3wQRJsGbtV8iGxjdfXRe_rqJiM,118024
-metafold/simulation/run_experiment.py,sha256=AXQSuXXglQtuPFfIt5KBtKzFc7oMm7shq3FdJcwM7OI,16157
-metafold-0.13.dev0.dist-info/licenses/LICENSE,sha256=LejZXzGwe9t0Ezk6g0bRmWUuFSI9vQSk1wJAc1NrrhE,1059
-metafold-0.13.dev0.dist-info/METADATA,sha256=pLhUoy9hHFp8znIT-_qNt5KuTBIJuZOWOCKEnuf6g7I,3495
-metafold-0.13.dev0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
-metafold-0.13.dev0.dist-info/top_level.txt,sha256=0dvwa2N6gvl2x4T9c62V4MbYD2soFedI6hm3-lWgyew,9
-metafold-0.13.dev0.dist-info/RECORD,,
+metafold/simulation/run_experiment.py,sha256=_TRsm6pHtHCLBlw8wqiN9WcvoAwmI0APPru-0Nj2QJw,17533
+metafold-0.13.dev2.dist-info/licenses/LICENSE,sha256=LejZXzGwe9t0Ezk6g0bRmWUuFSI9vQSk1wJAc1NrrhE,1059
+metafold-0.13.dev2.dist-info/METADATA,sha256=RaoMGGgcxBiSOf9AOWTI9cvA0_BbT6N5t9nN8Xm0LDk,3495
+metafold-0.13.dev2.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+metafold-0.13.dev2.dist-info/top_level.txt,sha256=0dvwa2N6gvl2x4T9c62V4MbYD2soFedI6hm3-lWgyew,9
+metafold-0.13.dev2.dist-info/RECORD,,