Skip to content

Installation

xdfem2D targets Python 3.12+ and uses uv for dependency management.

Runtime dependencies

  • matplotlib — canvas rendering and PDF export
  • numpy — analysis core
  • pyside6 — desktop interface
  • openpyxl — Excel results export
  • eurocodepy — Eurocode materials and design checks (concrete, steel, timber), EC0 combinations; required

Install with uv

# from the project root
uv sync

This creates a virtual environment and installs everything in pyproject.toml.

Run the application

uv run xdfem2d
# or
uv run python -m xdfem2d.xdfem2d_gui

Building the documentation

The documentation is written for MkDocs with the Material theme.

# install the docs toolchain (one-off)
uv pip install mkdocs mkdocs-material

# live preview at http://127.0.0.1:8000
uv run mkdocs serve

# build a static site into ./site
uv run mkdocs build

Once built, the in-app Help → Documentation (or F1) opens the local site/index.html.