sepehr/Entropyk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: update documentation to reflect recent architectural changes and improve clarity

Browse Source
This commit is contained in:
Sepehr
2026-03-10 22:59:04 +01:00
parent d88914a44f
commit 891c4ba436
530 changed files with 2544 additions and 1513 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
crates/cli/examples/chiller_mchx_condensers_only.json
View File

@@ -1,9 +1,7 @@
{
"name": "Chiller MCHX Condensers - Démonstration CLI",
"description": "Démontre l'utilisation des MchxCondenserCoil (4 coils) et FloodedEvaporator dans le pipeline CLI. Utilise des Placeholder pour simuler compresseur et vanne. Topology linéaire pour compatibilité CLI graphe.",
"fluid": "R134a",
"circuits": [
{
"id": 0,
@@ -16,20 +14,18 @@
{
"type": "MchxCondenserCoil",
"name": "mchx_0a",
"ua": 15000.0,
"coil_index": 0,
"n_air": 0.5,
"t_air_celsius": 35.0,
"fan_speed_ratio": 1.0
"ua_nominal_kw_k": 15.0,
"n_air_exponent": 0.5,
"air_inlet_temp_c": 35.0,
"fan_speed": 1.0
},
{
"type": "MchxCondenserCoil",
"name": "mchx_0b",
"ua": 15000.0,
"coil_index": 1,
"n_air": 0.5,
"t_air_celsius": 35.0,
"fan_speed_ratio": 0.8
"ua_nominal_kw_k": 15.0,
"n_air_exponent": 0.5,
"air_inlet_temp_c": 35.0,
"fan_speed": 0.8
},
{
"type": "Placeholder",
@@ -46,11 +42,26 @@
}
],
"edges": [
{ "from": "comp_0:outlet", "to": "mchx_0a:inlet" },
{ "from": "mchx_0a:outlet", "to": "mchx_0b:inlet" },
{ "from": "mchx_0b:outlet", "to": "exv_0:inlet" },
{ "from": "exv_0:outlet", "to": "evap_0:inlet" },
{ "from": "evap_0:outlet", "to": "comp_0:inlet" }
{
"from": "comp_0:outlet",
"to": "mchx_0a:inlet"
},
{
"from": "mchx_0a:outlet",
"to": "mchx_0b:inlet"
},
{
"from": "mchx_0b:outlet",
"to": "exv_0:inlet"
},
{
"from": "exv_0:outlet",
"to": "evap_0:inlet"
},
{
"from": "evap_0:outlet",
"to": "comp_0:inlet"
}
]
},
{
@@ -64,20 +75,18 @@
{
"type": "MchxCondenserCoil",
"name": "mchx_1a",
"ua": 15000.0,
"coil_index": 2,
"n_air": 0.5,
"t_air_celsius": 35.0,
"fan_speed_ratio": 1.0
"ua_nominal_kw_k": 15.0,
"n_air_exponent": 0.5,
"air_inlet_temp_c": 35.0,
"fan_speed": 1.0
},
{
"type": "MchxCondenserCoil",
"name": "mchx_1b",
"ua": 15000.0,
"coil_index": 3,
"n_air": 0.5,
"t_air_celsius": 35.0,
"fan_speed_ratio": 0.9
"ua_nominal_kw_k": 15.0,
"n_air_exponent": 0.5,
"air_inlet_temp_c": 35.0,
"fan_speed": 0.9
},
{
"type": "Placeholder",
@@ -94,21 +103,34 @@
}
],
"edges": [
{ "from": "comp_1:outlet", "to": "mchx_1a:inlet" },
{ "from": "mchx_1a:outlet", "to": "mchx_1b:inlet" },
{ "from": "mchx_1b:outlet", "to": "exv_1:inlet" },
{ "from": "exv_1:outlet", "to": "evap_1:inlet" },
{ "from": "evap_1:outlet", "to": "comp_1:inlet" }
{
"from": "comp_1:outlet",
"to": "mchx_1a:inlet"
},
{
"from": "mchx_1a:outlet",
"to": "mchx_1b:inlet"
},
{
"from": "mchx_1b:outlet",
"to": "exv_1:inlet"
},
{
"from": "exv_1:outlet",
"to": "evap_1:inlet"
},
{
"from": "evap_1:outlet",
"to": "comp_1:inlet"
}
]
}
],
"solver": {
"strategy": "newton",
"max_iterations": 100,
"tolerance": 1e-6
},
"metadata": {
"note": "Demo MCHX 4 coils + FloodedEvap 2 circuits via CLI",
"mchx_coil_0_fan": "100% (design point)",
@@ -118,4 +140,4 @@
"glycol_type": "MEG 35%",
"t_air_celsius": 35.0
}
}
}

