chore: sync project state and current artifacts
This commit is contained in:
64
README.md
64
README.md
@@ -1,47 +1,37 @@
|
||||
# Entropyk - Thermodynamic Simulation Framework
|
||||
# Entropyk
|
||||
|
||||
Entropyk is a high-performance, type-safe Rust library for simulating thermodynamic cycles and systems. It provides a robust framework for modeling complex HVAC/R systems with multi-circuit support and thermal coupling.
|
||||
High-performance thermodynamic simulation engine for HVAC/R and industrial systems.
|
||||
|
||||
## Key Features
|
||||
## 📚 Documentation & Theory
|
||||
|
||||
- **🛡️ Type-Safe Physics**: Unit-safe quantities (Pressure, Temperature, Enthalpy, MassFlow) via NewType wrappers.
|
||||
- **🧱 Component-Based**: Reusable blocks for Compressors (AHRI 540), Heat Exchangers (LMTD, ε-NTU), Valves, Pumps, and Fans.
|
||||
- **🔄 Multi-Circuit Support**: Model complex systems with multiple refrigerant or fluid loops.
|
||||
- **🔥 Thermal Coupling**: Sophisticated API for heat exchange between circuits.
|
||||
- **🖥️ Visual UI**: Interactive web interface for drag-and-drop system modeling.
|
||||
- **🚀 Performant Solvers**: Integrated Newton-Raphson solvers for system convergence.
|
||||
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
|
||||
## Quick Start (Rust)
|
||||
|
||||
### Prerequisites
|
||||
- [Rust](https://www.rust-lang.org/) (latest stable)
|
||||
- (Optional) Node.js (if working on the frontend directly)
|
||||
|
||||
### Run the Demo
|
||||
Explore a complete Water Chiller simulation:
|
||||
```bash
|
||||
cargo run --bin chiller
|
||||
```toml
|
||||
[dependencies]
|
||||
entropyk = "0.1"
|
||||
```
|
||||
|
||||
### Launch the Visual UI
|
||||
Design your system graphically:
|
||||
```bash
|
||||
cargo run -p entropyk-demo --bin ui-server
|
||||
```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!");
|
||||
}
|
||||
```
|
||||
Then visit [http://localhost:3030](http://localhost:3030) in your browser.
|
||||
|
||||
## Project Structure
|
||||
## Features
|
||||
|
||||
- `crates/`: Core library logic, physical types, and component implementations.
|
||||
- `demo/`: Real-world application examples and system-level simulations.
|
||||
- `ui/`: Web-based interface for visual modeling.
|
||||
- `docs/`: Technical documentation and tutorials.
|
||||
|
||||
- **[Comprehensive Documentation](./DOCUMENTATION.md)**: The definitive guide to Entropyk features and architecture.
|
||||
- **[Exhaustive Examples](./EXAMPLES_FULL.md)**: Deep-dive code samples for all platforms (Rust, Python, C).
|
||||
- **[Tutorial](./docs/TUTORIAL.md)**: Step-by-step guide to using the library and UI.
|
||||
- **[Full Index](./docs/index.md)**: Directory of all project documentation.
|
||||
|
||||
## License
|
||||
|
||||
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
|
||||
- **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.
|
||||
|
||||
Reference in New Issue
Block a user