gnikit / pymmg Goto Github PK

10.0 2.0 0.0 80 KB

MMG Remeshing tools wrapped in Python

CMake 24.10% Python 75.90%

anisotropic-mesh-adaptation isotropic-mesh-adaptation levelset-discretization mesh-adaptation mesh-quality-improvement meshing mmg remeshing surface-improvement tetrahedral-meshing

pymmg's Introduction

pymmg - Surface and volume remeshers

Bringing MMG surface and volume remeshers to Python. This package is a wrapper around the MMG tools

Features

Surface remeshing
Volume remeshing
Area remeshing
Adaptive mesh refinement
Load multiple file formats using meshio

Abaqus (.inp), ANSYS msh (.msh), AVS-UCD (.avs), CGNS (.cgns), DOLFIN XML (.xml), Exodus (.e, .exo), FLAC3D (.f3grid), H5M (.h5m), Kratos/MDPA (.mdpa), Medit (.mesh, .meshb), MED/Salome (.med), Nastran (bulk data, .bdf, .fem, .nas), Netgen (.vol, .vol.gz), Neuroglancer precomputed format, Gmsh (format versions 2.2, 4.0, and 4.1, .msh), OBJ (.obj), OFF (.off), PERMAS (.post, .post.gz, .dato, .dato.gz), PLY (.ply), STL (.stl), Tecplot .dat, TetGen .node/.ele, SVG (2D output only) (.svg), SU2 (.su2), UGRID (.ugrid), VTK (.vtk), VTU (.vtu), WKT (TIN) (.wkt), XDMF (.xdmf, .xmf).

Installation

pip install pymmg

NOTE: you can use the full-blown pymmg converter with netcdf4 and h5py by doing: pip install pymmg[all]

Usage

Surface remeshing

mmgs input.mesh output.mesh

Volume remeshing

mmg3d input.mesh output.mesh

2D remeshing

mmg2d input.mesh output.mesh

pymmg's People

Contributors

Stargazers

Watchers

pymmg's Issues

feat: package libmmg and header files

It would be great if the libmmg* libraries and the C++ and Fortran header files were also packaged with the extension.

Create documentation webpage

I should create a documentation webpage + some realistic examples of the package and usage with other common packages like trimesh, gmsh, etc.

docs: update setup.py and README

Update setup.py with correct names, classifiers, etc.
Also create a README.

feat: add ParMMG as optional dep

It would be great if we could include ParMMG as part of this package.

feat: generate bindings and fully integrate with meshio

It would be great if bindings were automatically generated and data exchange was possible natively in Python with meshio.

build: fetch scotch & VTK

download and install scotch when doing an SKBUILD.
Maybe fetch VTK as a build dependency in pyproject.toml?

Is a way to remesh with mmgs in python as functions?

and not console util.

for example:

import mmgs
mesh_out = mmgs.func(mesh_in, hausd=0.001)

feat: use binary MEDIT for temporary file

Currently we use the ascii version of the MEDIT file format (.mesh) while doing a file conversion. The reason being that somewhere in the conversion process, either meshio or mmg are not able to read meshb. Investigate this issue further and fix.

build: add option to set tag at config time

Use a cmake option to pull a specific tag from mmg.
This tag should then be overwritten by the GitHub release event to create the wheels.

Also I need to setup the pypi wheels upload.

feat: allow multiple file formats for input/output

We can use meshio to handle and natively convert between multiple file formats.
The main issue I see is handling all CLI options e.g.

mmgs filename.ext produces filename.o.ext
mmgs -in filename.ext, produces filename.o.ext
mmgs filename.ext output.ext
mmgs filename.ext -out output.ext
mmgs -in filename.ext -out output.ext

The other thing that needs to be decided is whether the VTK and Gmsh file-formats will be natively supported or we will be converting them to meshb (binary medit) with meshio.

For VTK I am in favour of native support (since we will be compiling and linking to libVTK) but for Gmsh I think it would be better if we used meshio. What we might be missing is passing custom fields as metadata in the Gmsh file format.