Control Room capability register¶
Last changes: Documentation changelog
This register is the authoritative source tracking implemented browser capability boundaries for public documentation. It separates a backend Python/ProblemIR capability from an actually authored Control Room v2 path: a Python parameter is never described as UI-supported merely because the backend or OpenAPI schema can represent it.
1. How to read the status¶
Status |
Meaning for documentation |
|---|---|
|
The named Control Room route, panel fields, and commit transaction exist in current source ( |
|
A dedicated panel or editor exists, covering an explicitly enumerated subset of the Python/API surface; unexposed options remain |
|
The UI renders resolved runtime, mesh, or result artifacts without mutating the underlying Python model. |
|
No supported authoring UI exists yet; document Python authoring first and mark UI support explicitly as |
2. Current Control Room v2 routes¶
Capability area |
Control Room route / shell surface |
Current status |
Source owner |
|---|---|---|---|
Start Screen, templates, import, recent scripts/results & sibling instances |
|
|
|
Workspace chrome, multi-instance tabs, Mocha/Latte themes & Command Palette |
Top header ( |
|
|
Primitive geometry placement & metadata |
|
|
|
Magnetic materials & absorbing boundary ramps |
|
|
|
Sub-object spatial regions & nested overrides |
|
|
|
Initial magnetization textures & coordinate transforms |
|
|
|
Local & global magnetic interactions, field drives & couplings |
|
|
|
Frozen spins constraints |
|
|
|
RF antennas, conductors, ports & EM basis preview |
|
|
|
Spin/current transport, STT/SOT, Oersted & spin interfaces |
|
|
|
FEM object, airbox & region mesh policy authoring |
|
|
|
FDM structured grid & FEM quality/history reports |
|
|
|
Study profile, ordered stages & safe Apply + Re-Run |
|
|
|
3D WebGL viewport, clipping, studio HDRI & PNG export |
|
|
|
Planar monitors & interactive 2D Field Map |
|
|
|
Live ECharts, hysteresis playback, dispersion & FMR spectral plots |
|
|
|
Saved SolutionSet browser & offline playback |
|
|
|
Runtime, provenance, logs, problems & diagnostic recording |
|
|
|
3. Explicit frontend TODO boundaries¶
The following Python/API capabilities must remain explicitly documented as TODO: frontend support
until an authoring control and committed transaction exist in apps/control-room:
Python / ProblemIR surface |
Required documentation status |
|---|---|
Direct standalone |
|
Interactive CSG Boolean geometry operations ( |
|
Rigid |
|
Two-way in-UI Python script synchronization ( |
|
Arbitrary callable spatial material fields & custom Python stage closures |
|
|
|
4. Required per-page frontend crosswalk contract¶
Every terminal documentation page must include Control Room crosswalk (or How to set it in Control Room) stating:
exact Explorer tree, Ribbon tab, or shell route and inspector component;
exposed field groups and parameter names;
commit transaction (
Apply,Build,Compute Study, orexecuteStageAfterApply) and invalidation behavior;supported subset when
partial, and literalTODO: frontend supportfor unexposed options;reference back to this register and verified source owners.
Control Room crosswalk¶
This page is the Control Room capability register itself. Statuses reflect verified inspection of
apps/control-room/src/** and distinguish authoring (implemented / partial) from read-only
surfaces (inspection-only) and Python-only routes (TODO). See Control Room
and Semantic Inspectors.
Python/API crosswalk¶
Python remains the authoritative authoring contract. Use Python API for exact constructors, methods, SI arguments, validation rules, and runtime exceptions; never infer a Python signature from an internal Control Room draft field name.
Physics and bibliography scope¶
This UI register introduces no independent physical equations. Scientific formulations belong to the linked physics and numerical-methods sections.
Source-code index¶
Responsibility |
Repository path |
Stable symbol |
|---|---|---|
Workspace start hub |
|
|
Ribbon commands & preview gate |
|
|
Inspector route dispatcher |
|
|
Geometry, material, region & texture panels |
|
|
Physics, antenna & transport inspectors |
|
|
Study, stage & runtime inspectors |
|
|
3D, 2D & chart visualization modules |
|
|