Documentation Index

Fetch the complete documentation index at: https://docs.smlcrm.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Quickstart

​

Prerequisites

• Python 3.11.13 or newer.
• A Simulacrum account at app.smlcrm.com with an API key that has forecasting permissions.
• Network access to https://api.smlcrm.com/.

​

1. Create your Simulacrum account

1. Visit app.smlcrm.com and create or join your workspace.
2. Select API Keys on the left navigation bar and generate a key with forecasting access.
3. Store the key securely (for example in a secrets manager) and copy it for the next steps.

​

2. Install

pip install simulacrum-sdk

pip install "simulacrum-sdk==0.2.0"

​

3. Configure credentials

from simulacrum import Simulacrum

client = Simulacrum(api_key="sim-key_id-secret")

export SIMULACRUM_API_KEY="sim-key_id-secret"

import os
from simulacrum import Simulacrum

client = Simulacrum(api_key=os.environ["SIMULACRUM_API_KEY"])

​

4. Send your first forecast

from simulacrum import Simulacrum
import numpy as np

client = Simulacrum(api_key="sim-key_id-secret")
series = np.array([101.2, 103.6, 106.5, 109.3])
forecast = client.forecast(series=series, horizon=3, model="tempo")
print("Forecast:", forecast.tolist())

​

5. Validate the API key

validation = client.validate()
if not validation.valid:
    raise RuntimeError("API key is not active")

print("Client ID:", validation.client)
print("Expires at:", validation.expires_at)

​

Next steps

• Review the forecasting guide for batching and model selection patterns.
• Explore the error handling guide to harden production pipelines.
• Dive into the Python SDK reference for details on every method exposed by the package.