Update project structure and configurations
This commit is contained in:
@@ -1,21 +1,17 @@
|
||||
# Sprint Status - Entropyk
|
||||
# Last Updated: 2026-03-29 (story 13-4 review fixes complete)
|
||||
# Last Updated: 2026-04-28 (story 20-1 implementation)
|
||||
# Project: Entropyk
|
||||
# Project Key: NOKEY
|
||||
# Tracking System: file-system
|
||||
# Story Location: _bmad-output/implementation-artifacts
|
||||
|
||||
#
|
||||
# ORGANIZED BY BUSINESS PILLARS (not historical epics)
|
||||
# Priority order: P4 (Solver) → P5 (Interfaces) → P6 (Applications)
|
||||
# See: _bmad-output/planning-artifacts/pillars.md for full pillar definitions
|
||||
# See: _bmad-output/planning-artifacts/epic-restructuring.md for migration rationale
|
||||
#
|
||||
# STATUS DEFINITIONS:
|
||||
# ==================
|
||||
# Epic Status:
|
||||
# - backlog: Epic not yet started
|
||||
# - in-progress: Epic actively being worked on
|
||||
# - done: All stories in epic completed
|
||||
#
|
||||
# Epic Status Transitions:
|
||||
# - backlog → in-progress: Automatically when first story is created (via create-story)
|
||||
# - in-progress → done: Manually when all stories reach 'done' status
|
||||
#
|
||||
# Story Status:
|
||||
# - backlog: Story only exists in epic file
|
||||
# - ready-for-dev: Story file created in stories folder
|
||||
@@ -23,16 +19,13 @@
|
||||
# - review: Ready for code review (via Dev's code-review workflow)
|
||||
# - done: Story completed
|
||||
#
|
||||
# Retrospective Status:
|
||||
# - optional: Can be completed but not required
|
||||
# - done: Retrospective has been completed
|
||||
#
|
||||
# WORKFLOW NOTES:
|
||||
# ===============
|
||||
# - Epic transitions to 'in-progress' automatically when first story is created
|
||||
# - Stories can be worked in parallel if team capacity allows
|
||||
# - SM typically creates next story after previous one is 'done' to incorporate learnings
|
||||
# - Dev moves story to 'review', then runs code-review (fresh context, different LLM recommended)
|
||||
# - File is read top-to-bottom by BMAD: first matching status = next action
|
||||
# - epic-X keys are kept for BMAD workflow compatibility (do not remove)
|
||||
# - Stories are grouped by pillar; within each pillar: active → backlog → done
|
||||
# - SM creates next story after previous one is 'done' to incorporate learnings
|
||||
# - Dev moves story to 'review', then runs code-review (fresh context recommended)
|
||||
|
||||
generated: 2026-02-22
|
||||
project: Entropyk
|
||||
@@ -41,119 +34,68 @@ tracking_system: file-system
|
||||
story_location: _bmad-output/implementation-artifacts
|
||||
|
||||
development_status:
|
||||
# Epic 1: Extensible Component Framework
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
# EPIC STATUS (required by BMAD — epic-X keys must stay here)
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
epic-1: done
|
||||
epic-2: done
|
||||
epic-3: done
|
||||
epic-4: done
|
||||
epic-5: in-progress
|
||||
epic-6: in-progress
|
||||
epic-7: in-progress
|
||||
epic-8: done
|
||||
epic-9: done
|
||||
epic-10: in-progress
|
||||
epic-11: in-progress
|
||||
epic-12: in-progress
|
||||
epic-13: in-progress
|
||||
epic-14: in-progress
|
||||
epic-15: in-progress
|
||||
epic-16: backlog
|
||||
epic-17: backlog
|
||||
epic-18: backlog
|
||||
epic-19: in-progress
|
||||
epic-20: in-progress
|
||||
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
# P1: FOUNDATION / Fondations — 14/14 DONE
|
||||
# Types, traits, ports, graph topology, state machine
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
1-1-component-trait-definition: done
|
||||
1-2-physical-types-newtype-pattern: done
|
||||
1-3-port-and-connection-system: done
|
||||
1-4-compressor-component-ahri-540: done
|
||||
1-5-generic-heat-exchanger-framework: done
|
||||
1-6-expansion-valve-component: done
|
||||
1-7-component-state-machine: done
|
||||
1-8-auxiliary-transport-components: done
|
||||
1-11-flow-junctions-flowsplitter-flowmerger: done
|
||||
1-12-boundary-conditions-flowsource-flowsink: done
|
||||
epic-1-retrospective: optional
|
||||
|
||||
# Epic 2: Fluid Properties Backend
|
||||
epic-2: done
|
||||
2-1-fluid-backend-trait-abstraction: done
|
||||
2-2-coolprop-integration-sys-crate: done
|
||||
2-3-tabular-interpolation-backend: done
|
||||
2-4-lru-cache-for-fluid-properties: done
|
||||
2-5-mixture-and-temperature-glide-support: done
|
||||
2-6-critical-point-damping-co2-r744: done
|
||||
2-7-incompressible-fluids-support: done
|
||||
2-8-rich-thermodynamic-state-abstraction: done
|
||||
epic-2-retrospective: optional
|
||||
|
||||
# Epic 3: System Topology (Graph)
|
||||
epic-3: done
|
||||
3-1-system-graph-structure: done
|
||||
3-2-port-compatibility-validation: done
|
||||
3-3-multi-circuit-machine-definition: done
|
||||
3-4-thermal-coupling-between-circuits: done
|
||||
3-5-zero-flow-branch-handling: done
|
||||
3-6-hierarchical-subsystems-macrocomponents: done
|
||||
epic-3-retrospective: optional
|
||||
|
||||
# Epic 4: Intelligent Solver Engine
|
||||
epic-4: done
|
||||
4-1-solver-trait-abstraction: done
|
||||
4-2-newton-raphson-implementation: done
|
||||
4-3-sequential-substitution-picard-implementation: done
|
||||
4-4-intelligent-fallback-strategy: done
|
||||
4-5-time-budgeted-solving: done
|
||||
4-6-smart-initialization-heuristic: done
|
||||
4-7-convergence-criteria-validation: done
|
||||
4-8-jacobian-freezing-optimization: done
|
||||
epic-4-retrospective: optional
|
||||
|
||||
# Epic 5: Inverse Control & Optimization
|
||||
epic-5: in-progress
|
||||
5-1-constraint-definition-framework: done
|
||||
5-2-bounded-control-variables: done
|
||||
5-3-residual-embedding-for-inverse-control: done
|
||||
5-4-multi-variable-control: in-progress
|
||||
5-5-swappable-calibration-variables-inverse-calibration-one-shot: done
|
||||
5-6-control-variable-step-clipping-in-solver: review
|
||||
epic-5-retrospective: optional
|
||||
|
||||
# Epic 6: Multi-Platform APIs
|
||||
epic-6: in-progress
|
||||
6-1-rust-native-api: done
|
||||
6-2-python-bindings-pyo3: done
|
||||
6-3-c-ffi-bindings-cbindgen: done
|
||||
6-4-webassembly-compilation: review
|
||||
6-5-cli-for-batch-execution: done
|
||||
6-6-python-solver-configuration-parity: done
|
||||
epic-6-retrospective: optional
|
||||
|
||||
# Epic 7: Validation & Persistence
|
||||
epic-7: in-progress
|
||||
7-1-mass-balance-validation: done
|
||||
7-2-energy-balance-validation: done
|
||||
7-3-traceability-metadata: done
|
||||
7-4-debug-verbose-mode: done
|
||||
7-5-json-serialization-deserialization: in-progress
|
||||
7-6-component-calibration-parameters-calib: backlog
|
||||
7-7-ashrae-140-bestest-validation-post-mvp: backlog
|
||||
7-8-inverse-calibration-parameter-estimation: backlog
|
||||
epic-7-retrospective: optional
|
||||
|
||||
# Epic 8: Component-Fluid Integration
|
||||
epic-8: done
|
||||
8-1-fluid-backend-component-integration: done
|
||||
1-9-air-coils-evaporatorcoil-condensercoil-post-mvp: done
|
||||
1-10-pipe-helpers-for-water-and-refrigerant: done
|
||||
epic-8-retrospective: optional
|
||||
|
||||
# Epic 9: Coherence Corrections (Post-Audit)
|
||||
epic-9: done
|
||||
9-1-circuitid-type-unification: done
|
||||
9-2-fluidid-type-unification: done
|
||||
9-3-expansionvalve-energy-methods: done
|
||||
9-4-flowsourceflowsink-energy-methods: done
|
||||
9-5-flowsplitterflowmerger-energy-methods: done
|
||||
9-6-energy-validation-logging-improvement: done
|
||||
9-7-solver-refactoring-split-files: done
|
||||
9-8-systemstate-dedicated-struct: done
|
||||
epic-9-retrospective: optional
|
||||
|
||||
# Epic 10: Enhanced Boundary Conditions
|
||||
# Refactoring of RefrigerantSource/BrineSource for typed fluid support
|
||||
# See: _bmad-output/planning-artifacts/epic-10-enhanced-boundary-conditions.md
|
||||
epic-10: in-progress
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
# P2: REAL COMPONENTS / Composants — 30/39 (77%)
|
||||
# All thermodynamic components, vendor data parsers, boundary conditions
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
1-4-compressor-component-ahri-540: done
|
||||
1-5-generic-heat-exchanger-framework: done
|
||||
1-6-expansion-valve-component: done
|
||||
1-8-auxiliary-transport-components: done
|
||||
1-9-air-coils-evaporatorcoil-condensercoil-post-mvp: done
|
||||
1-10-pipe-helpers-for-water-and-refrigerant: done
|
||||
1-11-flow-junctions-flowsplitter-flowmerger: done
|
||||
1-12-boundary-conditions-flowsource-flowsink: done
|
||||
8-1-fluid-backend-component-integration: done
|
||||
10-1-new-physical-types: done
|
||||
10-2-refrigerant-source-sink: done
|
||||
10-3-brine-source-sink: done
|
||||
10-4-air-source-sink: done
|
||||
10-5-migration-deprecation: done
|
||||
10-6-python-bindings-update: backlog
|
||||
epic-10-retrospective: optional
|
||||
|
||||
# Epic 11: Advanced HVAC Components
|
||||
epic-11: in-progress
|
||||
10-6-python-bindings-update: done
|
||||
11-1-node-passive-probe: done
|
||||
11-2-drum-recirculation-drum: done
|
||||
11-3-floodedevaporator: done
|
||||
@@ -169,72 +111,102 @@ development_status:
|
||||
11-13-swep-parser: done
|
||||
11-14-danfoss-parser: done
|
||||
11-15-bitzer-parser: done
|
||||
epic-11-retrospective: optional
|
||||
|
||||
# Epic 12: CLI Refactor & Advanced Components
|
||||
# Support for ScrewEconomizerCompressor, MCHXCondenserCoil, FloodedEvaporator
|
||||
# with proper internal state variables, CoolProp backend, and controls
|
||||
epic-12: in-progress
|
||||
12-1-cli-internal-state-variables: done
|
||||
12-2-cli-coolprop-backend: done
|
||||
12-3-cli-screw-compressor-config: done
|
||||
12-4-cli-mchx-condenser-config: done
|
||||
12-5-cli-flooded-evaporator-brine: done
|
||||
12-6-cli-control-constraints: done
|
||||
12-7-cli-output-json-metrics: done
|
||||
12-8-cli-batch-improvements: done
|
||||
epic-12-retrospective: optional
|
||||
# --- Backlog: P2 Extended (from legacy integration) ---
|
||||
20-1-generalized-performance-curve-engine: done # P2-31
|
||||
20-3-reversing-valve-four-way-component: backlog # P2-32
|
||||
20-4-high-pressure-control-valve: backlog # P2-33
|
||||
20-5-compressor-parallel-units-vfd: backlog # P2-34
|
||||
20-6-multi-zone-heat-exchanger-component: backlog # P2-35
|
||||
20-7-additional-plate-hx-correlations: backlog # P2-36
|
||||
20-8-equipment-catalog-system: backlog # P2-37
|
||||
20-9-fouling-encrustation-resistance: backlog # P2-38
|
||||
20-10-vendor-backend-verification-modernization: backlog # P2-39
|
||||
|
||||
# Epic 13: Rust API Enhancements
|
||||
# Extending SystemBuilder with multi-circuit, constraints, thermal couplings,
|
||||
# structured results, JSON config, and fluid backend assignment
|
||||
epic-13: in-progress
|
||||
13-1-systembuilder-multi-circuit: done
|
||||
13-2-systembuilder-port-validated-edges: done
|
||||
13-3-systembuilder-constraints-api: done
|
||||
13-4-systembuilder-thermal-couplings: done
|
||||
13-5-simulation-result-structured: ready-for-dev
|
||||
13-6-json-config-serialize: ready-for-dev
|
||||
13-7-fluid-backend-assignment: ready-for-dev
|
||||
epic-13-retrospective: optional
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
# P3: FLUID PROPERTIES / Fluides — 8/9 (89%)
|
||||
# CoolProp, tabular backend, cache, mixtures, CO2 damping, psychrometrics
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
2-1-fluid-backend-trait-abstraction: done
|
||||
2-2-coolprop-integration-sys-crate: done
|
||||
2-3-tabular-interpolation-backend: done
|
||||
2-4-lru-cache-for-fluid-properties: done
|
||||
2-5-mixture-and-temperature-glide-support: done
|
||||
2-6-critical-point-damping-co2-r744: done
|
||||
2-7-incompressible-fluids-support: done
|
||||
2-8-rich-thermodynamic-state-abstraction: done
|
||||
|
||||
# Epic 14: Free Cooling & Advanced Pump Control
|
||||
# Native free cooling simulation with automatic mode switching, pump sequencing, and energy optimization
|
||||
# See: _bmad-output/planning-artifacts/epic-12-free-cooling-pump-control.md
|
||||
epic-14: in-progress
|
||||
14-1-freecoolingexchanger-component: in-progress
|
||||
14-2-automatic-mode-switching-logic: backlog
|
||||
14-3-pumpcontroller-optimal-sequencing: backlog
|
||||
14-4-variable-frequency-drive-vfd-optimization: backlog
|
||||
14-5-bypass-valve-control: backlog
|
||||
14-6-safety-interlocks-protection: backlog
|
||||
14-7-control-configuration-serialization: backlog
|
||||
14-8-python-api-advanced-control: backlog
|
||||
epic-14-retrospective: optional
|
||||
# --- Backlog ---
|
||||
20-2-complete-psychrometric-module: backlog # P3-09
|
||||
|
||||
# Epic 15: CLI — Complete Component Coverage
|
||||
# Every Rust component must be usable from JSON config
|
||||
# See: _bmad-output/implementation-artifacts/15-*
|
||||
epic-15: in-progress
|
||||
15-1-cli-real-compressor: done
|
||||
15-2-cli-real-expansion-valve: done
|
||||
15-3-cli-real-pump: done
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
# P4: SIMULATION & SOLVER — 22/26 (85%)
|
||||
# >>> PRIORITY PILLAR — must complete before P5/P6 expansion
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
|
||||
# --- In Progress ---
|
||||
5-4-multi-variable-control: done
|
||||
7-5-json-serialization-deserialization: done
|
||||
|
||||
# --- Review ---
|
||||
5-6-control-variable-step-clipping-in-solver: review
|
||||
|
||||
# --- Ready for Dev ---
|
||||
7-6-component-calibration-parameters-calib: done
|
||||
|
||||
# --- Backlog ---
|
||||
19-1-inverse-calibration: in-progress # P4-25: solver-level algorithm
|
||||
|
||||
# --- Backlog: Multi-point calibration ---
|
||||
calib-map-multi-point-calibration: backlog # P4-26
|
||||
|
||||
# --- Done ---
|
||||
4-1-solver-trait-abstraction: done
|
||||
4-2-newton-raphson-implementation: done
|
||||
4-3-sequential-substitution-picard-implementation: done
|
||||
4-4-intelligent-fallback-strategy: done
|
||||
4-5-time-budgeted-solving: done
|
||||
4-6-smart-initialization-heuristic: done
|
||||
4-7-convergence-criteria-validation: done
|
||||
4-8-jacobian-freezing-optimization: done
|
||||
5-1-constraint-definition-framework: done
|
||||
5-2-bounded-control-variables: done
|
||||
5-3-residual-embedding-for-inverse-control: done
|
||||
5-5-swappable-calibration-variables-inverse-calibration-one-shot: done
|
||||
7-1-mass-balance-validation: done
|
||||
7-2-energy-balance-validation: done
|
||||
7-3-traceability-metadata: done
|
||||
7-4-debug-verbose-mode: done
|
||||
9-3-expansionvalve-energy-methods: done
|
||||
9-4-flowsourceflowsink-energy-methods: done
|
||||
9-5-flowsplitterflowmerger-energy-methods: done
|
||||
9-6-energy-validation-logging-improvement: done
|
||||
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
# P5: USER INTERFACES — 30/59 (51%)
|
||||
# CLI, Python, C FFI, WASM, Rust API (SystemBuilder)
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
|
||||
# --- Review ---
|
||||
6-4-webassembly-compilation: in-progress
|
||||
15-4-cli-bphx-exchangers: review
|
||||
|
||||
# --- Ready for Dev ---
|
||||
13-5-simulation-result-structured: done
|
||||
13-6-json-config-serialize: done
|
||||
13-7-fluid-backend-assignment: done
|
||||
|
||||
# --- Backlog: CLI Component Coverage ---
|
||||
15-5-cli-flooded-condenser: backlog
|
||||
15-6-cli-drum: backlog
|
||||
15-7-cli-economizer: backlog
|
||||
15-8-cli-flow-splitter-merger: backlog
|
||||
15-9-cli-boundary-conditions: done
|
||||
15-10-cli-real-pipe: backlog
|
||||
15-11-cli-real-fan: backlog
|
||||
15-12-cli-bypass-valve: backlog
|
||||
15-13-cli-node-probe: backlog
|
||||
epic-15-retrospective: optional
|
||||
|
||||
# Epic 16: CLI — Features & Output
|
||||
# Calibration, structured output, multi-fluid, vendors, templates, sweep
|
||||
# See: _bmad-output/implementation-artifacts/16-*
|
||||
epic-16: backlog
|
||||
# --- Backlog: CLI Features & Output ---
|
||||
16-1-cli-calib-config: backlog
|
||||
16-2-cli-structured-output: backlog
|
||||
16-3-cli-multi-fluid: backlog
|
||||
@@ -242,12 +214,8 @@ development_status:
|
||||
16-5-cli-json-schema: backlog
|
||||
16-6-cli-machine-templates: backlog
|
||||
16-7-cli-parameter-sweep: backlog
|
||||
epic-16-retrospective: optional
|
||||
|
||||
# Epic 17: Python Bindings — Complete Component & Feature Parity
|
||||
# Expose all Rust components and features to Python via PyO3
|
||||
# See: _bmad-output/implementation-artifacts/17-*
|
||||
epic-17: backlog
|
||||
# --- Backlog: Python Parity ---
|
||||
17-1-python-fix-pump: backlog
|
||||
17-2-python-fix-fan: backlog
|
||||
17-3-python-screw-compressor: backlog
|
||||
@@ -261,24 +229,80 @@ development_status:
|
||||
17-11-python-bypass-coils: backlog
|
||||
17-12-python-vendor-parsers: backlog
|
||||
17-13-python-macro-snapshot: backlog
|
||||
epic-17-retrospective: optional
|
||||
|
||||
# Epic 18: WebAssembly — Full Component Coverage
|
||||
# Make WASM bindings usable for JS/TS frontend development
|
||||
# See: _bmad-output/implementation-artifacts/18-*
|
||||
epic-18: backlog
|
||||
# --- Backlog: WASM ---
|
||||
18-1-wasm-finalize-compilation: backlog
|
||||
18-2-wasm-all-components: backlog
|
||||
18-3-wasm-multi-circuit: backlog
|
||||
18-4-wasm-calib-results: backlog
|
||||
18-5-wasm-vendor-data: backlog
|
||||
epic-18-retrospective: optional
|
||||
|
||||
# Epic 19: Calibration & Validation
|
||||
# Inverse calibration, Eurovent reporting, ASHRAE validation
|
||||
# See: _bmad-output/implementation-artifacts/19-*
|
||||
epic-19: backlog
|
||||
19-1-inverse-calibration: backlog
|
||||
19-2-eurovent-reporting: backlog
|
||||
19-3-ashrae-bestest: backlog
|
||||
# --- Done ---
|
||||
6-1-rust-native-api: done
|
||||
6-2-python-bindings-pyo3: done
|
||||
6-3-c-ffi-bindings-cbindgen: done
|
||||
6-5-cli-for-batch-execution: done
|
||||
6-6-python-solver-configuration-parity: done
|
||||
12-1-cli-internal-state-variables: done
|
||||
12-2-cli-coolprop-backend: done
|
||||
12-3-cli-screw-compressor-config: done
|
||||
12-4-cli-mchx-condenser-config: done
|
||||
12-5-cli-flooded-evaporator-brine: done
|
||||
12-6-cli-control-constraints: done
|
||||
12-7-cli-output-json-metrics: done
|
||||
12-8-cli-batch-improvements: done
|
||||
13-1-systembuilder-multi-circuit: done
|
||||
13-2-systembuilder-port-validated-edges: done
|
||||
13-3-systembuilder-constraints-api: done
|
||||
13-4-systembuilder-thermal-couplings: done
|
||||
15-1-cli-real-compressor: done
|
||||
15-2-cli-real-expansion-valve: done
|
||||
15-3-cli-real-pump: done
|
||||
15-9-cli-boundary-conditions: done
|
||||
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
# P6: HVAC APPLICATIONS — 0/14 (7%)
|
||||
# Free cooling, calibration, standards compliance, reporting
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
|
||||
# --- In Progress ---
|
||||
14-1-freecoolingexchanger-component: review
|
||||
|
||||
# --- Backlog ---
|
||||
14-2-automatic-mode-switching-logic: backlog
|
||||
14-3-pumpcontroller-optimal-sequencing: backlog
|
||||
14-4-variable-frequency-drive-vfd-optimization: backlog
|
||||
14-5-bypass-valve-control: backlog
|
||||
14-6-safety-interlocks-protection: backlog
|
||||
14-7-control-configuration-serialization: backlog
|
||||
14-8-python-api-advanced-control: backlog
|
||||
7-7-ashrae-140-bestest-validation-post-mvp: backlog # P6-09
|
||||
7-8-inverse-calibration-parameter-estimation: backlog # P6-10
|
||||
19-2-eurovent-reporting: backlog # P6-12
|
||||
19-3-ashrae-bestest: backlog # MERGED into P6-09 (see epic-restructuring.md)
|
||||
|
||||
# --- Backlog: Calibration workflow ---
|
||||
calibration-workflow-application: backlog # P6-14
|
||||
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
# RETROSPECTIVES
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
epic-1-retrospective: optional
|
||||
epic-2-retrospective: optional
|
||||
epic-3-retrospective: optional
|
||||
epic-4-retrospective: optional
|
||||
epic-5-retrospective: optional
|
||||
epic-6-retrospective: optional
|
||||
epic-7-retrospective: optional
|
||||
epic-8-retrospective: optional
|
||||
epic-9-retrospective: optional
|
||||
epic-10-retrospective: optional
|
||||
epic-11-retrospective: optional
|
||||
epic-12-retrospective: optional
|
||||
epic-13-retrospective: optional
|
||||
epic-14-retrospective: optional
|
||||
epic-15-retrospective: optional
|
||||
epic-16-retrospective: optional
|
||||
epic-17-retrospective: optional
|
||||
epic-18-retrospective: optional
|
||||
epic-19-retrospective: optional
|
||||
|
||||
Reference in New Issue
Block a user