Skip to content

Add the forward simulation API and package checks - #20

Open
peteryu0131 wants to merge 1 commit into
polyfem:mainfrom
peteryu0131:forward-api
Open

peteryu0131 wants to merge 1 commit into
polyfem:mainfrom
peteryu0131:forward-api

Conversation

@peteryu0131

Copy link
Copy Markdown

This PR adds a Python API for building and running forward simulations with PolyFEM.

Changes:

  • Build models with import polyfem and run them with from polyfempy import solve.
  • Add a cantilever beam example, an installation self-check, and static and transient examples.
  • Organize both Python packages under python/.
  • Update installation, API, build, and testing documentation.
  • Add source archive, wheel, and conda package checks.
  • Keep regular push checks separate from native builds and full simulation tests.

Validation completed:

  • Local forward tests: 277 passed, 2 skipped.
  • Generator tests: all 122 passed.
  • Local type checks, Ruff, documentation checks, and workflow syntax checks passed.
  • Source archive and wheel contents were checked.
  • Windows CPython 3.11 installation and example checks passed using previously verified native binaries.
  • These checks included the README beam, installation self-check, Python load callback, six cube reference metrics, and three quick-start examples.

Validation still pending:

  • A fresh native build of this exact revision.
  • Full native package installation checks on Linux, Intel Mac, and Apple Silicon Mac.
  • Native conda package validation across the target platforms.
  • Native package checks for Python 3.10 and 3.12.
  • The full contact simulation suite for this revision.

Prepare the forward simulation API for upstream review.

Includes model building, solver runtime, examples, documentation, packaging, and CI checks. Preserve the exact file tree and pinned submodules from jingyaoyu_forward at 4440efc.

Base this review commit on official main at 4f15f37 because the fork's older history has different commit IDs after signature removal. The original development branch and history remain unchanged.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant