sepehr
5bd180b5b8
Some checks failed
CI / check (push) Has been cancelled
Capture uncommitted solver robustness work (regularization, domain errors, linear solver lifecycle, tube DP/MSH), web workbench updates, and synced BMAD skills across IDE agent folders before starting BPHX pressure-drop. Co-authored-by: Cursor <cursoragent@cursor.com>
1.7 KiB
1.7 KiB
Directory Index
General Documentation
- DOCUMENTATION.md - The definitive guide to Entropyk.
- EXAMPLES_FULL.md - Deep-dive usage examples for all platforms.
- README.md - Main project overview and getting started guide.
- TUTORIAL.md - Step-by-step guide to using Entropyk (CLI & UI).
- rating-and-seasonal-metrics.md - Seasonal & part-load ratings (IPLV/NPLV/ESEER/SCOP/SEER) and the modular
ratecommand. - model-ir.md - The unified Model IR (schema-versioned JSON) shared by CLI, web UI and bindings:
schema_version,subsystems/instancestemplates, co-solvedcontrols, and theschemacommand. - simulation-capabilities.md - Bilingual (EN/FR) analysis of what Entropyk can simulate and how it compares to Modelica-style system modeling.
- components/README.md - Bilingual (EN/FR) per-component reference: physics, residual equations, ports, DoF, calibration, and JSON parameters for every CLI component.
- EXAMPLES.md - Component-level usage snippets (Legacy).
- README_STORY_1_3.md - Technical details of Port and Connection system implementation.
Project Subdirectories
demo/
- demo/README.md - Documentation for demo applications and system simulations.
crates/
- crates/entropyk/README.md - Specific documentation for the main Entropyk library crate.
Assets
- docs/katex-header.html - KaTeX configuration for rendering mathematical formulas in documentation.