metafold 0.12.dev11__tar.gz → 0.13.dev0__tar.gz

{metafold-0.12.dev11 → metafold-0.13.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: metafold
-Version: 0.12.dev11
+Version: 0.13.dev0
 Summary: Metafold SDK for Python
 Author-email: Metafold 3D <info@metafold3d.com>
 License: Copyright 2024 Metafold 3D
@@ -25,7 +25,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.12
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: attrs~=23.2
@@ -38,7 +38,7 @@ Requires-Dist: dotenv>=0.9.9; extra == "simulation"
 Requires-Dist: pandas>=2.3.3; extra == "simulation"
 Requires-Dist: plyfile>=1.1.3; extra == "simulation"
 Requires-Dist: pyyaml>=6.0.3; extra == "simulation"
-Requires-Dist: simulation-configurator==0.1.2; extra == "simulation"
+Requires-Dist: simulation-configurator==0.2.*; extra == "simulation"
 Requires-Dist: tables>=3.11.1; extra == "simulation"
 Dynamic: license-file
 

{metafold-0.12.dev11 → metafold-0.13.dev0}/metafold/simulation/compression_simulation.py

@@ -8,7 +8,7 @@ import uuid
 
 from requests import HTTPError
 import yaml
-from dotenv import load_dotenv
+from dotenv import load_dotenv  # type: ignore
 from metafold import MetafoldClient
 from pathlib import Path
 from numpy.typing import DTypeLike
@@ -311,6 +311,7 @@ class WorkflowStepType(Enum):
     STRESS_STRAIN = "stress_strain"
     PARTICLE_DISPLACEMENT = "particle_displacement"
     ENERGY_METRICS = "energy_metrics"
+    REDUCE_RESULTS = "reduce_results"
 
 
 class WorkflowStep:
@@ -353,6 +354,8 @@ class CompressionSimulation:
         bvh_filename: Optional[str] = None
         # Sampling resolution (longest axis) assigned for the pass-2 sample job.
         sample_resolution: Optional[int] = None
+        # From the prep metrics job; None until prep completes.
+        interior_volume: Optional[float] = None
         patch: dict = field(default_factory=dict)
         jobs: dict[str, Any] = field(default_factory=lambda: {})
         part_unique_name = ""
@@ -374,6 +377,7 @@ class CompressionSimulation:
                 "is_piston": isinstance(self.part, ExperimentPistonBase),
                 "part_name": self.part.name,
                 "disabled": self.disabled,
+                "interior_volume": self.interior_volume,
             }
 
         def restore_from_state_dict(self, saved: dict):
@@ -382,6 +386,7 @@ class CompressionSimulation:
             self.material_name = saved["material_name"]
             self.jobs = saved["jobs"]
             self.disabled = saved.get("disabled", False)
+            self.interior_volume = saved.get("interior_volume")
 
     client: MetafoldClient
     project_id: str = ""
@@ -425,7 +430,7 @@ class CompressionSimulation:
         simulation_name: str,
         project_id: str = "",
         stl_folder_path: str = "PLY",
-        env_source: str = ".env.dev",
+        env_source: str | None = ".env.dev",
         output_path: str = "",
         client: Optional[MetafoldClient] = None,
         simulation_parameters: SimulationParameters = SimulationParameters(),
@@ -440,6 +445,7 @@ class CompressionSimulation:
             # stress_strain is opt-in (not default): callers add it via workflow_steps.
             WorkflowStep(WorkflowStepType.PARTICLE_DISPLACEMENT),
             WorkflowStep(WorkflowStepType.ENERGY_METRICS),
+            # reduce-results is auto-added in build_workflow (not a step).
         ],
         force_reupload_files=False,
         prep_workflow_batch_size: int = 10,
@@ -642,7 +648,8 @@ class CompressionSimulation:
         return created.id
 
     def setup_client(self, env_source, project_id) -> MetafoldClient:
-        load_dotenv(env_source)
+        if env_source is not None:
+            load_dotenv(env_source)
 
         if not project_id:
             self.project_id = os.environ.get("METAFOLD_PROJECT_ID", "")
@@ -824,6 +831,24 @@ class CompressionSimulation:
             params[f"{sample_mesh_job}.resolution"] = f"{resolution}"
             part_info.jobs["sample-mesh"] = sample_mesh_job
 
