SimView Visualizer
SimView is a powerful and interactive tool for visualizing 3D models and terrain data in simulations. It enables you to explore and analyze multiple simulation scenarios (batches) within a shared environment, all defined through an intuitive JSON format or a Python API.
Whether you're simulating physical objects or comparing different runs, SimView provides a flexible and efficient way to bring your data to life using a web-based interface powered by Three.js.
Documentation
Full documentation — usage guides, CLI reference, the JSON format specification, the API reference, and developer/architecture docs — is available at:
https://vlk-jan.github.io/simview/
Want to try it without installing anything? There's a live browser demo (always up-to-date with the current code, no backend needed).
Features
- Batched Simulations: Visualize multiple simulation instances side-by-side.
- Shared Terrain: Efficient rendering with shared terrain across all batches.
- Interactive UI: Web-based controls for playback, camera, and data inspection.
- Python API: Easy-to-use API for generating scenes and launching the visualizer directly from your code.
- JSON Support: Load and save simulation data using a portable JSON format.
- Remote Files: Open a scene straight off a compute host with
simview host:path/to/scene.json— fetched over SSH, compressed on the wire, and cached locally. - Comparing Runs: Merge several scene files into one, taking whole files or just picked batches —
simview gt.json method_a.json#1 method_b.json#1.
Quick Start
The easiest way to get started is to run the provided example script:
python example.py
This script demonstrates how to use the Python API to create a simulation with wavy terrain, dynamic bodies, and time-series data.
The Python authoring API (simview.scene, simview.state, simview.model) depends on
torch and numpy. Install them with the optional authoring extra shown below.
Only these are needed to build simulations; viewing an existing JSON file does not
require torch.
Installation
Requires Python 3.12+.
From PyPI
To only view existing simulation JSON files:
pip install simview
To also author simulations from Python (installs torch and numpy):
pip install "simview[authoring]"
From source
For working on SimView itself (or to track an unreleased commit), install an editable checkout instead:
pip install -e . # viewing only
pip install -e ".[authoring]" # viewing + authoring
For independent use of this repository, use venv or uv:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[authoring]"
uv sync --extra authoring
source .venv/bin/activate
License
SimView is distributed under the BSD 3-Clause License. The web interface
vendors uPlot and three.js
(both MIT licensed) under
simview/static/lib/ so the viewer works fully offline — see the
documentation
for details. All third-party libraries used by SimView are permissively licensed
(MIT/BSD), so there are no licensing restrictions on commercial use.
1 maintainer
Metadata
1 maintainer
Release files for simview 6.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| simview-6.0.0.tar.gz | 713.6 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| simview-6.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.4 MB
Release files / simview-6.0.0.tar.gz
| Download URL | simview-6.0.0.tar.gz |
|---|---|
| Size | 713.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1b9e80babea533d06fb2ca5dbc1b3631e68153d9f5f5203f71ac3118f119764f
|
|
BLAKE2b-256 checksum How to use checksums |
4b50d662232d1353e35d4ec4c8a6a779a09a84a16cc23f6325ff5c4bd47560b6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 1, 2026.
Transparency logRelease files / simview-6.0.0-py3-none-any.whl
| Download URL | simview-6.0.0-py3-none-any.whl |
|---|---|
| Size | 687.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
210f7a2dea62a7e18486af0bb2a9941289fbbae7f065a1be8d169c327acb2092
|
|
BLAKE2b-256 checksum How to use checksums |
7692c25fdc122bf33ed10f6cc9d2974fea52949da532865d63e966c405ba717c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 1, 2026.
Transparency logSecurity for simview 6.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for simview-6.0.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 1, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
