Skip to main content

pyofel

Python bindings for Ofel, via pythonnet and the Ofel.PythonInterop project. Lets Python/ML code build and solve Ofel finite-element structures without hand-rolling the CoreCLR bootstrap.

Setup

Installing the prebuilt package (Windows)

pip install pyofel

No .NET SDK or runtime is required — the published Windows wheel bundles a private copy of the .NET 9 runtime alongside the published Ofel.PythonInterop output, so pip install pyofel is the entire setup.

Building from source (contributors / non-Windows)

  • Python >= 3.10
  • .NET 9 SDK — required locally to build/install this package this way.

Clone with submodules (this repo vendors a pinned copy of ofel at vendor/ofel to build Ofel.PythonInterop against):

git clone --recurse-submodules https://github.com/se-benjamin-carron/pyofel
cd pyofel

If you already cloned without --recurse-submodules:

git submodule update --init --recursive

Install (this runs a build hook that dotnet publishs vendor/ofel/src/Ofel.PythonInterop and stages the output into pyofel/_interop/):

pip install -e .[dev]

Run the tests:

pytest

To reproduce the prebuilt-wheel build locally (Windows only), fetch a win-x64 .NET 9 runtime-only install and point PYOFEL_BUNDLE_RUNTIME_DIR at it before building:

PYOFEL_BUNDLE_RUNTIME_DIR=/path/to/dotnet-runtime-win-x64 python -m build --wheel

This bundles that runtime into the wheel and tags it as a platform-specific win_amd64 wheel instead of pure Python — see .github/workflows/release.yml for the exact CI sequence that fetches the runtime and builds/validates this.

Usage

from pyofel.data.catalog import get_steel_material, get_steel_section
from pyofel.finite_element import FiniteElementStructure, Point, PointMemberData
from pyofel.member_builder import MemberBuilder

section = get_steel_section("HEA", "HEA200")
material = get_steel_material("S235", "NF EN 10025-2")

builder = MemberBuilder()
column = builder.new_member("Column")
builder.set_points(column, [PointMemberData(0.0, Point(0, 0, 0), section), PointMemberData(1.0, Point(0, 0, 3), section)], material)
builder.set_default_fixed_epsilons(column)
builder.add_fixed_support(column, 0.0)

structure, fe_members = FiniteElementStructure.solve([column])

pyofel.member_builder.MemberBuilder is the Pythonic, snake_case mirror of Ofel.Core.MemberDirector - build a Member by hand (points, supports, forces, characteristics), then solve it with FiniteElementStructure.solve(). See pyofel/tools/debug_portal_frame.py for a fuller example (a 2-column + 1-beam portal frame, verified and auto-sized).

pyofel.evaluation wraps the higher-level Ofel.API.Services.StructureEvaluationService pipeline (full building input -> climatic loads -> FEM -> Eurocode 3 steel verification); pyofel.fixtures has ready-made example inputs, and pyofel.governing picks out the one ULS/SLS result that actually matters:

from pyofel.evaluation import evaluate
from pyofel.fixtures import create_building2s1_example_input
from pyofel.governing import uls_ratios

structure_input = create_building2s1_example_input()
members, structure = evaluate(structure_input)
ratios = uls_ratios(members)

create_building2s1_example_input is a direct port of vendor/ofel's Ofel.API.Tests UIFixtures.CreateBuilding2S1Input() fixture, building a full StructureEvaluationInputUI (wind/snow loads, roofing plates/purlins, a Building2S1 gantry, project settings) from the granular Ofel.Contracts.UI input objects. Broader wrapper coverage around other gantry types (Building1, Butterfly, DoubleCanopy, SimpleCanopy) is follow-up work.

pyofel.tools.debug_portal_frame hand-builds a 2-column + 1-beam portal frame directly via MemberBuilder - for cases (like an arbitrary extra point load at one position) the GUI-level pipeline above has no input for.

Updating the pinned ofel version

cd vendor/ofel
git fetch --tags
git checkout <new-tag-or-commit>
cd ../..
git add vendor/ofel
git commit -m "chore: bump vendor/ofel to <new-tag-or-commit>"

Metadata

Release files for pyofel 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for pyofel 0.2.2
File Interpreter ABI Platform
pyofel-0.2.2-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details

Release files / pyofel-0.2.2-py3-none-win_amd64.whl

Download URL pyofel-0.2.2-py3-none-win_amd64.whl
Size 53.3 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
401cf4a288b2899ef8d88e7ffdd545ddd4e87de5b465de6f502b28e466b6aa2b
BLAKE2b-256 checksum
How to use checksums
1a9c0f110624b10d6d0831fac4e1f08fc9c2a370bd7b3c44a569fd84656c1d59
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.

Transparency log

Release history Release notifications | RSS feed

0.2.5

1 release file

0.2.4

1 release file

0.2.3

1 release file

This release

0.2.2 This release

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page