92
crates/cli/examples/chiller_screw_mchx_2circuits.json
View File

@@ -1,9 +1,7 @@
{
"name": "Chiller Air-Glycol 2 Circuits - Screw Economisé + MCHX",
"description": "Machine frigorifique 2 circuits indépendants. R134a, condenseurs MCHX (4 coils, air 35°C), évaporateurs noyés (MEG 35%, 12→7°C), compresseurs vis économisés VFD.",
"fluid": "R134a",
"circuits": [
{
"id": 0,
@@ -33,20 +31,18 @@
{
"type": "MchxCondenserCoil",
"name": "mchx_0a",
"ua": 15000.0,
"coil_index": 0,
"n_air": 0.5,
"t_air_celsius": 35.0,
"fan_speed_ratio": 1.0
"ua_nominal_kw_k": 15.0,
"n_air_exponent": 0.5,
"air_inlet_temp_c": 35.0,
"fan_speed": 1.0
},
{
"type": "MchxCondenserCoil",
"name": "mchx_0b",
"ua": 15000.0,
"coil_index": 1,
"n_air": 0.5,
"t_air_celsius": 35.0,
"fan_speed_ratio": 1.0
"ua_nominal_kw_k": 15.0,
"n_air_exponent": 0.5,
"air_inlet_temp_c": 35.0,
"fan_speed": 1.0
},
{
"type": "Placeholder",
@@ -63,11 +59,26 @@
}
],
"edges": [
{ "from": "screw_0:outlet", "to": "mchx_0a:inlet" },
{ "from": "mchx_0a:outlet", "to": "mchx_0b:inlet" },
{ "from": "mchx_0b:outlet", "to": "exv_0:inlet" },
{ "from": "exv_0:outlet", "to": "evap_0:inlet" },
{ "from": "evap_0:outlet", "to": "screw_0:inlet" }
{
"from": "screw_0:outlet",
"to": "mchx_0a:inlet"
},
{
"from": "mchx_0a:outlet",
"to": "mchx_0b:inlet"
},
{
"from": "mchx_0b:outlet",
"to": "exv_0:inlet"
},
{
"from": "exv_0:outlet",
"to": "evap_0:inlet"
},
{
"from": "evap_0:outlet",
"to": "screw_0:inlet"
}
]
},
{
@@ -98,20 +109,18 @@
{
"type": "MchxCondenserCoil",
"name": "mchx_1a",
"ua": 15000.0,
"coil_index": 2,
"n_air": 0.5,
"t_air_celsius": 35.0,
"fan_speed_ratio": 1.0
"ua_nominal_kw_k": 15.0,
"n_air_exponent": 0.5,
"air_inlet_temp_c": 35.0,
"fan_speed": 1.0
},
{
"type": "MchxCondenserCoil",
"name": "mchx_1b",
"ua": 15000.0,
"coil_index": 3,
"n_air": 0.5,
"t_air_celsius": 35.0,
"fan_speed_ratio": 1.0
"ua_nominal_kw_k": 15.0,
"n_air_exponent": 0.5,
"air_inlet_temp_c": 35.0,
"fan_speed": 1.0
},
{
"type": "Placeholder",
@@ -128,15 +137,29 @@
}
],
"edges": [
{ "from": "screw_1:outlet", "to": "mchx_1a:inlet" },
{ "from": "mchx_1a:outlet", "to": "mchx_1b:inlet" },
{ "from": "mchx_1b:outlet", "to": "exv_1:inlet" },
{ "from": "exv_1:outlet", "to": "evap_1:inlet" },
{ "from": "evap_1:outlet", "to": "screw_1:inlet" }
{
"from": "screw_1:outlet",
"to": "mchx_1a:inlet"
},
{
"from": "mchx_1a:outlet",
"to": "mchx_1b:inlet"
},
{
"from": "mchx_1b:outlet",
"to": "exv_1:inlet"
},
{
"from": "exv_1:outlet",
"to": "evap_1:inlet"
},
{
"from": "evap_1:outlet",
"to": "screw_1:inlet"
}
]
}
],
"solver": {
"strategy": "fallback",
"max_iterations": 150,
@@ -144,7 +167,6 @@
"timeout_ms": 5000,
"verbose": false
},
"metadata": {
"refrigerant": "R134a",
"application": "Air-cooled chiller",
@@ -156,4 +178,4 @@
"n_coils": 4,
"n_circuits": 2
}
}
}

