Skip to main content

A CLI, library, and local server for interacting with the Tektonian backend.

Project description

Simulac

⚡️ Developer centric digital twin builder


Simulac is digital twin build tool filling the gap between physical world and software world.

Simulac helps transition between the two worlds, and provides developer-friendly API to building the world.

Quick start

Installation

Simulac requires Python 3.12 or later.

$ pip install simulac
$ uv add simulac

Sign up and create an API key

Remote benchmark execution requires a Tektonian API key. Go to our website and get an API key.

Store your API key with CLI commend:

simulac login

You can also provide the key through an environment variable:

export SIMULAC_API_KEY=<you_api_key>

Note: API keys can only be viewed once when created

Key function

Simulac provides one-line code execution for robot domain benchmark, and world building API (on developing)

Benchmark

You can execution famous Physical-AI benchmarks with one-line of code. We currently support:

Visit benchmark list for details for running it.

Run benchmark

from simulac.gym_style import init_bench

env = init_bench(
    "Tektonian/Libero",
    "libero_90/KITCHEN_SCENE2_put_the_black_bowl_at_the_back_on_the_plate",
    0,
    {"control_mode": "OSC_POSE"},
)

step = env.step(ACTION_ARRAY)

Parallel Benchmark Execution

from simulac.gym_style import init_bench, make_vec

args = (
    "Tektonian/Libero",
    "libero_90/KITCHEN_SCENE2_put_the_black_bowl_at_the_back_on_the_plate",
    0,
)
options = {"benchmark_specific": {"control_mode": "OSC_POSE"}}

envs = [init_bench(*args, **options) for _ in range(3)]
vec_env = make_vec(envs)

steps = vec_env.step([[0.0] * 7 for _ in envs])
print(len(steps))

Configuration

Simulac reads configuration from environment variables when present:

  • SIMULAC_API_KEY: use an API key without running simulac login
  • SIMULAC_BASE_URL: override the default Tektonian API endpoint
  • SIMULAC_LOG_LEVEL: set log verbosity. choose one of off, trace, debug, info, warning, error
  • SIMULAC_TELEMETRY=off: disable telemetry

World building

The world-building surface is best viewed as an evolving foundation for scene assembly and engine integration.

Project Status

Simulac is currently alpha software.

  • The remote benchmark client is the most complete public surface.
  • Local world-building and runner APIs are still evolving.

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simulac-0.0.4.tar.gz (48.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simulac-0.0.4-py3-none-any.whl (77.9 kB view details)

Uploaded Python 3

File details

Details for the file simulac-0.0.4.tar.gz.

File metadata

  • Download URL: simulac-0.0.4.tar.gz
  • Upload date:
  • Size: 48.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for simulac-0.0.4.tar.gz
Algorithm Hash digest
SHA256 db19cf4be44168ed2bd6ce091238cbd53cdc15e8f12e7ae49c1691c83e973782
MD5 2e551f3b63c8fdd98857f2375956ecc3
BLAKE2b-256 ccba8f4e4e3e9ccf2c46be43f23fbf4500d5071f43a747b6703624caf5ce6966

See more details on using hashes here.

File details

Details for the file simulac-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: simulac-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 77.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for simulac-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d44960b42c528c24c7df77586df1b91368da99941bae67a6daf5a36fe5e27cb0
MD5 5ff7b24e1e553d95bbd9bc733568ea87
BLAKE2b-256 451859ce1a5fef66b05725924b450577628a8314446c3c5e4720a07d351f0572

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page