+            # Metrics run in prep (not the main workflow) so interior volume
+            # is known before dispatch, when the server manifest is uploaded.
+            if self._is_analysis_target(part_info.part) and self._get_step(
+                WorkflowStepType.METRICS, part_info.part.name
+            ):
+                metrics_job = f"metrics-{unique_name}"
+                jobs[metrics_job] = {
+                    "type": "implicit/metrics",
+                    "needs": [sample_mesh_job],
+                    "assets": {"volume": sample_mesh_job},
+                    "parameters": {
+                        "volume_size": {"job": sample_mesh_job, "parameter": "patch_size"},
+                        "volume_offset": {"job": sample_mesh_job, "parameter": "patch_offset"},
+                        "volume_resolution": {"job": sample_mesh_job, "parameter": "patch_resolution"},
+                    },
+                }
+                part_info.jobs["metrics"] = metrics_job
+
         workflow_yaml = yaml.dump({"jobs": jobs}, default_flow_style=False)
         return workflow_yaml, params, assets
 
@@ -1025,6 +1050,30 @@ class CompressionSimulation:
             if volume_asset is not None:
                 info.volume_filename = volume_asset.filename
 
+            metrics_job = prep_workflow_jobs.get(info.jobs.get("metrics", ""))
+            if metrics_job is not None:
+                raw = metrics_job.outputs.params.get("interior_volume")
+                if raw is not None:
+                    info.interior_volume = float(raw)
+
+    def _total_interior_volume(self, workflow: Optional[Workflow] = None) -> float:
+        """Sum interior volumes across analysis-target parts. Falls back to
+        the main-workflow metrics readback for experiments dispatched before
+        metrics moved to the prep workflow."""
+        total = 0.0
+        for part_info in self.part_infos:
+            if not self._is_analysis_target(part_info.part) or part_info.disabled:
+                continue
+            if part_info.interior_volume is not None:
+                total += part_info.interior_volume
+                continue
+            metrics_job = part_info.jobs.get("metrics", "")
+            if workflow is not None and metrics_job:
+                raw = workflow.get_parameter(f"{metrics_job}.interior_volume")
+                if raw is not None:
+                    total += float(raw)
+        return total
+
     def get_part_info(self, name):
         for info in self.part_infos:
             if info.part.name == name:
@@ -1218,6 +1267,9 @@ class CompressionSimulation:
         ElementTree.indent(self.ups)
 
     def _add_to_workflow_metrics(self, part_infos: list[PartInfo]):
+        # Duplicates the prep metrics jobs (which feed the server manifest):
+        # removing these changed main-workflow scheduling and left it pending,
+        # so they stay until that's understood.
         for part_info in part_infos:
             part = part_info.part
             if not self._is_analysis_target(part):
@@ -1241,7 +1293,6 @@ class CompressionSimulation:
             self.workflow_params[f"{metrics_job_name}.volume_resolution"] = json.dumps(
                 part_info.patch["resolution"]
             )
-            part_info.jobs["metrics"] = metrics_job_name
 
     def _add_to_workflow_compress(self, part_infos: list[PartInfo]):
         compress_job_name = "compress"
@@ -1426,6 +1477,25 @@ class CompressionSimulation:
             part_infos, "force-displacement", "energy-metrics"
         )
 
+    # One merged reduce-results job consumes the particle-data outputs the
+    # browser renders and produces a compact (trimmed + int16 + decimated) HDF5.
+    # Auto-added whenever compress ran; the manifest points DTB at its output.
+    _REDUCE_SOURCE_JOBS = [
+        "compress", "von-mises-stress", "effective-strain",
+        "particle-displacement",
+    ]
+    _REDUCE_JOB_NAME = "reduce-results"
+
+    def _add_to_workflow_reduce_results(self):
+        sources = [j for j in self._REDUCE_SOURCE_JOBS if j in self.workflow_jobs]
+        if "compress" not in sources:
+            return  # nothing to preview without particle positions
+        self.workflow_jobs[self._REDUCE_JOB_NAME] = {
+            "type": "sim/postprocess/reduce-results",
+            "needs": sources,
+            "assets": {"data": [{"job": s, "asset": "output"} for s in sources]},
+        }
+
     def build_workflow(self, name_suffix=""):
         self.workflow_yaml = ""
         self.workflow_params = {}
@@ -1462,6 +1532,9 @@ class CompressionSimulation:
             elif step.type == WorkflowStepType.COMPUTE_BVH:
                 pass  # this is done on the prep workflow, not here
 
+        # Always emit the browser preview when there's particle data to preview.
+        self._add_to_workflow_reduce_results()
+
         self.workflow_yaml = yaml.dump(
             {"jobs": self.workflow_jobs}, default_flow_style=False, sort_keys=False
         )
