"Sim" or "SimRS" provides a discrete event simulation engine, to facilitate Rust- and npm-based simulation products and projects.
This repository contains:
Sim is compatible with a wide variety of compilation targets, including WebAssembly. Sim is built on stable Rust - it does not require nightly.
Simulation is a powerful tool for analyzing and designing complex systems. However, most simulators have steep learning curves, are proprietary, and suffer from limited portability. Sim aspires to reduce the time required to build new simulation products, complete simulation projects, and learn simulation fundamentals. Sim is open source and, by virtue of compilation target flexibility, relatively portable.
For use in Rust code bases, leverage the package as a cargo dependency
toml
[dependencies]
sim = "0.1"
For use as a WebAssembly module in a JavaScript/TypeScript code base, leverage the package as a npm dependency
bash
npm i sim-rs
Documentation will be available on docs.rs shortly
The test simulations are a good reference for creating, running, and analyzing simulations with Sim.
Simulation definitions are defined in a declarative YAML or JSON format, and then ingested through Simulation's post_yaml or post_json constructors.
Both models and connectors are required to define the simulation. For descriptions of the pre-built models, see MODELS.md A simple three-model simulation could be defined as:
Nodes:
yaml
- type: "Generator"
id: "generator-01"
portsIn: {}
portsOut:
job: "job"
messageInterdepartureTime:
exp:
lambda: 0.5
- type: "Processor"
id: "processor-01"
portsIn:
job: "job"
portsOut:
processedJob: "processed"
serviceTime:
exp:
lambda: 0.333333
queueCapacity: 14
- type: "Storage"
id: "storage-01"
portsIn:
store: "store"
read: "read"
portsOut:
stored: "stored"
Connectors:
yaml
- id: "connector-01"
sourceID: "generator-01"
targetID: "processor-01"
sourcePort: "job"
targetPort: "job"
- id: "connector-02"
sourceID: "processor-01"
targetID: "storage-01"
sourcePort: "processed"
targetPort: "store"
Simulations may be stepped with the step, step_n, and step_until methods. Input injection is possible with the inject_input method.
Analyzing simulations will typically involve some combination of listening to model metrics, collecting message transfers, and using output analysis tools. Analysis of IID samples and time series data are possible.
Issues, feature requests and pull requests are always welcome!
This project is licensed under either of Apache License, Version 2.0 or MIT License at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in sim by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.