describesfem

Describesfem is a software toolkit that automates the generation of natural-language descriptions for finite element method (FEM) simulations. It aims to bridge the gap between technical FEM models and readable documentation by converting model specifications, solver settings, mesh information, material properties, boundary conditions, and results into coherent text.

The system ingests data from common FEM workflows, including mesh topology, element types, material models, boundary and initial conditions, load cases, solver parameters, and post-processing results such as stress and displacement fields. Through a combination of templated templates and lightweight natural-language generation, describesfem assembles narrative descriptions suitable for reports, project briefs, or onboarding materials. Outputs can include plain text narratives, structured summaries, and supporting tables or figures.

Implementation emphasizes modularity and interoperability. The toolkit is typically implemented in a high-level language such as Python and provides adapters to export to document formats (Markdown, HTML, PDF) and to integrate with prevalent FEM platforms. Users can customize templates to match organization style guides and adjust the level of technical detail for different audiences.

Applications include technical documentation, educational materials for students learning FEM, and client-facing project reports. The approach is intended to supplement, not replace, numerical results, with explicit notes on assumptions, limitations, and prerequisites.

Describesfem is open to community input, with development hosted in a public repository and governed by a contributor license agreement to encourage reproducibility and transparency.