92
crates/cli/examples/chiller_screw_mchx_run.json
View File

@@ -1,9 +1,7 @@
{
"name": "Chiller Air-Glycol - Screw MCHX Run (Compatible)",
"description": "Simulation chiller 2 circuits avec ScrewEconomizerCompressor et MchxCondenserCoil. Les composants utilisent les n_equations compatibles avec le graphe (2 par arête).",
"fluid": "R134a",
"circuits": [
{
"id": 0,
@@ -33,20 +31,18 @@
{
"type": "MchxCondenserCoil",
"name": "mchx_0a",
"ua": 15000.0,
"coil_index": 0,
"n_air": 0.5,
"t_air_celsius": 35.0,
"fan_speed_ratio": 1.0
"ua_nominal_kw_k": 15.0,
"n_air_exponent": 0.5,
"air_inlet_temp_c": 35.0,
"fan_speed": 1.0
},
{
"type": "MchxCondenserCoil",
"name": "mchx_0b",
"ua": 15000.0,
"coil_index": 1,
"n_air": 0.5,
"t_air_celsius": 35.0,
"fan_speed_ratio": 1.0
"ua_nominal_kw_k": 15.0,
"n_air_exponent": 0.5,
"air_inlet_temp_c": 35.0,
"fan_speed": 1.0
},
{
"type": "Placeholder",
@@ -63,11 +59,26 @@
}
],
"edges": [
{ "from": "screw_0:outlet", "to": "mchx_0a:inlet" },
{ "from": "mchx_0a:outlet", "to": "mchx_0b:inlet" },
{ "from": "mchx_0b:outlet", "to": "exv_0:inlet" },
{ "from": "exv_0:outlet", "to": "evap_0:inlet" },
{ "from": "evap_0:outlet", "to": "screw_0:inlet" }
{
"from": "screw_0:outlet",
"to": "mchx_0a:inlet"
},
{
"from": "mchx_0a:outlet",
"to": "mchx_0b:inlet"
},
{
"from": "mchx_0b:outlet",
"to": "exv_0:inlet"
},
{
"from": "exv_0:outlet",
"to": "evap_0:inlet"
},
{
"from": "evap_0:outlet",
"to": "screw_0:inlet"
}
]
},
{
@@ -98,20 +109,18 @@
{
"type": "MchxCondenserCoil",
"name": "mchx_1a",
"ua": 15000.0,
"coil_index": 2,
"n_air": 0.5,
"t_air_celsius": 35.0,
"fan_speed_ratio": 1.0
"ua_nominal_kw_k": 15.0,
"n_air_exponent": 0.5,
"air_inlet_temp_c": 35.0,
"fan_speed": 1.0
},
{
"type": "MchxCondenserCoil",
"name": "mchx_1b",
"ua": 15000.0,
"coil_index": 3,
"n_air": 0.5,
"t_air_celsius": 35.0,
"fan_speed_ratio": 1.0
"ua_nominal_kw_k": 15.0,
"n_air_exponent": 0.5,
"air_inlet_temp_c": 35.0,
"fan_speed": 1.0
},
{
"type": "Placeholder",
@@ -128,15 +137,29 @@
}
],
"edges": [
{ "from": "screw_1:outlet", "to": "mchx_1a:inlet" },
{ "from": "mchx_1a:outlet", "to": "mchx_1b:inlet" },
{ "from": "mchx_1b:outlet", "to": "exv_1:inlet" },
{ "from": "exv_1:outlet", "to": "evap_1:inlet" },
{ "from": "evap_1:outlet", "to": "screw_1:inlet" }
{
"from": "screw_1:outlet",
"to": "mchx_1a:inlet"
},
{
"from": "mchx_1a:outlet",
"to": "mchx_1b:inlet"
},
{
"from": "mchx_1b:outlet",
"to": "exv_1:inlet"
},
{
"from": "exv_1:outlet",
"to": "evap_1:inlet"
},
{
"from": "evap_1:outlet",
"to": "screw_1:inlet"
}
]
}
],
"solver": {
"strategy": "fallback",
"max_iterations": 200,
@@ -144,7 +167,6 @@
"timeout_ms": 10000,
"verbose": false
},
"metadata": {
"refrigerant": "R134a",
"application": "Air-cooled chiller, screw with economizer",
@@ -156,4 +178,4 @@
"n_circuits": 2,
"design_capacity_kw": 400
}
}
}

