PyMeshIt documentation

PyMeshIt provides GUI-driven and headless Python workflows for creating conforming surface meshes and tetrahedral volume meshes from geological surfaces, faults, boundaries, and wells.

The headless API runs the meshing workflow without opening the GUI. It is designed for automated geometry studies, parameter sweeps, simulation setup, and Exodus export.

API status

The headless API is experimental in the 0.8 release series. Pin the PyMeshIt version used for production studies and review the release notes before upgrading.

Start here

• Follow the installation guide.

• Run the surface-meshing quickstart.

• Work through the complete batch-workflow notebook.

• Read the batch and POD guidance before comparing results from varying geometries.

• Consult the headless API reference for exact signatures and defaults.

Getting started

• Installation
  • Python package
  • Linux system libraries
  • Development installation
• Headless quickstart
  • Loading points from a file
  • Moving to a volume case

User guide

• Input data
  • Arrays
  • Text and CSV files
  • VTK-family files
  • Surface point ordering
  • Validation recommendations
• Surfaces, wells, and materials
  • Surface roles
  • Material seeds
  • Wells
  • Watertight volume requirements
• Meshing options
  • Constraint modes
  • Choosing target sizes
  • TetGen switches
• Understanding results
  • Final volume mesh
  • Conforming surface data
  • Intersections and triple points
  • Intermediate datasets
• Mesh and Exodus export
  • Exodus entities
  • Custom names
  • Verify an export
• Batch processing and POD studies
  • Node correspondence
  • Reproducibility checklist
• Troubleshooting
  • Import or display errors on Linux
  • A volume mesh is not generated
  • Insufficient constraints
  • Different node counts in batch cases
  • Reporting a problem

Tutorials

• PyMeshIt Headless Batch Workflow

Reference

• Headless API reference
  • Input specifications
  • Meshing options
  • Workflow functions
  • Results and export

Project links

• Source code

• PyPI package

• Issue tracker

• Download the original batch-workflow notebook