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.10 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.2.tar.gz (50.1 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.2-py3-none-any.whl (78.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simulac-0.0.2.tar.gz
  • Upload date:
  • Size: 50.1 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.2.tar.gz
Algorithm Hash digest
SHA256 b9a758ec65914f6b4ac47ddc67ad1d05acc61707e3267f5b09a405b0a67eb087
MD5 3d88918bd78957a29b4ca52140444ff3
BLAKE2b-256 84d7a1d3a089393949253b43915231e5d2b2d601c9adafed49e36f2cff39215b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: simulac-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 78.6 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 845c794724d6cedafd453f958b891d1e82b070b01a725eff5b8542e2ee6e51e9
MD5 48553fcabc174153341d7ded95034d96
BLAKE2b-256 d046e15985f26abc4ed0c9e7dd6af72de15e00cd76cba6d626a4752a10e4aa5e

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