Metadata-Version: 2.2
Name: kos-sim
Version: 0.0.8
Summary: The simulator backend for the K-Scale Operating System (KOS)
Home-page: https://github.com/kscalelabs/kos-sim.git
Author: K-Scale Labs <ben@kscale.dev>
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: colorlogging
Requires-Dist: kscale
Requires-Dist: mujoco
Requires-Dist: mujoco-scenes
Requires-Dist: mujoco-python-viewer
Requires-Dist: numpy
Requires-Dist: omegaconf
Requires-Dist: pykos
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: darglint; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Provides-Extra: examples
Requires-Dist: scipy; extra == "examples"
Requires-Dist: kinfer; extra == "examples"
Dynamic: author
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# kos-sim

`kos-sim` is a pure-simulation backend for the [K-Scale Operating System (KOS)](https://github.com/kscalelabs/kos), using the same gRPC interface.

## Installation

```bash
pip install kos-sim
```

## Getting Started

First, start the `kos-sim` backend:

```bash
kos-sim kbot-v1
```

Then, in a separate terminal, run the example client:

```bash
python -m examples.kbot
```

You should see the simulated K-Bot move in response to the client commands.
