Skip to content

Developer Guide

This guide covers repository development, parser architecture, validation, testing, documentation, and release preparation.

Start here

  • Architecture explains the shared parsing pipeline and the two public data models.
  • Contributing defines the development environment and pull-request expectations.
  • Writing Parsers describes how to add or extend MSH section support.
  • Parser Internals lists the parser classes and version registries.
  • Testing documents the test layout and required checks.
  • Performance Benchmarks explains the reproducible benchmark suite.
  • Test Results points to CI and coverage as the authoritative status.

Local validation

uv sync
uv run ruff format --check gmshparser tests examples benchmarks
uv run ruff check gmshparser tests examples benchmarks
uv run mypy gmshparser
uv run mypy --strict tests/typing/public_api.py
uv run pytest
uv sync --group docs
uv run mkdocs build --strict
uv build --no-sources

A change to parser behavior should normally include a focused fixture, tests for both gmshparser.parse() and gmshparser.read(), and corresponding user/API documentation.