Next Gen STEP AP242 Native-ish BREP Geometric Modeling Kernel
Canonical Firmament V2 cookbook
Everything in this directory is current authoring guidance. Examples progress from small syntax landmarks through focused operations to practical integrations. Semicolons are optional where line/block structure is unambiguous; use them when they make dense declarations clearer.
| I want to… | Start here | Main concepts |
|---|---|---|
| learn the language step by step | Learn/01-plate.firmament … 06-post-on-plate.firmament |
the lessons |
| create a box | Basics/box.firmament |
Model, Units, named Box, Assert |
| create a cylinder | Basics/cylinder.firmament |
direct Cylinder |
| create analytic primitives | Primitives/ |
Frustum, RoundedBox, Sphere, Cone, Torus |
| draw a readable local profile | Profiles/concept-path-line-arc-profile.firmament |
Path, line, arc, closed profile, extrusion |
| derive a semantic profile variant | Profiles/profile-delta-recess-extrusion.firmament |
Table, with, Template, ProfileDelta, ordinary extrusion |
| add a rectangular boss | Features/Boss/rectangular-boss.firmament |
first-class finite Boss |
| sweep a circular profile | Features/Sweep/circular-planar-path-sweep.firmament |
bounded planar Path, line/arc, constant circular Sweep |
| make wire geometry | Features/Sweep/ |
tangent open paths, analytic cylinders/tori, capped solid |
| author formed wire or rod | WireForm/ |
stock, StartFrame, ordered Straight/Bend, 3D frame transport, derived cut length |
| add a boss and bore | Features/Boss/circular-boss-through-hole.firmament |
circular Boss, through shaft Hole |
| machine a finite pocket | Features/Pocket/rectangular-pocket.firmament |
finite depth and minimum floor |
| make a through or blind hole | Features/Holes/through-hole.firmament, blind-hole.firmament |
shaft end conditions |
| add a counterbore or countersink | Features/Holes/counterbore.firmament, countersink.firmament |
public hole variants |
| cut a slot/opening | Features/Slots/straight-slot.firmament |
capsule slot, through opening |
| chamfer or fillet an edge | Features/EdgeFinish/ |
current EdgeFinish vocabulary |
| repeat features from data | Patterns/record-array-hole-pattern.firmament |
Record array, finite Pattern |
| add semantic PMI | PMI/multiple-hole-dimensions-with-chamfer.firmament |
Datum, tolerances, DatumRefs |
| use a typed product Template | Templates/generic-mounting-plate.firmament |
value parameters, Require, Concept Struct output |
| build a Paperclip Template | Templates/paperclip.firmament |
Record, Static, with, Template<PaperclipPolicy>, semantic WireForm |
| use a CNC policy | Templates/cnc-dfm-policy.firmament |
Record defaults, with, Template<Policy>, enforcement |
| make Sheet Metal | SheetMetal/l-bracket-with-hole.firmament |
material, bend, planar hole, formed/flat output |
| define a molded plastic shell | PlasticShell/plastic-shell-enclosure.firmament |
inherent wall policy, tooling direction, parting plane, gate, standoffs, ejectors, AutoRib judgment |
| apply a bounded mathematical sculpt | Sculpting/sculpted-housing.firmament |
immutable BodyState, OffsetRegion, locality, preservation contracts |
| replace a housing region with a freeform patch | Sculpting/surf-x1-freeform-housing.firmament |
direct non-rational 6x6 B-spline patch, ReplaceRegion, explicit boundary correspondence, mixed G0/G1, downstream current-state hole |
| trim a freeform replacement around preserved openings | Sculpting/surf-x1a-trimmed-freeform-housing.firmament |
derived Plane/B-spline outer trims, four circular inner loops, face-local pcurves, PMI/interface associations, rational-free AP242 |
| make a data-driven Sheet Metal tab | SheetMetal/profile-delta-tab-family.firmament |
Table, with, reusable ProfileDelta Tab |
| run FEA | FEA/cantilever.firmament |
material, Fixed, Force, four result families |
| analyze imported STEP | FEA/inline-step-cantilever.firmament |
repository-stable inlineSTEP, face selection, FEA |
| author an assembly | Assembly/bearing-module.firmament |
Interface, Mate, nested identity, tolerance stack |
| route a piping system | Piping/pump-skid.firmament |
logical Connection, equipment-owned nozzle Interfaces/mates, scoped owner exemption, explicit/accepted Routes, strict foreign KeepOut clearance, fittings, BOM/Cut List |
| combine machining operations | Integration/machined-mounting-block.firmament |
Boss, Pocket, holes, counterbores, chamfer, PMI |
Pocket never means through-all; use a supported Hole or Slot for through removal. Bounded two-section Loft and Loft<Hollow>, WireForm Helix, and the explicitly bounded freeform replacement examples above are admitted. Check the current supported-feature boundaries before extending a recipe.
Current style and qualification levels
Built-in fields use camelCase and linking words use lowercase. Path and 2D
shape declarations need no Concept prefix. Requirement Concepts and
Concept Struct construction layouts keep their distinct roles. Published
Record members, Template arguments, semantic ports and occurrence names preserve
their identities; a style pass does not rename a library API.
Sheet-metal blanks and rectangular openings use named shared Profile/Rect2
boundaries. The migrated legacy sheet Slot cuts remain rectangular; making them
rounded would be an engineering change. Slot2 means an overall-length capsule.
Not every file is a standalone STEP product. qualification.json declares the
real owner operation and names a consuming product for reusable modules.
Gear-interface examples qualify inspection, garment examples qualify their
documented validation level, and scenes qualify scene compilation. Four
figure-bound garment sources explicitly expect the missing-external-body
diagnostic; those are recorded as boundaries, not successful products. A module's
consumer must itself pass. Geometry regressions and compatibility witnesses live
outside this cookbook. In particular, SurfaceCoil centerline-only witnesses are
under Regression/WireFormSurfaceSupport, pending normal support admission.
Ownership
| Area | Primary test owner |
|---|---|
| Basics, Primitives, Profiles, Features, Patterns, Templates | Aetheris.Kernel.Firmament.Tests |
| PMI and STEP round-trip | Aetheris.CLI.Tests and Aetheris.Kernel.Firmament.Tests |
| Sheet Metal | Aetheris.SheetMetal.Tests |
| Sculpting | Aetheris.Modules.Tests and Aetheris.CLI.Tests |
| FEA and Materials | Aetheris.FEA.Tests |
| Assembly | Aetheris.Kernel.Firmament.Tests assembly suite |
| Piping | PipingX3Tests, PipingAstAdmissionTests, PipingAdmissionCliTests (shared AST fields, compatibility and validate/build agreement) |
| Drawings | Aetheris.CLI.Tests drawing suite |
The compact action map is qualification.json; coverage.json is the public-operation guard. Generated outputs go to artifacts/local/, never beside these sources.