mphkit 0.1.0__tar.gz

mphkit-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 elgar328
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mphkit-0.1.0/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: mphkit
+Version: 0.1.0
+Summary: Helpers on top of MPh for building COMSOL geometries and geometry-based selections in Python.
+Keywords: comsol,mph,multiphysics,geometry,selection,simulation,fem
+Author: elgar328
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Typing :: Typed
+Requires-Dist: mph>=1.4
+Requires-Dist: numpy
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/elgar328/mphkit
+Project-URL: Repository, https://github.com/elgar328/mphkit
+Project-URL: Changelog, https://github.com/elgar328/mphkit/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/elgar328/mphkit/issues
+Description-Content-Type: text/markdown
+
+# mphkit
+
+Helpers on top of [MPh](https://github.com/MPh-py/MPh) for building COMSOL
+geometries and geometry-based selections in Python. Select boundaries by
+location instead of by entity number, so selections keep working when the
+geometry changes.
+
+> [!WARNING]
+> **Early stage.** mphkit is at an early stage of development. The API may
+> change at any time, without deprecation warnings.
+
+Not affiliated with COMSOL AB.
+
+## Example
+
+```python
+import mph
+import mphkit as mk
+
+client = mph.start()
+model = client.create('demo')
+geom = mk.geometry(model, 3, length_unit='mm')
+
+plate = mk.block(geom, (100, 100, 10), name='plate')
+hole = mk.cylinder(geom, 5, 10, (50, 50, 0))
+mk.difference(geom, plate, [hole])
+model.build(geom)
+
+bottom = mk.sel.box(geom, 'boundary', z=0)     # faces on the plane z = 0
+
+# plain MPh from here on
+physics = (model/'physics').create('HeatTransfer', geom)
+physics.create('TemperatureBoundary', 2).select(bottom)
+model.save('demo.mph')
+```
+
+Every helper takes MPh `Node`s, and those that create something return
+one, so mphkit and MPh mix freely. Physics, mesh, study and results stay
+plain MPh (or the COMSOL Java API through `node.java`).
+
+## Requirements
+
+- COMSOL Multiphysics with a license, installed where MPh can find it
+  (see the [MPh documentation](https://mph.readthedocs.io)).
+- Python 3.10 or newer, MPh 1.4 or newer.
+- Importing CAD files (`mk.import_` with STEP, IGES, ...) needs a license
+  for CAD import (CAD Import Module, Design Module or a LiveLink).
+  Everything else needs COMSOL only.
+
+Tested with COMSOL 6.4 and MPh 1.4.0, on macOS (Apple silicon) with
+Python 3.10 and 3.13 and on Windows with Python 3.13. Linux is not tested
+yet; since mphkit only goes through MPh, it is expected to work the same
+way.
+
+## Installation
+
+```
+pip install mphkit
+```
+
+or `uv add mphkit` in a uv project.
+
+What changed between versions is listed in
+[CHANGELOG.md](https://github.com/elgar328/mphkit/blob/main/CHANGELOG.md).
+
+## What it covers
+
+Geometry, in 3D, 2D and in work planes:
+
+```python
+mk.block(geom, (10, 10, 5)); mk.cylinder(geom, r, h, pos); mk.sphere(geom, r)
+mk.union(geom, [a, b]); mk.difference(geom, a, [b]); mk.intersection(geom, [a, b])
+mk.move(geom, part, (10, 0, 0)); mk.rotate(geom, part, 90, axis='z')
+mk.mirror(geom, part, (1, 0, 0)); mk.array(geom, part, size=(5, 5, 1), displ=(10, 10, 0))
+mk.fillet(geom, block, 0.5); mk.chamfer(geom, block, 0.5)   # all edges, or a selection
+mk.partition(geom, part, tool); mk.delete(geom, part)
+plane = mk.workplane(geom, quickz=0)
+mk.circle(plane, 2); mk.extrude(geom, plane, 5); mk.revolve(geom, plane)
+mk.import_(geom, 'part.step')
+mk.feature(geom, 'AnyType', ...)   # any other geometry feature
+```
+
+Selections by location (`mk.sel`), usable in physics, materials and mesh:
+
+```python
+mk.sel.box(geom, 'boundary', z=0)                 # a range per axis, or a value
+mk.sel.ball(geom, 'domain', center, r); mk.sel.cylinder(...); mk.sel.disk(...)
+mk.sel.union(geom, 'boundary', [a, b])            # also intersection, difference, complement
+mk.sel.adjacent(geom, domains)                    # boundaries around a domain selection
+mk.sel.result(geom, feature, 'domain')            # what a feature produced
+holes = mk.sel.cumulative(geom, 'holes', 'domain', create=True)
+mk.cylinder(geom, 1, 5, pos, contributeto=holes)  # collect from several features
+```
+
+`where='geometry'` makes a selection inside the geometry sequence instead,
+for use as input of a later operation, e.g. `mk.sel.box(geom, 'object',
+x=(20, 40), where='geometry')` to pick whole objects for `mk.delete`. In a
+work plane, selections pick single corners or edges:
+`mk.fillet(plane, mk.sel.box(plane, 'point', x=1, y=1), 0.3)`.
+
+Queries return plain Python values and leave nothing in the model:
+
+```python
+mk.sel.entities(geom, bottom)            # [3]
+mk.sel.find(geom, 'domain', x=(0, 10))   # entity numbers inside a box
+mk.measure(geom, 'domain')               # volume (area, length for other levels)
+mk.bounding_box(geom, 'boundary', 3)     # {'x': (0, 10), 'y': ..., 'z': ...}
+```
+
+And a few helpers outside geometry:
+
+```python
+mk.coordinate_system(geom, 'PML', selection=layer)   # e.g. perfectly matched layers
+mk.set(mesh_size, hmax=0.5, hgrad=2)   # any node or Java object; converts ints and lists
+```
+
+Arguments are COMSOL property names, so the COMSOL documentation of each
+feature applies. The docstrings describe each helper in detail.
+
+[`examples/plate_with_holes.py`](https://github.com/elgar328/mphkit/blob/main/examples/plate_with_holes.py)
+is a complete script, from geometry to solved results: heat conduction in
+a plate with a row of cooling holes, for any number of holes.
+
+## Limitations
+
+- mphkit covers geometry and selections only. Physics, mesh, studies and
+  results are left to MPh.
+- No named helpers yet for geometry parts (`PartInstance`), sweeps, cones
+  and the other remaining primitives, virtual operations or repair. They
+  work through `mk.feature(geom, 'Sweep', ...)` with the same conversions
+  and input handling.
+
+## Development
+
+```
+uv run pytest
+```
+
+The tests start COMSOL and build real models. Without a CAD import
+license, the CAD import test is skipped.
+
+## License
+
+MIT, see [LICENSE](https://github.com/elgar328/mphkit/blob/main/LICENSE).

mphkit-0.1.0/README.md

@@ -0,0 +1,144 @@
+# mphkit
+
+Helpers on top of [MPh](https://github.com/MPh-py/MPh) for building COMSOL
+geometries and geometry-based selections in Python. Select boundaries by
+location instead of by entity number, so selections keep working when the
+geometry changes.
+
+> [!WARNING]
+> **Early stage.** mphkit is at an early stage of development. The API may
+> change at any time, without deprecation warnings.
+
+Not affiliated with COMSOL AB.
+
+## Example
+
+```python
+import mph
+import mphkit as mk
+
+client = mph.start()
+model = client.create('demo')
+geom = mk.geometry(model, 3, length_unit='mm')
+
+plate = mk.block(geom, (100, 100, 10), name='plate')
+hole = mk.cylinder(geom, 5, 10, (50, 50, 0))
+mk.difference(geom, plate, [hole])
+model.build(geom)
+
+bottom = mk.sel.box(geom, 'boundary', z=0)     # faces on the plane z = 0
+
+# plain MPh from here on
+physics = (model/'physics').create('HeatTransfer', geom)
+physics.create('TemperatureBoundary', 2).select(bottom)
+model.save('demo.mph')
+```
+
+Every helper takes MPh `Node`s, and those that create something return
+one, so mphkit and MPh mix freely. Physics, mesh, study and results stay
+plain MPh (or the COMSOL Java API through `node.java`).
+
+## Requirements
+
+- COMSOL Multiphysics with a license, installed where MPh can find it
+  (see the [MPh documentation](https://mph.readthedocs.io)).
+- Python 3.10 or newer, MPh 1.4 or newer.
+- Importing CAD files (`mk.import_` with STEP, IGES, ...) needs a license
+  for CAD import (CAD Import Module, Design Module or a LiveLink).
+  Everything else needs COMSOL only.
+
+Tested with COMSOL 6.4 and MPh 1.4.0, on macOS (Apple silicon) with
+Python 3.10 and 3.13 and on Windows with Python 3.13. Linux is not tested
+yet; since mphkit only goes through MPh, it is expected to work the same
+way.
+
+## Installation
+
+```
+pip install mphkit
+```
+
+or `uv add mphkit` in a uv project.
+
+What changed between versions is listed in
+[CHANGELOG.md](https://github.com/elgar328/mphkit/blob/main/CHANGELOG.md).
+
+## What it covers
+
+Geometry, in 3D, 2D and in work planes:
+
+```python
+mk.block(geom, (10, 10, 5)); mk.cylinder(geom, r, h, pos); mk.sphere(geom, r)
+mk.union(geom, [a, b]); mk.difference(geom, a, [b]); mk.intersection(geom, [a, b])
+mk.move(geom, part, (10, 0, 0)); mk.rotate(geom, part, 90, axis='z')
+mk.mirror(geom, part, (1, 0, 0)); mk.array(geom, part, size=(5, 5, 1), displ=(10, 10, 0))
+mk.fillet(geom, block, 0.5); mk.chamfer(geom, block, 0.5)   # all edges, or a selection
+mk.partition(geom, part, tool); mk.delete(geom, part)
+plane = mk.workplane(geom, quickz=0)
+mk.circle(plane, 2); mk.extrude(geom, plane, 5); mk.revolve(geom, plane)
+mk.import_(geom, 'part.step')
+mk.feature(geom, 'AnyType', ...)   # any other geometry feature
+```
+
+Selections by location (`mk.sel`), usable in physics, materials and mesh:
+
+```python
+mk.sel.box(geom, 'boundary', z=0)                 # a range per axis, or a value
+mk.sel.ball(geom, 'domain', center, r); mk.sel.cylinder(...); mk.sel.disk(...)
+mk.sel.union(geom, 'boundary', [a, b])            # also intersection, difference, complement
+mk.sel.adjacent(geom, domains)                    # boundaries around a domain selection
+mk.sel.result(geom, feature, 'domain')            # what a feature produced
+holes = mk.sel.cumulative(geom, 'holes', 'domain', create=True)
+mk.cylinder(geom, 1, 5, pos, contributeto=holes)  # collect from several features
+```
+
+`where='geometry'` makes a selection inside the geometry sequence instead,
+for use as input of a later operation, e.g. `mk.sel.box(geom, 'object',
+x=(20, 40), where='geometry')` to pick whole objects for `mk.delete`. In a
+work plane, selections pick single corners or edges:
+`mk.fillet(plane, mk.sel.box(plane, 'point', x=1, y=1), 0.3)`.
+
+Queries return plain Python values and leave nothing in the model:
+
+```python
+mk.sel.entities(geom, bottom)            # [3]
+mk.sel.find(geom, 'domain', x=(0, 10))   # entity numbers inside a box
+mk.measure(geom, 'domain')               # volume (area, length for other levels)
+mk.bounding_box(geom, 'boundary', 3)     # {'x': (0, 10), 'y': ..., 'z': ...}
+```
+
+And a few helpers outside geometry:
+
+```python
+mk.coordinate_system(geom, 'PML', selection=layer)   # e.g. perfectly matched layers
+mk.set(mesh_size, hmax=0.5, hgrad=2)   # any node or Java object; converts ints and lists
+```
+
+Arguments are COMSOL property names, so the COMSOL documentation of each
+feature applies. The docstrings describe each helper in detail.
+
+[`examples/plate_with_holes.py`](https://github.com/elgar328/mphkit/blob/main/examples/plate_with_holes.py)
+is a complete script, from geometry to solved results: heat conduction in
+a plate with a row of cooling holes, for any number of holes.
+
+## Limitations
+
+- mphkit covers geometry and selections only. Physics, mesh, studies and
+  results are left to MPh.
+- No named helpers yet for geometry parts (`PartInstance`), sweeps, cones
+  and the other remaining primitives, virtual operations or repair. They
+  work through `mk.feature(geom, 'Sweep', ...)` with the same conversions
+  and input handling.
+
+## Development
+
+```
+uv run pytest
+```
+
+The tests start COMSOL and build real models. Without a CAD import
+license, the CAD import test is skipped.
+
+## License
+
+MIT, see [LICENSE](https://github.com/elgar328/mphkit/blob/main/LICENSE).

mphkit-0.1.0/pyproject.toml

@@ -0,0 +1,55 @@
+[project]
+name = "mphkit"
+version = "0.1.0"
+description = "Helpers on top of MPh for building COMSOL geometries and geometry-based selections in Python."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = [
+    "comsol",
+    "mph",
+    "multiphysics",
+    "geometry",
+    "selection",
+    "simulation",
+    "fem",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "mph>=1.4",
+    "numpy",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Physics",
+    "Typing :: Typed",
+]
+
+[[project.authors]]
+name = "elgar328"
+
+[project.urls]
+Homepage = "https://github.com/elgar328/mphkit"
+Repository = "https://github.com/elgar328/mphkit"
+Changelog = "https://github.com/elgar328/mphkit/blob/main/CHANGELOG.md"
+Issues = "https://github.com/elgar328/mphkit/issues"
+
+[dependency-groups]
+dev = ["pytest>=8"]
+
+[build-system]
+requires = ["uv_build>=0.9.9,<0.13"]
+build-backend = "uv_build"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

mphkit-0.1.0/pyproject.toml.orig

@@ -0,0 +1,43 @@
+[project]
+name = "mphkit"
+version = "0.1.0"
+description = "Helpers on top of MPh for building COMSOL geometries and geometry-based selections in Python."
+readme = "README.md"
+authors = [{ name = "elgar328" }]
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = ["comsol", "mph", "multiphysics", "geometry", "selection",
+            "simulation", "fem"]
+requires-python = ">=3.10"
+dependencies = ["mph>=1.4", "numpy"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Physics",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://github.com/elgar328/mphkit"
+Repository = "https://github.com/elgar328/mphkit"
+Changelog = "https://github.com/elgar328/mphkit/blob/main/CHANGELOG.md"
+Issues = "https://github.com/elgar328/mphkit/issues"
+
+[dependency-groups]
+dev = ["pytest>=8"]
+
+[build-system]
+requires = ["uv_build>=0.9.9,<0.13"]
+build-backend = "uv_build"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

mphkit-0.1.0/src/mphkit/__init__.py

@@ -0,0 +1,23 @@
+"""Helpers on top of MPh for building COMSOL geometries and selections."""
+
+from . import sel
+from ._measure import bounding_box, measure
+from ._props import set_ as set  # not in __all__: keeps builtin set
+from .errors import LicenseError
+from .geometry import (array, block, chamfer, circle, component_of,
+                       coordinate_system, cylinder, delete, difference,
+                       extrude, feature, fillet, geometry, import_,
+                       intersection, interval, line_segment, mirror, move,
+                       partition, point, polygon, rectangle, revolve,
+                       rigid_transform, rotate, sphere, square, union,
+                       workplane)
+
+__version__ = '0.1.0'
+
+__all__ = ['LicenseError', 'array', 'block', 'bounding_box', 'chamfer',
+           'circle', 'component_of', 'coordinate_system', 'cylinder',
+           'delete', 'difference', 'extrude', 'feature', 'fillet',
+           'geometry', 'import_', 'intersection', 'interval',
+           'line_segment', 'measure', 'mirror', 'move', 'partition', 'point',
+           'polygon', 'rectangle', 'revolve', 'rigid_transform', 'rotate',
+           'sel', 'sphere', 'square', 'union', 'workplane']