kindred/create
1
1
Fork 0
Code Issues 53 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

docs: write SOLVER.md — OndselSolver location, Lagrangian formulation, and future GNN plans #100

New Issue
Closed
opened 2026-02-09 13:45:26 +00:00 by forbes · 1 comment
forbes commented 2026-02-09 13:45:26 +00:00
Owner
Copy Link

Tier 4 — Reference

File: docs/SOLVER.md

What this document should cover

  1. What is OndselSolver — assembly constraint solver used by FreeCAD's Assembly workbench

    • Location: src/3rdParty/OndselSolver/ (git submodule)
    • Source: git.kindred-systems.com/kindred/solver (Kindred fork)
    • Pinned commit: fe41fa3

  2. Solver fundamentals:

    • Lagrangian constraint formulation
    • How it resolves assembly constraints (mates, joints)
    • Integration with FreeCAD's Assembly workbench (src/Mod/Assembly/)

  3. Kindred fork status:

    • Why it's forked (pinned stability, potential modifications)
    • Relationship to upstream Ondsel solver
    • Any Kindred-specific patches

  4. Future plans — GNN (Graph Neural Network) solver:

    • Vision for ML-based constraint solving
    • How it would complement or replace Lagrangian approach
    • Current status (planned, not implemented)

  5. Related: GSL submodule:

    • src/3rdParty/GSL/ — Microsoft Guidelines Support Library
    • github.com/microsoft/GSL, pinned to 756c91a
    • Used for C++ core guidelines support (gsl::span, gsl::not_null, etc.)

Key source files

  • src/3rdParty/OndselSolver/ — solver submodule
  • src/3rdParty/GSL/ — GSL submodule
  • src/Mod/Assembly/ — Assembly workbench that uses the solver

Acceptance criteria

  • Solver location and fork status are documented
  • Lagrangian formulation is summarized at an appropriate level
  • Future GNN plans are mentioned with current status
  • GSL submodule is briefly documented
## Tier 4 — Reference **File:** `docs/SOLVER.md` ### What this document should cover 1. **What is OndselSolver** — assembly constraint solver used by FreeCAD's Assembly workbench - Location: `src/3rdParty/OndselSolver/` (git submodule) - Source: `git.kindred-systems.com/kindred/solver` (Kindred fork) - Pinned commit: `fe41fa3` 2. **Solver fundamentals:** - Lagrangian constraint formulation - How it resolves assembly constraints (mates, joints) - Integration with FreeCAD's Assembly workbench (`src/Mod/Assembly/`) 3. **Kindred fork status:** - Why it's forked (pinned stability, potential modifications) - Relationship to upstream Ondsel solver - Any Kindred-specific patches 4. **Future plans — GNN (Graph Neural Network) solver:** - Vision for ML-based constraint solving - How it would complement or replace Lagrangian approach - Current status (planned, not implemented) 5. **Related: GSL submodule:** - `src/3rdParty/GSL/` — Microsoft Guidelines Support Library - `github.com/microsoft/GSL`, pinned to `756c91a` - Used for C++ core guidelines support (`gsl::span`, `gsl::not_null`, etc.) ### Key source files - `src/3rdParty/OndselSolver/` — solver submodule - `src/3rdParty/GSL/` — GSL submodule - `src/Mod/Assembly/` — Assembly workbench that uses the solver ### Acceptance criteria - [ ] Solver location and fork status are documented - [ ] Lagrangian formulation is summarized at an appropriate level - [ ] Future GNN plans are mentioned with current status - [ ] GSL submodule is briefly documented
forbes added the documentation label 2026-02-09 13:45:26 +00:00
forbes commented 2026-02-09 14:13:54 +00:00
Author
Owner
Copy Link

Superseded by the mdBook documentation structure set up in PR #105. The content scope of this issue is now covered by the pages in docs/src/. Remaining content work is tracked in #104.

Superseded by the mdBook documentation structure set up in PR #105. The content scope of this issue is now covered by the pages in `docs/src/`. Remaining content work is tracked in #104.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
UX
branding
bug
ci/cd
CI/CD workflows and deployment
 defaults
documentation
Developer documentation
 enhancement
high-priority
low-priority
theme
No Label documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
forbes
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: kindred/create#100
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?