Metadata-Version: 2.4
Name: sebench
Version: 0.4.0
Summary: Hierarchical, multi-fidelity system simulation framework with a hardware-in-the-loop seam.
Project-URL: Homepage, https://github.com/danielnebenzahl/sebench
Project-URL: Repository, https://github.com/danielnebenzahl/sebench
Project-URL: Issues, https://github.com/danielnebenzahl/sebench/issues
Author: Daniel Nebenzahl
License: MIT License
        
        Copyright (c) 2026 Daniel Nebenzahl
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: digital-twin,discrete-event,hardware-in-the-loop,hil,simulation,systems-engineering
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: System :: Hardware
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: duckdb>=1.0
Requires-Dist: fastapi>=0.110
Requires-Dist: jinja2>=3.1
Requires-Dist: numpy>=1.26
Requires-Dist: pandas>=2.2
Requires-Dist: pyarrow>=15.0
Requires-Dist: pydantic>=2.6
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.7
Requires-Dist: sebench-protocol>=0.3.0
Requires-Dist: typer>=0.12
Requires-Dist: uvicorn>=0.29
Provides-Extra: dev
Requires-Dist: httpx>=0.27; extra == 'dev'
Requires-Dist: mypy>=1.9; extra == 'dev'
Requires-Dist: pre-commit>=3.6; extra == 'dev'
Requires-Dist: pytest-cov>=4.1; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.4; extra == 'dev'
Requires-Dist: types-pyyaml; extra == 'dev'
Description-Content-Type: text/markdown

# sebench

A Python framework for hierarchical, multi-fidelity system simulation with a hardware-in-the-loop seam.

Build abstract models of complex systems, drill down into concrete implementations, swap in real hardware without touching the rest, and get deterministic replay, trace analysis, and requirement verification along the way.

## Install

```bash
pip install sebench
```

The 3D-printer demo (`printerlab`) lives in this repo as a reference implementation. It is not published to PyPI.

## Quickstart

```bash
git clone https://github.com/<you>/sebench.git
cd sebench
make setup              # uv sync + pre-commit install
make demo-pyramid       # simulate printing a 20 mm pyramid (~10 s wall-clock)
make report-server      # open http://localhost:8765 to view the report
```

## Development workflow

### Daily work

```bash
git add <files>
git commit -m "your message"   # pre-commit runs: ruff fix, format, whitespace
git push                       # pre-push hook runs: lint + typecheck + unit tests
```

If pre-commit fixes files, re-add them and commit again:
```bash
git add <files>
git commit -m "your message"
```

### What CI does automatically (no action needed)

On every push to `main` or pull request:
- Ruff lint + format check
- Mypy type check
- Determinism lint
- Full test matrix (Python 3.11 / 3.12 / 3.13 on Ubuntu, macOS, Windows)
- Coverage report (must be ≥ 80%)
- Uploads `coverage.xml` and `test-results.xml` as artifacts

### Releasing to PyPI

1. Go to **Actions → Release sebench to PyPI → Run workflow**
2. Enter the version number (e.g. `0.2.0`)
3. Click **Run workflow** — everything else is automatic

The workflow will: bump `pyproject.toml`, commit + tag on `main`, run the full test suite, build the wheel, publish to PyPI, and create a GitHub Release with the build artifacts.

> **Prerequisite:** configure PyPI Trusted Publishing for this repo at pypi.org (Settings → Publishing).

## Docs

- **[User guide](docs/user-guide.md)** — run the demo, read the report, build a custom component
- [Vision](specs/00-vision.md) — what this is and why
- [Architecture](specs/02-architecture.md) — layered view
- [Visualization & reports](specs/08-visualization-and-reports.md) — UI reference
- [Roadmap](specs/11-roadmap.md) — milestones
- [ADRs](specs/adr/) — architectural decision records

## License

MIT. See [LICENSE](LICENSE).
