docs / onboarding

Getting Started

The onboarding path from environment setup through your first simulated execution. This guide walks through one complete operational loop: author .matr source, compile to a Molebyte, run simulation, then submit through FORMA under policy constraints.

Preconditions

Before starting, confirm the following are in place:

Account and access

An active Matterforma account with API credentials. Your token must have at least T1 consequence tier permissions for basic operations. Contact your organization admin if you need elevated access.

Project scope

A defined project context in the platform. Projects scope artifacts, runs, signals, and policies. Your first Molebyte will be created within this project.

Development environment

The .matr compiler toolchain installed locally. The CLI provides compilation, local simulation, and artifact upload commands.

Policy context

Familiarity with your organization's active policies. Consequence tier and compute tier assignments determine what approval workflows your artifacts will require.

Step 1: Author a .matr program

Start with a simple threshold gate. Create a file named threshold.matr:

meta {
  name: "threshold-gate-v1"
  version: "0.1.0"
  author: "your-team"
}

substrate {
  type: molecular
  pool: "default"
  min_confidence: 0.85
}

constraints {
  consequence_tier: T1
  max_cost: 0.05
  drift_tolerance: 0.10
}

logic {
  gate THRESHOLD(input: signal) -> classification {
    if (input.value > 0.8) return 1
    return 0
  }
}

Step 2: Compile to a Molebyte

Compile the .matr source into a Physical Execution Package and package it as a Molebyte:

$ mf compile threshold.matr

Compiling threshold.matr...
  Validating constraints... ok
  Resolving substrate requirements... ok
  Generating PEP... ok
  Computing artifact hash... sha256:a4f2e8c91b...

Molebyte created: threshold-gate-v1@0.1.0
  File: ./build/threshold-gate-v1-0.1.0.mb

Step 3: Run simulation (Material Twin)

Validate the Molebyte against a Material Twin substrate model before physical execution on Material Cloud:

$ mf simulate ./build/threshold-gate-v1-0.1.0.mb

Running simulation (2048 iterations)...
  Substrate model: molecular_v2
  Output distribution: mean=0.89, std=0.04
  Confidence: 0.91 [0.85, 0.96]
  Cost estimate: 0.031
  Constraint feasibility: all pass

Simulation evidence attached to artifact.

Step 4: Upload and submit

Upload the Molebyte to Vault and submit a run request:

$ mf upload ./build/threshold-gate-v1-0.1.0.mb

Uploading to Vault...
  Artifact ID: mb_01HQ3X7K9NFAA2RPWDG5B8VCMT
  Simulation evidence: attached
  Status: compiled -> simulated

$ mf run submit mb_01HQ3X7K9NFAA2RPWDG5B8VCMT

Submitting run request...
  Policy evaluation: T1, auto-approved
  Pool assignment: pool_molecular_01
  Run ID: run_01HQ4A8M2KPBB3SQXEG6C9WDNR
  State: pending -> approved -> scheduled

First milestone

After completing these steps, you have produced a versioned Molebyte with simulation evidence, passed policy evaluation, and submitted your first run request. The run will produce a signal with output distributions that you can compare against the simulation baseline.

What this guide does not cover

This page covers the operational onboarding sequence. It does not claim substrate feasibility or validate scientific assumptions. For formal evidence and model boundaries, consult the Research corpus. For advanced authoring patterns and team workflow conventions, see the Developer Handbook.