Margam¶

Margam is a visual builder for physics-informed neural networks. Connect reusable components to define a problem, train a PINN, inspect results and export predictions.

Quick start¶

Use Python 3.14 and uv. Run commands from the repository root and reuse its single .venv.

For a fresh checkout without an environment:

uv venv --python 3.14 .venv
uv pip install --python .venv/bin/python -e .

Launch Margam:

.venv/bin/python -m margam.ui

See installation help for setup details.

Documentation¶

• Illustrated user manual
• Your first PINN
• Geometry documents with Jorvik
• Technical reference
• Development and experiment commands
• Roadmap and planned work

F1 → User manual opens the locally built guide. Build the manual once to enable it.

Contributing¶

Read the repository instructions and extension guide.

Licence · Third-party attribution