metafold 0.13.dev4__tar.gz → 0.13.1__tar.gz

{metafold-0.13.dev4 → metafold-0.13.1}/PKG-INFO

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

{metafold-0.13.dev4 → metafold-0.13.1}/metafold/jobs.py

@@ -135,82 +135,6 @@ class JobsEndpoint:
         r: Response = self._client.get(url)
         return Job(**r.json())
 
-    def run(
-        self, type: str, params: dict[str, Any],
-        name: str | None = None,
-        timeout: int | float = 120,
-        project_id: str | None = None,
-    ) -> Job:
-        """Dispatch a new job and wait for a result.
-
-        See Metafold API docs for the full list of jobs.
-
-        Args:
-            type: Job type.
-            params: Job parameters.
-            name: Optional job name.
-            timeout: Time in seconds to wait for a result.
-            project_id: Job project ID.
-
-        Returns:
-            Completed job resource.
-        """
-        url = self.run_status(type, params, name=name, project_id=project_id)
-        try:
-            r: Response = self.poll(url, timeout)
-        except PollTimeout as e:
-            raise RuntimeError(
-                f"Job '{name or type}' failed to complete within {timeout} seconds"
-            ) from e
-        return Job(**r.json())
-
-    def run_status(
-        self, type: str, params: dict[str, Any],
-        name: str | None = None,
-        project_id: str | None = None,
-    ) -> str:
-        """Dispatch a new job and return immediately without waiting for result.
-
-        See Metafold API docs for the full list of jobs.
-
-        Args:
-            type: Job type.
-            params: Job parameters.
-            name: Optional job name.
-            project_id: Job project ID.
-
-        Returns:
-            Job status url.
-        """
-        project_id = self._client.project_id(project_id)
-        payload = asdict(type=type, parameters=params, name=name)
-        r: Response = self._client.post(f"/projects/{project_id}/jobs", json=payload)
-        return r.json()["link"]
-
-    def poll(self, *args, **kwargs):
-        return self._client.poll(*args, **kwargs)
-
-    def update(
-        self, job_id: str,
-        name: str | None = None,
-        project_id: str | None = None,
-    ) -> Job:
-        """Update a job.
-
-        Args:
-            job_id: ID of job to update.
-            name: New job name. The existing name remains unchanged if None.
-            project_id: Job project ID.
-
-        Returns:
-            Updated job resource.
-        """
-        project_id = self._client.project_id(project_id)
-        url = f"/projects/{project_id}/jobs/{job_id}"
-        payload = asdict(name=name)
-        r: Response = self._client.patch(url, data=payload)
-        return Job(**r.json())
-
     def delete(self, job_id: str, project_id: str | None = None):
         """Delete a job.
 

{metafold-0.13.dev4 → metafold-0.13.1}/metafold/simulation/compression_simulation.py

@@ -72,6 +72,14 @@ ZERO_VELOCITY = [
 ]
 
 
+def _has_motion(velocity: Optional[list]) -> bool:
+    """True if a velocity profile has any non-zero component.
+    [time, vx, vy, vz]."""
+    if not velocity:
+        return False
+    return any(any(c for c in row[1:4]) for row in velocity)
+
+
 class BoundaryCondition(Enum):
     SYMMETRIC          = "symmetric"           # symmetry plane (acts as frictionless wall)
     VELOCITY_DIRICHLET = "velocity_dirichlet"  # velocity fixed to zero at the face
@@ -291,6 +299,39 @@ class ExperimentSupportParallelepiped(ExperimentParallelepiped, ExperimentSuppor
     material: Material = field(default_factory=lambda: DEFAULT_SUPPORT_MATERIAL)
 
 
+def validate_simulation_parts(parts: list) -> None:
+    """Raise ValueError if the parts can't produce a compression simulation.
+
+    Callers that dispatch work asynchronously should call this up front so
+    invalid input fails before any project or job is created.
+    """
+    if not parts:
+        return
+
+    has_piston = False
+    has_support = False
+    piston_moves = False
+    for p in parts:
+        if isinstance(p, ExperimentPistonBase):
+            has_piston = True
+            piston_moves = piston_moves or _has_motion(p.velocity)
+        elif isinstance(p, ExperimentSupportBase):
+            has_support = True
+
+    if not has_piston and not has_support:
+        raise ValueError(
+            "No piston part: a compression simulation needs "
+            "a rigid part to apply load. Add a part of type piston_mesh, "
+            "piston_cylinder, or piston_box."
+        )
+    # Supports are stationary by design, so only pistons must move.
+    if has_piston and not piston_moves:
+        raise ValueError(
+            "Piston velocity is zero. Set a velocity "
+            "profile of [time, vx, vy, vz] rows with a non-zero component."
+        )
+
+
 @dataclass
 class ReferenceData:
     csv_path: Path = Path("")
@@ -482,6 +523,9 @@ class CompressionSimulation:
             else:
                 self.part_infos.append(inner_part)
 
+        # A rigid part drives the compression.
+        validate_simulation_parts(parts)
+
         self.setup_ply_files(stl_folder_path)
         self.setup_results(output_path)
         if client is None:

{metafold-0.13.dev4 → metafold-0.13.1}/metafold/simulation/run_experiment.py

@@ -160,6 +160,7 @@ from metafold.simulation.compression_simulation import (
     ExperimentPistonMesh,
     SimulationParameters,
     WorkflowStep,
+    validate_simulation_parts,
 )
 
 # Build preset lookup from all Material constants in the materials module.
@@ -243,6 +244,16 @@ def _build_parts(parts_config: list[dict]) -> list[ExperimentPart]:
     return parts
 
 
+def validate_experiment_config(config: dict) -> None:
+    """Raise ValueError if a manifest can't produce a runnable experiment.
+    Mirrors the checks run_experiment performs so an API can reject bad
+    input before creating a project.
+    """
+    if not config.get("project_name", ""):
+        raise ValueError("project_name is required")
+    validate_simulation_parts(_build_parts(config.get("parts", [])))
+
+
 def _build_varying(varying_config: list[dict]) -> list[ExperimentVarying]:
     varying: list[ExperimentVarying] = []
     for entry in varying_config:

{metafold-0.13.dev4 → metafold-0.13.1}/metafold.egg-info/PKG-INFO

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

{metafold-0.13.dev4 → metafold-0.13.1}/pyproject.toml

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

{metafold-0.13.dev4 → metafold-0.13.1}/tests/test_compression_simulation.py

@@ -15,6 +15,7 @@ from metafold.simulation.compression_simulation import (
     ExperimentPistonBase,
     ExperimentPistonCylinder,
     ExperimentPistonMesh,
+    ExperimentSupportMesh,
     SimulationParameters,
     WorkflowStep,
     WorkflowStepType,
@@ -84,6 +85,7 @@ class TestConstruction:
 
     def test_missing_ply_raises(self, ply_folder, tmp_path):
         parts = [
+            ExperimentPistonCylinder(),
             ExperimentMesh("midsole", DEFAULT_MIDSOLE_NOMINAL, "nonexistent.ply"),
         ]
         with pytest.raises(ValueError, match="not found"):
@@ -95,6 +97,82 @@ class TestConstruction:
                 client=MagicMock(),
             )
 
+    def test_no_piston_raises(self, ply_folder, tmp_path):
+        # Without a rigid part nothing drives the compression
+        parts = [
+            ExperimentMesh("midsole", DEFAULT_MIDSOLE_NOMINAL, "mid.ply"),
+            ExperimentMesh("outsole", DEFAULT_OUTSOLE, "out.ply"),
+        ]
+        with pytest.raises(ValueError, match="piston"):
+            CompressionSimulation(
+                parts=parts,
+                simulation_name="t",
+                stl_folder_path=str(ply_folder),
+                output_path=str(tmp_path / "out"),
+                client=MagicMock(),
+            )
+
+    def test_zero_piston_velocity_raises(self, ply_folder, tmp_path):
+        # A piston that never moves applies no load
+        parts = [
+            ExperimentPistonCylinder(velocity=[[0.0, 0, 0, 0.0], [0.04, 0, 0, 0.0]]),
+            ExperimentMesh("midsole", DEFAULT_MIDSOLE_NOMINAL, "mid.ply"),
+        ]
+        with pytest.raises(ValueError, match="velocity is zero"):
+            CompressionSimulation(
+                parts=parts,
+                simulation_name="t",
+                stl_folder_path=str(ply_folder),
+                output_path=str(tmp_path / "out"),
+                client=MagicMock(),
+            )
+
+    def test_empty_piston_velocity_raises(self, ply_folder, tmp_path):
+        parts = [
+            ExperimentPistonCylinder(velocity=[]),
+            ExperimentMesh("midsole", DEFAULT_MIDSOLE_NOMINAL, "mid.ply"),
+        ]
+        with pytest.raises(ValueError, match="velocity is zero"):
+            CompressionSimulation(
+                parts=parts,
+                simulation_name="t",
+                stl_folder_path=str(ply_folder),
+                output_path=str(tmp_path / "out"),
+                client=MagicMock(),
+            )
+
+    def test_stationary_support_with_moving_piston_ok(self, ply_folder, tmp_path):
+        # Supports are stationary by design; only the piston must move.
+        parts = [
+            ExperimentPistonCylinder(),  # default velocity moves
+            ExperimentSupportMesh(name="base", filename="top.ply"),
+            ExperimentMesh("midsole", DEFAULT_MIDSOLE_NOMINAL, "mid.ply"),
+        ]
+        sim = CompressionSimulation(
+            parts=parts,
+            simulation_name="t",
+            stl_folder_path=str(ply_folder),
+            output_path=str(tmp_path / "out"),
+            client=MagicMock(),
+        )
+        assert len(sim.part_infos) == 3
+
+    def test_support_part_satisfies_rigid_requirement(self, ply_folder, tmp_path):
+        # A support is also a rigid driver, so it's a valid alternative to a piston.
+        parts = [
+            ExperimentSupportMesh(name="base", filename="top.ply"),
+            ExperimentMesh("midsole", DEFAULT_MIDSOLE_NOMINAL, "mid.ply"),
+        ]
+        sim = CompressionSimulation(
+            parts=parts,
+            simulation_name="t",
+            stl_folder_path=str(ply_folder),
+            output_path=str(tmp_path / "out"),
+            client=MagicMock(),
+        )
+        assert len(sim.part_infos) == 2
+
+
 class TestWorkflowStepsInput:
     def test_accepts_workflow_step_instance(self):
         steps = CompressionSimulation._clean_workflow_steps_input([

{metafold-0.13.dev4 → metafold-0.13.1}/tests/test_jobs.py

@@ -102,38 +102,6 @@ job_list = [
     },
 ]
 
-new_job = {
-    "id": "1",
-    "name": "My Job",
-    "type": "test_job",
-    "created": "Mon, 01 Jan 2024 00:00:00 GMT",
-    "started": "Mon, 01 Jan 2024 00:00:00 GMT",
-    "finished": "Mon, 01 Jan 2024 00:00:00 GMT",
-    "error": None,
-    "inputs": {
-        "params": {
-            "foo": "1",
-            "bar": "a",
-            "baz": "[2, \"b\"]",
-        },
-    },
-    "outputs": {
-        "params": None,
-    },
-    "needs": [],
-    "project_id": "1",
-    "workflow_id": None,
-    "assets": [],
-    "parameters": {
-        "foo": "1",
-        "bar": "a",
-        "baz": "[2, \"b\"]",
-    },
-    "meta": None,
-}
-
-poll_count: int = 0
-
 
 class MockRequestHandler(BaseHTTPRequestHandler):
     def do_GET(self):
@@ -156,51 +124,6 @@ class MockRequestHandler(BaseHTTPRequestHandler):
             payload = deepcopy(job_list[-1])
             payload["assets"] = [asset_json]
             self.wfile.write(json.dumps(payload).encode())
-        elif u.path == "/projects/1/jobs/1/status":
-            global poll_count
-            poll_count += 1
-            if poll_count < 3:
-                self.send_response(HTTPStatus.ACCEPTED)
-                payload = deepcopy(new_job)
-                payload["state"] = "started"
-            else:
-                self.send_response(HTTPStatus.CREATED)
-                payload = deepcopy(new_job)
-                payload.update({
-                    "state": "success",
-                    "assets": [asset_json],
-                })
-            self.send_header("Content-Type", "application/json")
-            self.end_headers()
-            self.wfile.write(json.dumps(payload).encode())
-        else:
-            self.send_error(HTTPStatus.NOT_FOUND)
-
-    def do_POST(self):
-        if self.path == "/projects/1/jobs":
-            self.send_response(HTTPStatus.ACCEPTED)
-            self.send_header("Content-Type", "application/json")
-            self.end_headers()
-            payload = deepcopy(new_job)
-            payload.update({
-                "state": "pending",
-                "link": "http://localhost:8000/projects/1/jobs/1/status",
-            })
-            self.wfile.write(json.dumps(payload).encode())
-        else:
-            self.send_error(HTTPStatus.NOT_FOUND)
-
-    def do_PATCH(self):
-        if self.path == "/projects/1/jobs/1":
-            self.send_response(HTTPStatus.OK)
-            self.send_header("Content-Type", "application/json")
-            self.end_headers()
-            payload = deepcopy(job_list[-1])
-            payload.update({
-                "name": "baz",
-                "assets": [asset_json],
-            })
-            self.wfile.write(json.dumps(payload).encode())
         else:
             self.send_error(HTTPStatus.NOT_FOUND)
 
@@ -245,63 +168,3 @@ def test_get_job(client):
         parameters=default_params,
         meta=None,
     )
-
-
-def test_run_job(client):
-    params = {
-        "foo": "1",
-        "bar": "a",
-        "baz": "[2, \"b\"]",
-    }
-    j = client.jobs.run("test_job", params, name="My Job")
-    assert j == Job(
-        id="1",
-        name="My Job",
-        type="test_job",
-        state="success",
-        created=default_dt,
-        started=default_dt,
-        finished=default_dt,
-        inputs=IO(params=params),
-        outputs=IO(),
-        needs=[],
-        project_id="1",
-        workflow_id=None,
-        assets=[asset_obj],
-        parameters=params,
-        meta=None,
-    )
-
-
-def test_poll_job(client):
-    params = {
-        "foo": "1",
-        "bar": "a",
-        "baz": "[2, \"b\"]",
-    }
-    url = client.jobs.run_status("test_job", params, name="My Job")
-    assert url == "http://localhost:8000/projects/1/jobs/1/status"
-
-    r = client.jobs.poll(url)
-    assert Job(**r.json()) == Job(
-        id="1",
-        name="My Job",
-        type="test_job",
-        state="success",
-        created=default_dt,
-        started=default_dt,
-        finished=default_dt,
-        inputs=IO(params=params),
-        outputs=IO(),
-        needs=[],
-        project_id="1",
-        workflow_id=None,
-        assets=[asset_obj],
-        parameters=params,
-        meta=None,
-    )
-
-
-def test_update_job(client):
-    j = client.jobs.update("1", name="baz")
-    assert j.name == "baz"