@@ -2046,16 +2119,7 @@ class CompressionSimulation:
                     data["ply"] = f"{name}/ply/part.####.ply"
 
                     # Sum interior volumes from all parts
-                    total_volume = 0.0
-                    for part_info in self.part_infos:
-                        if self._is_analysis_target(part_info.part):
-                            if part_info.disabled:
-                                continue
-                            metrics_job = part_info.jobs.get("metrics", "")
-                            if metrics_job:
-                                raw = w.get_parameter(f"{metrics_job}.interior_volume")
-                                if raw is not None:
-                                    total_volume += float(raw)
+                    total_volume = self._total_interior_volume(w)
 
                     result.update(
                         {
@@ -2279,18 +2343,7 @@ class CompressionSimulation:
                             }
 
             # Sum interior volumes across analysis-target parts.
-            total_volume = 0.0
-            for part_info in self.part_infos:
-                if not self._is_analysis_target(part_info.part):
-                    continue
-                if part_info.disabled:
-                    continue
-                metrics_job = part_info.jobs.get("metrics", "")
-                if not metrics_job:
-                    continue
-                raw = w.get_parameter(f"{metrics_job}.interior_volume")
-                if raw is not None:
-                    total_volume += float(raw)
+            total_volume = self._total_interior_volume(w)
 
             result.update(
                 {
@@ -2384,27 +2437,32 @@ class CompressionSimulation:
                 "particle-displacement",
             ),
         ]
+        # Point the particle datasets DTB renders at the merged reduce-results
+        # job (compact int16/decimated), falling back to the raw job if preview
+        # didn't run. Histograms are tiny — leave them on the raw job.
+        reduce_job_id = job_id_lookup.get(self._REDUCE_JOB_NAME, "")
         for step, dataset_root, key_prefix, has_histogram, local_job in full_hdf_refs:
             if not self._contains_step(step):
                 continue
-            job_id = job_id_lookup.get(local_job, "")
+            raw_job_id = job_id_lookup.get(local_job, "")
+            data_job_id = reduce_job_id or raw_job_id
             for i in range(n_materials):
                 if self.part_infos[i].disabled:
                     continue
                 server_data[f"{key_prefix}{i}"] = {
-                    "jobId": job_id,
+                    "jobId": data_job_id,
                     "assetName": "output",
                     "path": f"/material{i}/{dataset_root}",
                 }
                 if has_histogram:
                     server_data[f"{key_prefix}Histogram{i}"] = {
-                        "jobId": job_id,
+                        "jobId": raw_job_id,
                         "assetName": "output",
                         "path": f"/material{i}/{dataset_root}_histogram",
                     }
 
         if self._contains_step(WorkflowStepType.COMPRESS):
-            job_id = job_id_lookup.get("compress", "")
+            job_id = reduce_job_id or job_id_lookup.get("compress", "")
             for i in range(n_materials):
                 if self.part_infos[i].disabled:
                     continue
@@ -2445,19 +2503,7 @@ class CompressionSimulation:
         Volume is inlined (from prep workflow parameters); energy values are
         refs that the server resolves from the energy-metrics job output."""
         scalars: dict[str, Any] = {}
-
-        total_volume = 0.0
-        for part_info in self.part_infos:
-            if not self._is_analysis_target(part_info.part):
-                continue
-            if part_info.disabled:
-                continue
-            metrics_job = part_info.jobs.get("metrics", "")
-            if metrics_job:
-                raw = workflow.get_parameter(f"{metrics_job}.interior_volume")
-                if raw is not None:
-                    total_volume += float(raw)
-        scalars["volume"] = total_volume
+        scalars["volume"] = self._total_interior_volume(workflow)
 
         if self._contains_step(WorkflowStepType.ENERGY_METRICS):
             em_job_id = job_id_lookup.get("energy-metrics", "")
@@ -2717,7 +2763,7 @@ class CompressionSimulation:
                     "heading": "Absorbed Energy (J)",
                     "filtering": False,
                 }
-            )    
+            )
             self.manifest["resultsListConfig"].append(
                             {
                     "key": "loadingEnergy",

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: metafold
-Version: 0.12.dev11
+Version: 0.13.dev0
 Summary: Metafold SDK for Python
 Author-email: Metafold 3D <info@metafold3d.com>
 License: Copyright 2024 Metafold 3D
@@ -25,7 +25,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.12
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: attrs~=23.2
@@ -38,7 +38,7 @@ Requires-Dist: dotenv>=0.9.9; extra == "simulation"
 Requires-Dist: pandas>=2.3.3; extra == "simulation"
 Requires-Dist: plyfile>=1.1.3; extra == "simulation"
 Requires-Dist: pyyaml>=6.0.3; extra == "simulation"
-Requires-Dist: simulation-configurator==0.1.2; extra == "simulation"
+Requires-Dist: simulation-configurator==0.2.*; extra == "simulation"
 Requires-Dist: tables>=3.11.1; extra == "simulation"
 Dynamic: license-file
 

{metafold-0.12.dev11 → metafold-0.13.dev0}/metafold.egg-info/requires.txt

@@ -9,5 +9,5 @@ dotenv>=0.9.9
 pandas>=2.3.3
 plyfile>=1.1.3
 pyyaml>=6.0.3
-simulation-configurator==0.1.2
+simulation-configurator==0.2.*
 tables>=3.11.1

{metafold-0.12.dev11 → metafold-0.13.dev0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "metafold"
-version = "0.12.dev11"
+version = "0.13.dev0"
 authors = [
     {name = "Metafold 3D", email = "info@metafold3d.com"},
 ]
@@ -18,7 +18,7 @@ dependencies = [
 readme = "README.md"
 license = {file = "LICENSE"}
 description = "Metafold SDK for Python"
-requires-python = ">=3.12"
+requires-python = ">=3.11"
 keywords = ["metafold", "api", "sdk", "implicit geometry"]
 classifiers = [
     "Development Status :: 3 - Alpha",
@@ -38,7 +38,7 @@ simulation = [
     "pandas>=2.3.3",
     "plyfile>=1.1.3",
     "pyyaml>=6.0.3",
-    "simulation-configurator==0.1.2",
+    "simulation-configurator==0.2.*",
     "tables>=3.11.1",
 ]
 
@@ -68,7 +68,7 @@ packages = ["metafold", "metafold.simulation"]
 environments = ["sys_platform == 'linux'"]
 
 [tool.uv.sources]
-simulation-configurator = { index = "sim-config-idx" }
+simulation-configurator = { index = "gitlab" }
 
 [[tool.mypy.overrides]]
 module = [
@@ -79,7 +79,7 @@ module = [
 ignore_missing_imports = true
 
 [[tool.uv.index]]
-name = "sim-config-idx"
+name = "gitlab"
 url = "https://gitlab.com/api/v4/projects/75460563/packages/pypi/simple"
 explicit = true
 authenticate = "always"

{metafold-0.12.dev11 → metafold-0.13.dev0}/tests/test_compression_simulation.py

@@ -167,13 +167,15 @@ class TestBuildWorkflow:
         assert isinstance(piston.part, ExperimentPistonBase)
         assert piston.material_index == 0
 
-    def test_build_workflow_has_per_part_metrics_jobs(self, prepared_sim):
-        yaml_str, _ = prepared_sim.build_workflow()
+    def test_prep_workflow_has_per_part_metrics_jobs(self, prepared_sim):
+        mesh_parts = [p for p in prepared_sim.part_infos if hasattr(p.part, "filename")]
+        yaml_str, _, _ = prepared_sim._build_sample_workflow_for_batch(mesh_parts)
         loaded = yaml.safe_load(yaml_str)
-        # one metrics job per non-piston mesh part
+        # one metrics job per non-piston mesh part, chained to its sample job
         for info in prepared_sim.part_infos:
             if not isinstance(info.part, ExperimentPistonBase) and hasattr(info.part, "filename"):
-                assert f"metrics-{info.part_unique_name}" in loaded["jobs"]
+                job = loaded["jobs"][f"metrics-{info.part_unique_name}"]
+                assert job["needs"] == [f"sample-mesh-{info.part_unique_name}"]
 
     def test_build_workflow_compress_has_velocity(self, prepared_sim):
         _, params = prepared_sim.build_workflow()
@@ -577,6 +579,23 @@ jobs:
     - force-displacement
     assets:
       data: force-displacement
+  reduce-results:
+    type: sim/postprocess/reduce-results
+    needs:
+    - compress
+    - von-mises-stress
+    - effective-strain
+    - particle-displacement
+    assets:
+      data:
+      - job: compress
+        asset: output
+      - job: von-mises-stress
+        asset: output
+      - job: effective-strain
+        asset: output
+      - job: particle-displacement
+        asset: output
 """
         assert yaml_str.strip() == expected_yaml.strip()
 
@@ -1130,6 +1149,7 @@ class TestSetupClient:
             simulation_name="t",
             stl_folder_path=str(ply_folder),
             output_path=str(tmp_path / "out"),
+            env_source=None,  # Ensure local .env files do not pollute test environment
             **kwargs,
         )