meshRW documentation

meshRW provides lightweight mesh readers and writers focused on:

• Legacy Gmsh MSH (reader + writer)

• VTK legacy files and VTK XML (.vtu + .pvd) writers

• Static and transient nodal/elemental field export

Why meshRW

meshRW is designed for workflows where you need transparent file-level control over mesh and field exports without bringing a full simulation framework.

Documentation map

• Getting Started: installation and first examples.

• API Overview: main modules and responsibilities.

• Format Support: supported formats and limitations.

• Development: local quality checks, tests, and doc build.

Contents

• Getting started
  • Install
  • Read a MSH file
  • Write a legacy MSH file
  • Write VTU/PVD time series
• API overview
  • Core modules
  • Shared infrastructure
  • Data model expectations
  • Error handling
• Format support
  • Gmsh (.msh)
  • VTK (.vtk, .vtu, .pvd)
  • Known constraints
• Development
  • Local setup
  • Run tests
  • Lint
  • Build docs
  • Build package
  • CI workflows

Project links

• Repository: https://github.com/luclaurent/meshRW

• Package: https://pypi.org/project/meshrw/

• Issues: https://github.com/luclaurent/meshRW/issues