# femforge

> Typed finite-element orchestration in Python: a tagged STEP file in, typed results out, with gmsh and Elmer as the first backends.

femforge drives finite-element analysis from Python. One typed SimulationConfig takes a tagged STEP file through meshing and a solve to a typed, provenance-tracked Result; gmsh and Elmer are the backends implemented today.

## Overview

- [femforge](<https://docs.femforge.io/index.md>)
- [Compatibility](<https://docs.femforge.io/overview/compatibility/index.md>)
- [Concepts](<https://docs.femforge.io/overview/concepts/index.md>)
- [Install](<https://docs.femforge.io/overview/install/index.md>)
- [Quickstart](<https://docs.femforge.io/overview/quickstart/index.md>)

## User guide

- [Artifacts and retention](<https://docs.femforge.io/user-guide/artifacts/index.md>)
- [CLI](<https://docs.femforge.io/user-guide/cli/index.md>)
- [Conditions and physics](<https://docs.femforge.io/user-guide/conditions/index.md>)
- [Driver and runs](<https://docs.femforge.io/user-guide/driver/index.md>)
- [Elmer: native and Docker](<https://docs.femforge.io/user-guide/elmer/index.md>)
- [Frames](<https://docs.femforge.io/user-guide/frames/index.md>)
- [Geometry and tags](<https://docs.femforge.io/user-guide/geometry/index.md>)
- [User guide](<https://docs.femforge.io/user-guide/index.md>)
- [Materials](<https://docs.femforge.io/user-guide/materials/index.md>)
- [Mesh](<https://docs.femforge.io/user-guide/mesh/index.md>)
- [Optimization](<https://docs.femforge.io/user-guide/optimization/index.md>)
- [Results](<https://docs.femforge.io/user-guide/results/index.md>)
- [Telemetry](<https://docs.femforge.io/user-guide/telemetry/index.md>)
- [Workbench](<https://docs.femforge.io/user-guide/workbench/index.md>)

## API reference

- [Artifacts](<https://docs.femforge.io/reference/artifacts/index.md>)
- [Common](<https://docs.femforge.io/reference/common/index.md>)
- [Config](<https://docs.femforge.io/reference/config/index.md>)
- [Elmer solvers](<https://docs.femforge.io/reference/elmer-config/index.md>)
- [Elmer](<https://docs.femforge.io/reference/elmer/index.md>)
- [Docker images](<https://docs.femforge.io/reference/execution/index.md>)
- [Geometry](<https://docs.femforge.io/reference/geometry/index.md>)
- [API reference](<https://docs.femforge.io/reference/index.md>)
- [Materials](<https://docs.femforge.io/reference/materials/index.md>)
- [Meshing](<https://docs.femforge.io/reference/meshing/index.md>)
- [Optimize](<https://docs.femforge.io/reference/optimize/index.md>)
- [Physical](<https://docs.femforge.io/reference/physical/index.md>)
- [Run](<https://docs.femforge.io/reference/run/index.md>)
- [JSON schemas](<https://docs.femforge.io/reference/schemas/index.md>)
- [Telemetry](<https://docs.femforge.io/reference/telemetry/index.md>)
- [Validation](<https://docs.femforge.io/reference/validation/index.md>)
- [Viz](<https://docs.femforge.io/reference/viz/index.md>)
- [Dock](<https://docs.femforge.io/reference/workbench/dock/index.md>)
- [Panels](<https://docs.femforge.io/reference/workbench/panels/index.md>)
- [Registry](<https://docs.femforge.io/reference/workbench/registry/index.md>)
- [Serve](<https://docs.femforge.io/reference/workbench/serve/index.md>)
- [Theme](<https://docs.femforge.io/reference/workbench/theme/index.md>)
- [Widgets](<https://docs.femforge.io/reference/workbench/widgets/index.md>)

## Contributing

- [Artifacts and retention](<https://docs.femforge.io/contributing/architecture/artifacts/index.md>)
- [Config objects](<https://docs.femforge.io/contributing/architecture/config-objects/index.md>)
- [Solver objects](<https://docs.femforge.io/contributing/architecture/solver-objects/index.md>)
- [Telemetry](<https://docs.femforge.io/contributing/architecture/telemetry/index.md>)
- [Workbench client](<https://docs.femforge.io/contributing/architecture/workbench/index.md>)
- [Setup](<https://docs.femforge.io/contributing/index.md>)
- [Invariants](<https://docs.femforge.io/contributing/invariants/index.md>)
- [Principles](<https://docs.femforge.io/contributing/principles/index.md>)
- [Release process](<https://docs.femforge.io/contributing/release/index.md>)
- [Testing and gates](<https://docs.femforge.io/contributing/testing/index.md>)
- [Tooling](<https://docs.femforge.io/contributing/tooling/index.md>)