Skip to content

Next Gen STEP AP242 Native-ish BREP Geometric Modeling Kernel

M00 scaffold kernel projects docs and CI baseline

Yuechen Li5a379bea3929
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 00000000..8447cb8a
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,14 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{cs,csproj,sln,slnx,md,yml,yaml,json,ts,tsx}]
+indent_style = space
+indent_size = 2
+
+[*.cs]
+indent_size = 4
diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
new file mode 100644
index 00000000..cbe63f33
--- /dev/null
+++ b/.github/workflows/dotnet.yml
@@ -0,0 +1,33 @@
+name: dotnet
+
+on:
+ push:
+ pull_request:
+
+jobs:
+ build-test:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Setup .NET
+ uses: actions/setup-dotnet@v4
+ with:
+ dotnet-version: 8.0.x
+
+ - name: Restore server
+ run: dotnet restore Aetheris.Server/Aetheris.Server.csproj
+
+ - name: Restore kernel tests
+ run: dotnet restore Aetheris.Kernel.Core.Tests/Aetheris.Kernel.Core.Tests.csproj
+
+ - name: Build server
+ run: dotnet build Aetheris.Server/Aetheris.Server.csproj --configuration Release --no-restore
+
+ - name: Build kernel tests
+ run: dotnet build Aetheris.Kernel.Core.Tests/Aetheris.Kernel.Core.Tests.csproj --configuration Release --no-restore
+
+ - name: Test kernel
+ run: dotnet test Aetheris.Kernel.Core.Tests/Aetheris.Kernel.Core.Tests.csproj --configuration Release --no-build
diff --git a/Aetheris.Kernel.Core.Tests/Aetheris.Kernel.Core.Tests.csproj b/Aetheris.Kernel.Core.Tests/Aetheris.Kernel.Core.Tests.csproj
new file mode 100644
index 00000000..bc8cf2b3
--- /dev/null
+++ b/Aetheris.Kernel.Core.Tests/Aetheris.Kernel.Core.Tests.csproj
@@ -0,0 +1,23 @@
+<Project Sdk="Microsoft.NET.Sdk">
+ <PropertyGroup>
+ <TargetFramework>net8.0</TargetFramework>
+ <ImplicitUsings>enable</ImplicitUsings>
+ <Nullable>enable</Nullable>
+ <IsPackable>false</IsPackable>
+ </PropertyGroup>
+
+ <ItemGroup>
+ <PackageReference Include="coverlet.collector" Version="6.0.0" />
+ <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+ <PackageReference Include="xunit" Version="2.9.2" />
+ <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
+ </ItemGroup>
+
+ <ItemGroup>
+ <Using Include="Xunit" />
+ </ItemGroup>
+
+ <ItemGroup>
+ <ProjectReference Include="..\Aetheris.Kernel.Core\Aetheris.Kernel.Core.csproj" />
+ </ItemGroup>
+</Project>
diff --git a/Aetheris.Kernel.Core.Tests/SanityTests.cs b/Aetheris.Kernel.Core.Tests/SanityTests.cs
new file mode 100644
index 00000000..58608944
--- /dev/null
+++ b/Aetheris.Kernel.Core.Tests/SanityTests.cs
@@ -0,0 +1,14 @@
+using Aetheris.Kernel.Core;
+
+namespace Aetheris.Kernel.Core.Tests;
+
+public sealed class SanityTests
+{
+ [Fact]
+ public void KernelCorePlaceholderTypeExists()
+ {
+ var placeholderType = typeof(KernelPlaceholder);
+
+ Assert.Equal("KernelPlaceholder", placeholderType.Name);
+ }
+}
diff --git a/Aetheris.Kernel.Core/Aetheris.Kernel.Core.csproj b/Aetheris.Kernel.Core/Aetheris.Kernel.Core.csproj
new file mode 100644
index 00000000..e8cd5992
--- /dev/null
+++ b/Aetheris.Kernel.Core/Aetheris.Kernel.Core.csproj
@@ -0,0 +1,7 @@
+<Project Sdk="Microsoft.NET.Sdk">
+ <PropertyGroup>
+ <TargetFramework>net8.0</TargetFramework>
+ <ImplicitUsings>enable</ImplicitUsings>
+ <Nullable>enable</Nullable>
+ </PropertyGroup>
+</Project>
diff --git a/Aetheris.Kernel.Core/KernelPlaceholder.cs b/Aetheris.Kernel.Core/KernelPlaceholder.cs
new file mode 100644
index 00000000..f1e0e85d
--- /dev/null
+++ b/Aetheris.Kernel.Core/KernelPlaceholder.cs
@@ -0,0 +1,8 @@
+namespace Aetheris.Kernel.Core;
+
+/// <summary>
+/// Placeholder type for milestone M00 scaffolding.
+/// </summary>
+public static class KernelPlaceholder
+{
+}
diff --git a/Aetheris.slnx b/Aetheris.slnx
index fc29da07..83ea3bf6 100644
--- a/Aetheris.slnx
+++ b/Aetheris.slnx
@@ -4,4 +4,6 @@
<Deploy />
</Project>
<Project Path="Aetheris.Server/Aetheris.Server.csproj" />
+ <Project Path="Aetheris.Kernel.Core/Aetheris.Kernel.Core.csproj" />
+ <Project Path="Aetheris.Kernel.Core.Tests/Aetheris.Kernel.Core.Tests.csproj" />
</Solution>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..2dc542d1
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,17 @@
+# Contributing
+
+## Development approach
+
+- Work milestone-first: implement only the scoped behavior for the current milestone.
+- Keep pull requests focused; avoid speculative feature branches folded into one PR.
+- Prefer small, mergeable increments over broad framework design.
+
+## Testing expectations
+
+- Behavior changes require tests.
+- Run .NET build/test checks locally before opening a PR.
+
+## Kernel discipline
+
+- Do not introduce ad hoc epsilon constants; follow `docs/numerics-policy.md`.
+- Favor diagnostic/result-oriented kernel operations over exceptions for expected operation outcomes (future-facing rule).
diff --git a/Directory.Build.props b/Directory.Build.props
new file mode 100644
index 00000000..61de972e
--- /dev/null
+++ b/Directory.Build.props
@@ -0,0 +1,7 @@
+<Project>
+ <PropertyGroup>
+ <TreatWarningsAsErrors>false</TreatWarningsAsErrors>
+ <Nullable>enable</Nullable>
+ <ImplicitUsings>enable</ImplicitUsings>
+ </PropertyGroup>
+</Project>
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..850a4831
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Aetheris
+
+Aetheris is a server/web-first solid modeling kernel project with an ASP.NET backend and React TypeScript frontend.
+
+## Current status
+
+Milestone **M00** is complete scaffolding work:
+
+- Kernel project/test scaffolding exists.
+- Core vision, non-goals, architecture, numerics, and milestone docs are defined.
+- Baseline .NET CI is configured for restore/build/test.
+
+No CAD/kernel feature implementation has started yet.
+
+## Repository structure
+
+- `Aetheris.Server/` — ASP.NET host/API project.
+- `aetheris.client/` — React + Vite TypeScript client.
+- `Aetheris.Kernel.Core/` — placeholder kernel core class library (no modeling logic yet).
+- `Aetheris.Kernel.Core.Tests/` — xUnit baseline tests for kernel core scaffolding.
+- `docs/` — project charter, scope, and policy documentation.
+
+## Run .NET checks
+
+```bash
+dotnet restore Aetheris.Server/Aetheris.Server.csproj
+dotnet restore Aetheris.Kernel.Core.Tests/Aetheris.Kernel.Core.Tests.csproj
+dotnet build Aetheris.Server/Aetheris.Server.csproj --no-restore
+dotnet build Aetheris.Kernel.Core.Tests/Aetheris.Kernel.Core.Tests.csproj --no-restore
+dotnet test Aetheris.Kernel.Core.Tests/Aetheris.Kernel.Core.Tests.csproj --no-build
+```
+
+Kernel implementation milestones begin after M00.
diff --git a/docs/architecture-overview.md b/docs/architecture-overview.md
new file mode 100644
index 00000000..459c8152
--- /dev/null
+++ b/docs/architecture-overview.md
@@ -0,0 +1,17 @@
+# Architecture Overview (Provisional)
+
+This package map is directional only and may evolve with milestone outcomes.
+
+## Proposed package map
+
+- `Aetheris.Kernel.Core` — shared kernel primitives, result/diagnostic contracts, and numeric policy entry points.
+- `Aetheris.Kernel.Modeling` — solid/B-rep modeling operations and topology-aware workflows.
+- `Aetheris.Kernel.Tessellation` — mesh generation derived from authoritative B-rep.
+- `Aetheris.Kernel.Step242` — AP242 mapping and translation at persistence/interchange boundaries.
+- `Aetheris.Web.Contracts` — backend/frontend DTO contracts and API-facing schemas.
+- `Aetheris.Demo.Web` (or existing frontend app) — browser UI for scenario validation and demos.
+
+## Notes
+
+- Boundaries are favored over deep abstraction in early milestones.
+- Kernel remains independent from UI and persistence concerns.
diff --git a/docs/milestones.md b/docs/milestones.md
new file mode 100644
index 00000000..772ef932
--- /dev/null
+++ b/docs/milestones.md
@@ -0,0 +1,20 @@
+# Milestones
+
+## M00 — Project Charter + Repo Skeleton Hardening
+
+- [x] Add kernel core and kernel test scaffolding projects.
+- [x] Establish project docs for vision, non-goals, architecture, and numerics policy.
+- [x] Set contribution/editor guardrails.
+- [x] Ensure CI restores, builds, and tests .NET projects.
+
+## M01 — Diagnostics and Result Model Baseline
+
+- [ ] Define kernel operation result envelope (success/failure + diagnostics).
+- [ ] Introduce shared diagnostic identifiers and deterministic formatting conventions.
+- [ ] Add tests for result model semantics.
+
+## M02 — Tolerance and Numerics Primitives
+
+- [ ] Introduce centralized tolerance primitives and policy-backed defaults.
+- [ ] Add foundational numeric utility types required for later geometric operations.
+- [ ] Add focused tests that enforce tolerance policy behavior.
diff --git a/docs/non-goals.md b/docs/non-goals.md
new file mode 100644
index 00000000..a8455ebc
--- /dev/null
+++ b/docs/non-goals.md
@@ -0,0 +1,12 @@
+# Non-goals (Early Milestones)
+
+The following are explicitly out of scope for M00 and nearby milestones:
+
+- No sketch constraint solver.
+- No FEA/CFD solver.
+- No unified PDE engine.
+- No early fillet/chamfer feature work.
+- No browser WASM kernel target in early phases.
+- No up-front monolithic "all-in-one CAD app" architecture.
+
+These are deferred to keep early milestones focused on kernel foundations and disciplined iteration.
diff --git a/docs/numerics-policy.md b/docs/numerics-policy.md
new file mode 100644
index 00000000..d5266e94
--- /dev/null
+++ b/docs/numerics-policy.md
@@ -0,0 +1,13 @@
+# Numerics Policy (Direction)
+
+This document sets baseline numeric discipline for upcoming milestones.
+
+## Policy statements
+
+- Centralized tolerance policy: tolerance values must be defined in shared kernel locations.
+- No ad hoc epsilon literals in random files.
+- `double` precision is the default numeric type unless a milestone explicitly introduces alternatives.
+- Prefer exact analytic representations where available; use tolerant operations where required by computation.
+- Diagnostics and failure modes must be deterministic and observable.
+- Kernel APIs should be failure-aware (result/diagnostic-oriented) rather than exception-led for expected operation outcomes.
+- Guiding principle: **exact where represented, tolerant where operated**.
diff --git a/docs/vision.md b/docs/vision.md
new file mode 100644
index 00000000..4aa70264
--- /dev/null
+++ b/docs/vision.md
@@ -0,0 +1,12 @@
+# Vision
+
+Aetheris is being built as a modern solid modeling kernel first, with clear boundaries between geometric computation and higher-level product features.
+
+## Direction
+
+- Authoritative representation: B-rep is the source of truth for modeled solids.
+- Kernel scope: robust geometric/topological operations and diagnostics.
+- Parametric/history: intentionally outside the kernel boundary.
+- Long-term foundation: a continuum-unified substrate is a strategic goal, not an early milestone deliverable.
+- Execution target: server/web-first deployment and integration.
+- Persistence/interchange: AP242 is the primary target, mapped at boundaries rather than mirrored as in-memory domain objects.