Skip to main content

Infrastructure for safely using OpenMC with LLMs: plan, build, validate, run, analyze

Project description

PromptMC logo

PromptMC

PyPI Python Coverage CI Ruff Checked with mypy License

OpenMC is powerful but can be painful to use: you hand-write XML, manage batch runs, and read results out of HDF5. It would be great if we could safely use AI to reduce that friction.

PromptMC does that by providing infrastructure and tooling that allows both AI LLM assistants and humans to interact with OpenMC through typed, schema-driven workflows.

It works like a grammar checker between an AI LLM assistant and OpenMC: your AI proposes a configuration, PromptMC validates XML structure and supported schema constraints before the simulator runs, and catches malformed inputs early.

Because AI hallucination is a valid concern in reactor physics, the system is designed with deterministic blast walls. Every configuration (from a human, the deterministic local planner, or AI) is validated against the same typed Pydantic schemas before it reaches the simulator.

What you can do

Most planning and schema-validation workflows work without OpenMC installed; execution, geometry-debug checks, and 2D plot rendering require OpenMC.

Without OpenMC installed:

  • Describe a simulation → a validated plan and settings.xml (the default planner is keyword-based and uses no generative AI)
  • Validate XML structure and PromptMC's supported OpenMC schemas
  • Drive planning and schema validation from an AI client via the MCP server

With OpenMC installed:

  • Run simulations (subprocess or Python API)
  • Run geometry-debug overlap checks and generate 2D slice plots inside your AI chat client
  • Parse statepoint and tally outputs without touching HDF5

Installation

Prerequisites:

  • Python 3.10 or higher (note: macOS's bundled Python is 3.9 — uv below sidesteps this by fetching its own)

PromptMC — quickest as an isolated CLI install via uv or pipx:

uv tool install promptmc          # or: pipx install promptmc

Or with pip into an existing environment:

pip install promptmc              # core (includes CLI, MCP server, and Gemini planner)
pip install 'promptmc[telemetry]' # + OpenTelemetry tracing

Plot rendering and geometry-debug import OpenMC's Python API, so for those install PromptMC with pip into the same environment as OpenMC (e.g. your conda env). Everything else — planning, validation, MCP server, and simulation runs via the openmc executable — works from an isolated install.

OpenMC (required for simulation execution, geometry-debug checks, and plot rendering) can be installed via Conda, Spack, Docker, or build from source per docs.openmc.org. Planning and XML/schema validation work without it.

Cross-section data (for running simulations):

pip install openmc-data-downloader
openmc_data_downloader -l TENDL-2019 -i U235 U238 O16 H1 -d cross_sections
export OPENMC_CROSS_SECTIONS=$(pwd)/cross_sections/cross_sections.xml

See installation for more details.

MCP server

PromptMC exposes a Model Context Protocol server so AI assistants can run OpenMC workflows natively — validation, plotting, execution, and result parsing from inside your LLM chat client, such as Claude Desktop, Cursor, and Google Antigravity.

Tools: openmc_validate, openmc_schema_check, openmc_template, openmc_list_templates, openmc_run, openmc_analyze, openmc_plot (2D slice, returned to the chat client), openmc_geometry_debug, openmc_check_installation, openmc_check_cross_sections.

Resources expose the configured cross-sections path, the session's tool-call history, and the bundled examples.

Setup: see the MCP server configuration guide for per-client steps (Claude Desktop/Code, Cursor, Google Antigravity, VS Code).

CLI

By default, plan uses a deterministic local planner, needing no API key, no network, no generative AI. The optional --llm flag calls Google Gemini (set GEMINI_API_KEY), which can interpret more open-ended natural-language requests. Customize the model name with GEMINI_MODEL (defaults to gemini-3.5-flash).

promptmc plan --llm "concrete shielding calculation with 1 million particles"
promptmc plan "pin cell criticality with 50k particles" --write
promptmc template criticality --particles 10000                 # generate settings.xml
promptmc validate input.xml --schema
promptmc run input.xml --threads 4                              # needs OpenMC
promptmc batch batch_spec.yaml --parallel threads --workers 4
promptmc analyze ./output --json results.json
promptmc info                                                   # environment status

Full options in the CLI reference.

Safety

PromptMC is an engineering-assist tool that keeps a human in the loop. It is not a substitute for professional engineering judgment, independent verification and validation, or regulatory review, and is not for safety, licensing, or other regulated decisions. Reproducing a published benchmark is not qualification for safety analysis. Provided as-is (see LICENSE).

The goal is not autonomous reactor design; the goal is safer, faster OpenMC iteration.

Documentation

About

I studied nuclear engineering at MIT over 20 years ago, running MCNP 4 for my senior thesis. Though I left during my senior year, I eventually went back to university to get a degree in Computer Science, and I have spent the last 11 years working as a software engineer and site reliability engineer at a major FAANG cloud provider.

PromptMC bridges those two worlds. It is also, for me, an exploration of using agentic programming to build software for fun but still holding professional production principles and standards.

Contributions and Support

I welcome contributions! Please ensure all checks pass (pytest, ruff check, mypy src/) before opening a PR.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

promptmc-0.3.2.tar.gz (59.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

promptmc-0.3.2-py3-none-any.whl (71.6 kB view details)

Uploaded Python 3

File details

Details for the file promptmc-0.3.2.tar.gz.

File metadata

  • Download URL: promptmc-0.3.2.tar.gz
  • Upload date:
  • Size: 59.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for promptmc-0.3.2.tar.gz
Algorithm Hash digest
SHA256 e66d527529ec0e6746c13a91015df8df21e0a619a4094a29b135d069cfa59506
MD5 5a66b48814f0d7544594f9b55902bab2
BLAKE2b-256 3f7204a13afa8e5d3144dcd85c9e9efd92897de475efaf8e5a2354a9f65a49d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for promptmc-0.3.2.tar.gz:

Publisher: publish.yml on rjonace/promptmc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file promptmc-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: promptmc-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 71.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for promptmc-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 497cf144876aa2b2459f4ea0ed965c9cb5aa3a23e76b057ffb880cb9e24d0a30
MD5 cf514972721b47feddd9fc37fadc74e4
BLAKE2b-256 bbaa1f662ab0dfdaf19c608fe3711c16a0b5be58bd0bfc4ebcf4c7f368dba1c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for promptmc-0.3.2-py3-none-any.whl:

Publisher: publish.yml on rjonace/promptmc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page