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": "ee_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": "ee_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.1.tar.gz (43.8 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.1-py3-none-any.whl (69.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simulac-0.0.1.tar.gz
  • Upload date:
  • Size: 43.8 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.1.tar.gz
Algorithm Hash digest
SHA256 a98852b2f2caebcd9d9efe6b818a3a2be7e4d613a0ecc985eb4dd7f08b35f888
MD5 82ae5dd3a21978b2ea9410ba61b70c82
BLAKE2b-256 e0e8ab2107df02dd1f3666ae0dbfd88eb3e28c639d1aceb573e36d0e238533fb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: simulac-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 69.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 79c090e92d0f0d203272221f9fdad4cb837e5466ffac10ac508409ad189dc6ee
MD5 d18adfe5b1c4ccfb3bdc2ef8153106a8
BLAKE2b-256 119cfddeed66d9b7c277755b900fff94f52082b6650e0dc779dce2fa6720d059

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