tpmslab 0.3.0__tar.gz → 0.3.4__tar.gz

{tpmslab-0.3.0 → tpmslab-0.3.4}/.zenodo.json

@@ -1,6 +1,6 @@
 {
-  "title": "TPMS Lab v0.3.0",
-  "version": "0.3.0",
+  "title": "TPMS Lab v0.3.1",
+  "version": "0.3.1",
   "upload_type": "software",
   "description": "Python package for graded complementary solid and pore-fluid meshes with shared interfaces, connected-domain metadata and optional verified COMSOL workflows. Source, tests, examples and numerical validation records are included.",
   "creators": [

{tpmslab-0.3.0 → tpmslab-0.3.4}/CHANGELOG.md

@@ -1,3 +1,29 @@
+# 0.3.4
+
+- Add configurable density-calibration sampling via `m_cal` (default 56).
+
+- Remove fixed upper limits on per-cell resolution and per-axis cell counts.
+- Use an uncapped integer input in the browser interface.
+- Preserve lower bounds, integer validation and numerical algorithms.
+
+# 0.3.3
+
+- Set the per-cell resolution maximum to 48 in Python and the browser slider.
+- Retain removal of the total background-grid cap.
+- Synchronize documentation and add boundary regression checks.
+- Report the running generator version instead of a stale literal; geometry is unchanged.
+
+# 0.3.2
+
+- Remove the fixed 200,000-background-voxel limit from configuration validation.
+- Retain per-axis cell-count and per-cell resolution validation.
+- Add configuration regression coverage for grids above the former limit.
+
+# 0.3.1
+
+- Use English for Python progress callbacks, exceptions, API messages and exported warnings.
+- Update generator metadata; preserve numerical algorithms and historical validation records.
+
 # Changelog
 
 ## 0.3.0

{tpmslab-0.3.0 → tpmslab-0.3.4}/CITATION.cff

@@ -2,7 +2,7 @@ cff-version: 1.2.0
 message: "Please cite the exact software version used."
 type: software
 title: "TPMS Lab"
-version: "0.3.0"
+version: "0.3.1"
 authors:
   - family-names: Chen
     given-names: Xin

{tpmslab-0.3.0 → tpmslab-0.3.4}/MANIFEST.in

@@ -10,3 +10,5 @@ prune paper
 
 recursive-include validation *.json *.csv *.md
 include CITATION.cff .zenodo.json
+
+include docs/runtime_hashes_0.3.1.json

{tpmslab-0.3.0 → tpmslab-0.3.4}/PKG-INFO

@@ -1,220 +1,227 @@
-Metadata-Version: 2.4
-Name: tpmslab
-Version: 0.3.0
-Summary: Direct conforming volume meshes for graded implicit TPMS lattices
-License-Expression: MIT
-Keywords: TPMS,finite-element,meshing,graded-lattice,COMSOL
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-License-File: licenses/LattGen-MIT.txt
-Requires-Dist: numpy<3,>=1.26
-Requires-Dist: scipy<2,>=1.11
-Requires-Dist: trimesh<6,>=4
-Provides-Extra: web
-Requires-Dist: flask<4,>=3.1; extra == "web"
-Provides-Extra: test
-Requires-Dist: pytest<10,>=8; extra == "test"
-Requires-Dist: flask<4,>=3.1; extra == "test"
-Provides-Extra: dev
-Requires-Dist: pytest<10,>=8; extra == "dev"
-Requires-Dist: flask<4,>=3.1; extra == "dev"
-Requires-Dist: build>=1.2; extra == "dev"
-Requires-Dist: twine>=6; extra == "dev"
-Requires-Dist: ruff>=0.12; extra == "dev"
-Dynamic: license-file
-
-# TPMS Lab
-
-[English quick start](docs/QUICKSTART_EN.md) | [中文使用说明](docs/QUICKSTART_ZH.md)
-
-An installable Python toolkit for graded TPMS-derived **solid and complementary pore-fluid volume meshes**.
-Version 0.3.0. This repository is public. Source, tests, examples and versioned
-reproducibility records are distributed together. Use an exact commit or the
-`v0.3.0` tag, rather than a changing `main`, for reproducible work.
-
-[Version and installation details](docs/VERSION_0.3.0.md) |
-[GitHub releases](https://github.com/Slight1211/TPMSLab/releases)
-
-A public source repository, a GitHub Release, a Zenodo archive and a PyPI upload
-are separate records. Cite a DOI only after the archive is actually published.
-No PyPI release has been made.
-
-## Install
-
-Use Python 3.11 or newer. From this source directory:
-
-```sh
-python -m pip install .
-# Optional local browser interface
-python -m pip install ".[web]"
-```
-
-Build a wheel locally with `python -m build` (requires the `build` package). The core does not require Flask, COMSOL, MATLAB,
-OpenCascade, a CAD import licence or a graphics display. COMSOL model creation
-and solving require a separate compatible COMSOL installation and licence.
-
-## Python API
-
-```python
-from tpmslab import Config, generate, save_model
-
-mesh = generate(Config(family="Gyroid", resolution=16,
-                       density_start=0.25, density_end=0.50,
-                       gradient="linear", quality_strategy="quality_fan"))
-print(mesh["report"]["actual_density"])
-save_model(mesh, "gyroid_result")  # destination must not exist
-```
-
-`generate` also accepts a dictionary. `list_families()` returns formula metadata.
-Coordinates are millimetres; array connectivity is zero-based. The returned
-mapping contains `points`, `tetra`, `boundary`, `boundary_ids`, `domains`,
-`surface` (a trimesh object) and `report`. This API may change before
-1.0. Configuration objects normalize sequence fields to immutable tuples.
-
-## Command line
-
-```sh
-tpmslab init-config params.json
-tpmslab generate --config params.json --out result
-tpmslab families
-tpmslab web --output local_models
-# Requires licensed COMSOL on Windows:
-tpmslab generate --config params.json --out solved_result --solve
-```
-
-Export includes `mesh.nas` (CTETRA volume elements and labelled boundary
-triangles), `mesh.npz`, `preview.stl`, parameters, diagnostics, environment and a
-SHA-256 manifest. Existing output directories are rejected. A failed export
-can leave a partial directory; choose a new destination after addressing the
-error. STL is only a boundary preview. The optional bridge imports the volume
-mesh, creates an MPH and reopens it to check the embedded element count.
-Set `COMSOL_BIN` to the folder containing `comsolbatch.exe` and
-`comsolcompile.exe` if automatic Windows detection fails.
-
-## Method and limits
-
-The library samples trigonometric level-set approximations, calibrates density
-against a 56 cubed periodic-cell sample and clips a six-tetrahedra-per-voxel
-background mesh. Sheet structures use two separate interpolated inequalities;
-they do not have constant physical wall thickness. Shared intersections and
-canonical face diagonals form a conforming tetrahedral volume mesh. Material
-volume, boundary closure, face incidence and orientation are checked before
-export. The result is a piecewise-planar solid domain, **not editable smooth
-STEP/NURBS CAD**. Mesh generation can reject difficult parameter combinations.
-
-`quality_fan` compares the original pulling fan with an interior-centroid fan
-for poor cut cells and accepts only a better worst mean-ratio quality while
-preserving boundary triangles and volume. This increases element count and can
-reduce median quality. It provides no angle bound, global optimization or
-finite-element convergence guarantee. `pulling` retains the baseline method.
-
-There are 29 reference labels (27 distinct expressions, with aliases), eight
-density profiles, sheet and two network modes, phase controls, and a restricted
-custom-formula parser. Built-in formulas are adapted from LattGen; see
-`THIRD_PARTY_NOTICES.md`. They are not claimed as new TPMS families or exact
-minimal surfaces. Density targets are periodic-cell calibrations, not guaranteed
-finite-specimen volume fractions. Current bounds: box domains, 1–6 cells per
-axis, 8–64 samples per cell and at most 200,000 background voxels. The built-in
-static demo is limited to 180,000 tetrahedra and connected material. Top/bottom
-contact, constraints and convergence must be checked for a research model.
-
-## Development and reproduction
-
-```sh
-python -m pip install ".[dev]"
-python -m pytest
-python -m ruff check src tests benchmarks
-python -m build
-python -m twine check dist/*
-python benchmarks/run_benchmarks.py --out benchmark_results
-```
-
-See `docs/METHOD.md`, `docs/SOLID_FLUID.md` and `docs/VALIDATION.md`.
-The CI matrix is configured for Windows/Linux and Python 3.11/3.12; configuring
-CI does not mean those jobs have run. The measured local environment is Windows
-and Python 3.12. Optional COMSOL validation is separate from the open test suite.
-
-## Licence and attribution
-
-MIT. See `LICENSE`, `THIRD_PARTY_NOTICES.md` and `licenses/` for the
-package licence and third-party formula and browser-library notices.
-
-## Solid and pore-fluid domains (0.3)
-
-```python
-from tpmslab import Config, generate, save_model
-from tpmslab.comsol import build_mph
-
-mesh = generate(Config(domain_mode="solid_fluid", family="Gyroid", resolution=12))
-folder = save_model(mesh, "solid_fluid_gyroid")
-# Optional, licensed COMSOL: verifies selections, each domain volume and saved mesh.
-build_mph(folder, mesh["report"], solve=False)
-# solve=True instead runs the fixed-wall pore-flow demonstration described below.
-```
-
-In the browser, select **固体 + 孔隙流体（共享界面）** under **计算域**.
-The phase selector switches the preview between solid and pore fluid.
-The default remains solid-only for compatibility. The JSON/CLI parameter is
-`"domain_mode": "solid_fluid"`.
-
-Both phases partition the same bounding box. They use shared cut-edge vertices
-and identical interface triangles. For sheet structures the two complementary
-inequalities are meshed separately, allowing disconnected labyrinths to remain
-separate domains. Connectivity is determined by shared tetrahedron faces.
-The combined mesh is checked for positive volumes, opposite adjacent-face
-orientation, complete interface matching and total volume conservation.
-
-`phase_ids` is one value per tetrahedron (1=solid, 2=fluid); `domains` identifies
-individual connected domains. `interface` is oriented out of the solid.
-`boundary` includes the outer boundary AND the solid-fluid interface once.
-Additional arrays are `solid_boundary` and `fluid_boundary`. `surface` and
-`preview.stl` continue to show the solid; `fluid_surface` and `fluid_preview.stl`
-show the pore fluid. The NPZ retains all phase and boundary arrays. `domains.json`
-records domain-to-phase and boundary-name mappings. Report `volume_mm3` remains
-solid volume; `total_mesh_volume_mm3` includes both phases.
-
-NASTRAN PSOLID property IDs are `100 + domain_id`. Boundary PIDs 2–7 are solid
-xmin/xmax/ymin/ymax/zmin/zmax; 12–17 are the corresponding fluid faces; PID 8
-is the shared interface. PIDs are NOT COMSOL entity numbers. The bridge resolves
-imported PID selections and creates `solid_domains`, `fluid_domains`, individual
-connected-domain selections, `solid_fluid_interface`, and the nonempty exterior
-face selections. It assigns demonstration solid/fluid materials separately.
-An unsolved export requires no CFD physics interface and is a starting point
-for the user's physics setup.
-
-For dual-domain models, `solve=True` runs stationary **creeping flow only in the
-fluid**, with fixed no-slip solid walls, pressure 0.01 Pa at fluid_zmin and 0 Pa
-at fluid_zmax, and no-slip on other fluid exterior faces. Density is 1000 kg/m³
-and viscosity 0.001 Pa·s. Every fluid component must reach both Z faces; otherwise
-the automatic demo is refused while unsolved export remains available. This
-requires the corresponding COMSOL physics licence. It reports inlet/outlet
-flow and relative imbalance (the smoke-test threshold is 5%, not an accuracy
-claim). It is **not deformation-coupled FSI**, not conjugate heat transfer, and
-not a validated permeability prediction. Boundary layers, external reservoirs,
-mesh convergence and realistic boundary conditions remain user responsibilities.
-See `docs/SOLID_FLUID.md` for validation and reproducibility.
-
-## Solid–fluid quick start
-
-Run [the Python example](examples/solid_fluid_api.py). Installation, exported
-files and optional COMSOL calculations are documented in the
-[English quick start](docs/QUICKSTART_EN.md) and
-[中文使用说明](docs/QUICKSTART_ZH.md).
-
-## Independent verification
-
-See [Verification and reproducible studies](docs/VERIFICATION.md) for density realization, independent interface incidence and area audits, channel-wise COMSOL flux checks, and refinement/performance scripts. `quality_fan` is optional local worst-element mitigation, not a general quality or solver-speed guarantee.
-
-## Reproducibility records
-
-See [validation/README.md](validation/README.md) for the numerical records,
-configuration provenance and reproduction commands corresponding to the verified
-workflow. The package provides mesh-defined simulation domains, not smooth CAD
-reconstruction or coupled FSI.
+Metadata-Version: 2.4
+Name: tpmslab
+Version: 0.3.4
+Summary: Direct conforming volume meshes for graded implicit TPMS lattices
+License-Expression: MIT
+Keywords: TPMS,finite-element,meshing,graded-lattice,COMSOL
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: licenses/LattGen-MIT.txt
+Requires-Dist: numpy<3,>=1.26
+Requires-Dist: scipy<2,>=1.11
+Requires-Dist: trimesh<6,>=4
+Provides-Extra: web
+Requires-Dist: flask<4,>=3.1; extra == "web"
+Provides-Extra: test
+Requires-Dist: pytest<10,>=8; extra == "test"
+Requires-Dist: flask<4,>=3.1; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest<10,>=8; extra == "dev"
+Requires-Dist: flask<4,>=3.1; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=6; extra == "dev"
+Requires-Dist: ruff>=0.12; extra == "dev"
+Dynamic: license-file
+
+# TPMS Lab
+
+[English quick start](docs/QUICKSTART_EN.md) | [中文使用说明](docs/QUICKSTART_ZH.md)
+
+An installable Python toolkit for graded TPMS-derived **solid and complementary pore-fluid volume meshes**.
+The current source revision is 0.3.4 (no fixed resolution or cell-count upper limits). The published
+PyPI baseline is 0.3.0. This repository is public. Source, tests, examples and versioned
+reproducibility records are distributed together. Use an exact commit or the
+`v0.3.0` tag, rather than a changing `main`, for reproducible work.
+
+[Version and installation details](docs/VERSION_0.3.0.md) |
+[GitHub releases](https://github.com/Slight1211/TPMSLab/releases)
+
+A public source repository, a GitHub Release, a Zenodo archive and a PyPI upload
+are separate records. Cite a DOI only after the archive is actually published.
+Version 0.3.0 is available on [PyPI](https://pypi.org/project/tpmslab/0.3.0/).
+Version 0.3.4 is a source/local-wheel patch until a separate release is published.
+See [patch notes](docs/RELEASE_NOTES_v0.3.4.md).
+
+## Install
+
+Use Python 3.11 or newer. From this source directory:
+
+```sh
+python -m pip install .
+# Optional local browser interface
+python -m pip install ".[web]"
+```
+
+Build a wheel locally with `python -m build` (requires the `build` package). The core does not require Flask, COMSOL, MATLAB,
+OpenCascade, a CAD import licence or a graphics display. COMSOL model creation
+and solving require a separate compatible COMSOL installation and licence.
+
+## Python API
+
+```python
+from tpmslab import Config, generate, save_model
+
+mesh = generate(Config(family="Gyroid", resolution=16,
+                       density_start=0.25, density_end=0.50,
+                       gradient="linear", quality_strategy="quality_fan"))
+print(mesh["report"]["actual_density"])
+save_model(mesh, "gyroid_result")  # destination must not exist
+```
+
+`generate` also accepts a dictionary. `list_families()` returns formula metadata.
+Coordinates are millimetres; array connectivity is zero-based. The returned
+mapping contains `points`, `tetra`, `boundary`, `boundary_ids`, `domains`,
+`surface` (a trimesh object) and `report`. This API may change before
+1.0. Configuration objects normalize sequence fields to immutable tuples.
+
+## Command line
+
+```sh
+tpmslab init-config params.json
+tpmslab generate --config params.json --out result
+tpmslab families
+tpmslab web --output local_models
+# Requires licensed COMSOL on Windows:
+tpmslab generate --config params.json --out solved_result --solve
+```
+
+Export includes `mesh.nas` (CTETRA volume elements and labelled boundary
+triangles), `mesh.npz`, `preview.stl`, parameters, diagnostics, environment and a
+SHA-256 manifest. Existing output directories are rejected. A failed export
+can leave a partial directory; choose a new destination after addressing the
+error. STL is only a boundary preview. The optional bridge imports the volume
+mesh, creates an MPH and reopens it to check the embedded element count.
+Set `COMSOL_BIN` to the folder containing `comsolbatch.exe` and
+`comsolcompile.exe` if automatic Windows detection fails.
+
+## Method and limits
+
+The library samples trigonometric level-set approximations, calibrates density
+against a 56 cubed periodic-cell sample and clips a six-tetrahedra-per-voxel
+background mesh. Sheet structures use two separate interpolated inequalities;
+they do not have constant physical wall thickness. Shared intersections and
+canonical face diagonals form a conforming tetrahedral volume mesh. Material
+volume, boundary closure, face incidence and orientation are checked before
+export. The result is a piecewise-planar solid domain, **not editable smooth
+STEP/NURBS CAD**. Mesh generation can reject difficult parameter combinations.
+
+`quality_fan` compares the original pulling fan with an interior-centroid fan
+for poor cut cells and accepts only a better worst mean-ratio quality while
+preserving boundary triangles and volume. This increases element count and can
+reduce median quality. It provides no angle bound, global optimization or
+finite-element convergence guarantee. `pulling` retains the baseline method.
+
+There are 29 reference labels (27 distinct expressions, with aliases), eight
+density profiles, sheet and two network modes, phase controls, and a restricted
+custom-formula parser. Built-in formulas are adapted from LattGen; see
+`THIRD_PARTY_NOTICES.md`. They are not claimed as new TPMS families or exact
+minimal surfaces. Density targets are periodic-cell calibrations, not guaranteed
+finite-specimen volume fractions. Current bounds: box domains, positive integer cell counts per
+axis and at least 8 samples per cell, with no fixed upper limits. There is no fixed background-voxel count cap; feasible grid sizes depend on available memory. The built-in
+static demo is limited to 180,000 tetrahedra and connected material. Top/bottom
+contact, constraints and convergence must be checked for a research model.
+
+## Development and reproduction
+
+```sh
+python -m pip install ".[dev]"
+python -m pytest
+python -m ruff check src tests benchmarks
+python -m build
+python -m twine check dist/*
+python benchmarks/run_benchmarks.py --out benchmark_results
+```
+
+See `docs/METHOD.md`, `docs/SOLID_FLUID.md` and `docs/VALIDATION.md`.
+The CI matrix is configured for Windows/Linux and Python 3.11/3.12; configuring
+CI does not mean those jobs have run. The measured local environment is Windows
+and Python 3.12. Optional COMSOL validation is separate from the open test suite.
+
+## Licence and attribution
+
+MIT. See `LICENSE`, `THIRD_PARTY_NOTICES.md` and `licenses/` for the
+package licence and third-party formula and browser-library notices.
+
+## Solid and pore-fluid domains (0.3)
+
+```python
+from tpmslab import Config, generate, save_model
+from tpmslab.comsol import build_mph
+
+mesh = generate(Config(domain_mode="solid_fluid", family="Gyroid", resolution=12))
+folder = save_model(mesh, "solid_fluid_gyroid")
+# Optional, licensed COMSOL: verifies selections, each domain volume and saved mesh.
+build_mph(folder, mesh["report"], solve=False)
+# solve=True instead runs the fixed-wall pore-flow demonstration described below.
+```
+
+In the browser, select **固体 + 孔隙流体（共享界面）** under **计算域**.
+The phase selector switches the preview between solid and pore fluid.
+The default remains solid-only for compatibility. The JSON/CLI parameter is
+`"domain_mode": "solid_fluid"`.
+
+Both phases partition the same bounding box. They use shared cut-edge vertices
+and identical interface triangles. For sheet structures the two complementary
+inequalities are meshed separately, allowing disconnected labyrinths to remain
+separate domains. Connectivity is determined by shared tetrahedron faces.
+The combined mesh is checked for positive volumes, opposite adjacent-face
+orientation, complete interface matching and total volume conservation.
+
+`phase_ids` is one value per tetrahedron (1=solid, 2=fluid); `domains` identifies
+individual connected domains. `interface` is oriented out of the solid.
+`boundary` includes the outer boundary AND the solid-fluid interface once.
+Additional arrays are `solid_boundary` and `fluid_boundary`. `surface` and
+`preview.stl` continue to show the solid; `fluid_surface` and `fluid_preview.stl`
+show the pore fluid. The NPZ retains all phase and boundary arrays. `domains.json`
+records domain-to-phase and boundary-name mappings. Report `volume_mm3` remains
+solid volume; `total_mesh_volume_mm3` includes both phases.
+
+NASTRAN PSOLID property IDs are `100 + domain_id`. Boundary PIDs 2–7 are solid
+xmin/xmax/ymin/ymax/zmin/zmax; 12–17 are the corresponding fluid faces; PID 8
+is the shared interface. PIDs are NOT COMSOL entity numbers. The bridge resolves
+imported PID selections and creates `solid_domains`, `fluid_domains`, individual
+connected-domain selections, `solid_fluid_interface`, and the nonempty exterior
+face selections. It assigns demonstration solid/fluid materials separately.
+An unsolved export requires no CFD physics interface and is a starting point
+for the user's physics setup.
+
+For dual-domain models, `solve=True` runs stationary **creeping flow only in the
+fluid**, with fixed no-slip solid walls, pressure 0.01 Pa at fluid_zmin and 0 Pa
+at fluid_zmax, and no-slip on other fluid exterior faces. Density is 1000 kg/m³
+and viscosity 0.001 Pa·s. Every fluid component must reach both Z faces; otherwise
+the automatic demo is refused while unsolved export remains available. This
+requires the corresponding COMSOL physics licence. It reports inlet/outlet
+flow and relative imbalance (the smoke-test threshold is 5%, not an accuracy
+claim). It is **not deformation-coupled FSI**, not conjugate heat transfer, and
+not a validated permeability prediction. Boundary layers, external reservoirs,
+mesh convergence and realistic boundary conditions remain user responsibilities.
+See `docs/SOLID_FLUID.md` for validation and reproducibility.
+
+## Solid–fluid quick start
+
+Run [the Python example](examples/solid_fluid_api.py). Installation, exported
+files and optional COMSOL calculations are documented in the
+[English quick start](docs/QUICKSTART_EN.md) and
+[中文使用说明](docs/QUICKSTART_ZH.md).
+
+## Independent verification
+
+See [Verification and reproducible studies](docs/VERIFICATION.md) for density realization, independent interface incidence and area audits, channel-wise COMSOL flux checks, and refinement/performance scripts. `quality_fan` is optional local worst-element mitigation, not a general quality or solver-speed guarantee.
+
+## Reproducibility records
+
+See [validation/README.md](validation/README.md) for the numerical records,
+configuration provenance and reproduction commands corresponding to the verified
+workflow. The package provides mesh-defined simulation domains, not smooth CAD
+reconstruction or coupled FSI.
+
+### Density calibration sampling
+
+`Config(m_cal=80)` sets the number of midpoint samples per axis used to calibrate density to threshold (80 cubed samples). The default is 56; values must be integers of at least 8, with no fixed upper bound. This parameter is independent of mesh `resolution`. JSON configurations use the same `m_cal` key; older configurations default to 56. Exported configuration records include the selected value. Increasing it changes density calibration and can change the generated geometry. Historical validation used 56.

{tpmslab-0.3.0 → tpmslab-0.3.4}/README.md

@@ -3,7 +3,8 @@
 [English quick start](docs/QUICKSTART_EN.md) | [中文使用说明](docs/QUICKSTART_ZH.md)
 
 An installable Python toolkit for graded TPMS-derived **solid and complementary pore-fluid volume meshes**.
-Version 0.3.0. This repository is public. Source, tests, examples and versioned
+The current source revision is 0.3.4 (no fixed resolution or cell-count upper limits). The published
+PyPI baseline is 0.3.0. This repository is public. Source, tests, examples and versioned
 reproducibility records are distributed together. Use an exact commit or the
 `v0.3.0` tag, rather than a changing `main`, for reproducible work.
 
@@ -12,7 +13,9 @@ reproducibility records are distributed together. Use an exact commit or the
 
 A public source repository, a GitHub Release, a Zenodo archive and a PyPI upload
 are separate records. Cite a DOI only after the archive is actually published.
-No PyPI release has been made.
+Version 0.3.0 is available on [PyPI](https://pypi.org/project/tpmslab/0.3.0/).
+Version 0.3.4 is a source/local-wheel patch until a separate release is published.
+See [patch notes](docs/RELEASE_NOTES_v0.3.4.md).
 
 ## Install
 
@@ -88,8 +91,8 @@ density profiles, sheet and two network modes, phase controls, and a restricted
 custom-formula parser. Built-in formulas are adapted from LattGen; see
 `THIRD_PARTY_NOTICES.md`. They are not claimed as new TPMS families or exact
 minimal surfaces. Density targets are periodic-cell calibrations, not guaranteed
-finite-specimen volume fractions. Current bounds: box domains, 1–6 cells per
-axis, 8–64 samples per cell and at most 200,000 background voxels. The built-in
+finite-specimen volume fractions. Current bounds: box domains, positive integer cell counts per
+axis and at least 8 samples per cell, with no fixed upper limits. There is no fixed background-voxel count cap; feasible grid sizes depend on available memory. The built-in
 static demo is limited to 180,000 tetrahedra and connected material. Top/bottom
 contact, constraints and convergence must be checked for a research model.
 
@@ -186,3 +189,7 @@ See [validation/README.md](validation/README.md) for the numerical records,
 configuration provenance and reproduction commands corresponding to the verified
 workflow. The package provides mesh-defined simulation domains, not smooth CAD
 reconstruction or coupled FSI.
+
+### Density calibration sampling
+
+`Config(m_cal=80)` sets the number of midpoint samples per axis used to calibrate density to threshold (80 cubed samples). The default is 56; values must be integers of at least 8, with no fixed upper bound. This parameter is independent of mesh `resolution`. JSON configurations use the same `m_cal` key; older configurations default to 56. Exported configuration records include the selected value. Increasing it changes density calibration and can change the generated geometry. Historical validation used 56.

{tpmslab-0.3.0 → tpmslab-0.3.4}/benchmarks/release_reference.py

@@ -34,13 +34,21 @@ def main():
     installed = Path(tpmslab.__file__).resolve().parent
     if installed == src / "src" / "tpmslab":
         raise RuntimeError("Install the wheel first; this check must use the installed package")
-    assert importlib.metadata.version("tpmslab") == "0.3.0"
+    installed_version = importlib.metadata.version("tpmslab")
+    assert installed_version in {"0.3.0", "0.3.1"}
     provenance = json.loads((src / "validation/provenance.json").read_text(encoding="utf8"))
-    for record in provenance["algorithm_files_unchanged"]:
-        original = src / record["path"]
-        packaged = installed / Path(record["path"]).name
-        assert digest(original) == record["git_lf_sha256"], record["path"]
-        assert digest(packaged) == record["git_lf_sha256"], packaged
+    if installed_version == "0.3.0":
+        for record in provenance["algorithm_files_unchanged"]:
+            original = src / record["path"]
+            packaged = installed / Path(record["path"]).name
+            assert digest(original) == record["git_lf_sha256"], record["path"]
+            assert digest(packaged) == record["git_lf_sha256"], packaged
+    else:
+        # Localized messages change source bytes; preserve the historical manifest.
+        hashes = json.loads((src / "docs/runtime_hashes_0.3.1.json").read_text())
+        for filename, expected in hashes.items():
+            assert digest(src / "src/tpmslab" / filename) == expected, filename
+            assert digest(installed / filename) == expected, filename
     checksums = json.loads((src / "validation/checksums.json").read_text(encoding="utf8"))
     for relative, expected in checksums.items():
         assert digest(src / "validation" / relative) == expected, relative