Developer Documentation#

Developer Documentation#

Technical documentation for developers working on pychum.

Architecture#

Document

Description

Input Generation

How pychum generates input files

Template System

Jinja2 template rendering

ORCA Blocks

ORCA input block system

Patterns#

Pattern

Description

Lazy Imports

Defer optional dependency loading

Dataclasses

Data structure definitions

Validators

Input validation patterns

Contributing#

Quick Start for Developers#

Setup**#

git clone https://github.com/HaoZeke/pychum
cd pychum
uv sync --all-extras

Run Tests**#

uv run pytest

Add New Engine**#

  1. Create pychum/engine/<code>/ directory

  2. Add _dataclasses.py, _renderer.py

  3. Add to pychum/engine/_init\_.py

  4. Add tests in tests/engine/<code>/

See Input Generation for details.