38 lines
1.3 KiB
Markdown
38 lines
1.3 KiB
Markdown
# Entropyk
|
|
|
|
High-performance thermodynamic simulation engine for HVAC/R and industrial systems.
|
|
|
|
## 📚 Documentation & Theory
|
|
|
|
Entropyk is built on rigorous physical principles.
|
|
- **[Technical Manual](./DOCUMENTATION.md)**: Exhaustive documentation of physical models (AHRI 540, ε-NTU), solver algorithms (Newton-Raphson, Picard), and multi-platform API parity.
|
|
- **[Comprehensive Examples](./EXAMPLES_FULL.md)**: Advanced scenarios including multi-circuit chillers, inverse control optimization, and HIL integration guide.
|
|
|
|
## Quick Start (Rust)
|
|
|
|
```toml
|
|
[dependencies]
|
|
entropyk = "0.1"
|
|
```
|
|
|
|
```rust
|
|
use entropyk_solver::{System, FallbackConfig};
|
|
|
|
fn main() {
|
|
let mut system = System::new();
|
|
// ... define components and edges ...
|
|
system.finalize().unwrap();
|
|
|
|
let result = FallbackConfig::default().solve(&system).unwrap();
|
|
println!("System Converged!");
|
|
}
|
|
```
|
|
|
|
## Features
|
|
|
|
- **Physics-First**: Strong typing for Pressure, Temperature, and Enthalpy.
|
|
- **Fluid Backends**: CoolProp (RefProp compatible) and high-speed Tabular interpolators.
|
|
- **Advanced Solvers**: Newton-Raphson with Armijo line search and Picard robust fallback.
|
|
- **Inverse Control**: Built-in support for parameter estimation and design-to-target.
|
|
- **Multi-Platform**: First-class support for Python, C/FFI, and WebAssembly.
|