52
crates/cli/examples/chiller_screw_mchx_validate.json
View File

@@ -18,16 +18,14 @@
{
"type": "MchxCondenserCoil",
"name": "mchx_0a",
"ua": 15000.0,
"coil_index": 0,
"t_air_celsius": 35.0
"ua_nominal_kw_k": 15.0,
"air_inlet_temp_c": 35.0
},
{
"type": "MchxCondenserCoil",
"name": "mchx_0b",
"ua": 15000.0,
"coil_index": 1,
"t_air_celsius": 35.0
"ua_nominal_kw_k": 15.0,
"air_inlet_temp_c": 35.0
},
{
"type": "Placeholder",
@@ -49,14 +47,38 @@
}
],
"edges": [
{ "from": "screw_0:outlet", "to": "splitter_0:inlet" },
{ "from": "splitter_0:out_a", "to": "mchx_0a:inlet" },
{ "from": "splitter_0:out_b", "to": "mchx_0b:inlet" },
{ "from": "mchx_0a:outlet", "to": "merger_0:in_a" },
{ "from": "mchx_0b:outlet", "to": "merger_0:in_b" },
{ "from": "merger_0:outlet", "to": "exv_0:inlet" },
{ "from": "exv_0:outlet", "to": "evap_0:inlet" },
{ "from": "evap_0:outlet", "to": "screw_0:inlet" }
{
"from": "screw_0:outlet",
"to": "splitter_0:inlet"
},
{
"from": "splitter_0:out_a",
"to": "mchx_0a:inlet"
},
{
"from": "splitter_0:out_b",
"to": "mchx_0b:inlet"
},
{
"from": "mchx_0a:outlet",
"to": "merger_0:in_a"
},
{
"from": "mchx_0b:outlet",
"to": "merger_0:in_b"
},
{
"from": "merger_0:outlet",
"to": "exv_0:inlet"
},
{
"from": "exv_0:outlet",
"to": "evap_0:inlet"
},
{
"from": "evap_0:outlet",
"to": "screw_0:inlet"
}
]
}
],
@@ -65,4 +87,4 @@
"max_iterations": 100,
"tolerance": 1e-6
}
}
}