Quickstart

This page gets you from an installed SimDB to a catalogued, queried, and (optionally) shared simulation in a few minutes. For a fuller walkthrough, see the tutorial.

Prerequisites

1. Create a manifest

A manifest describes your simulation. Start from a template:

simdb manifest create manifest.yaml

Edit it to point at your data and describe the run:

manifest_version: 2
alias: my-first-simulation
inputs:
  - uri: file:///path/to/input/parameters.txt
outputs:
  - uri: file:///path/to/results/output.nc
metadata:
  - machine: ITER
  - code:
      name: JETTO
      version: "2024.1"
  - description: My first catalogued simulation.

Check that it is well-formed:

simdb manifest check manifest.yaml

2. Ingest it locally

simdb simulation ingest manifest.yaml

The simulation is now in your local catalogue. List and inspect it:

simdb simulation list
simdb simulation info my-first-simulation

3. Query locally

simdb simulation query code.name=JETTO

See query operators for the full syntax.

4. Push to a server (optional)

If you have access to a SimDB server, configure it once:

simdb remote config new myserver https://example.org/simdb/api
simdb remote config set-default myserver

Then validate and push:

simdb simulation validate my-first-simulation
simdb simulation push my-first-simulation

ITER users should follow Connect to ITER instead, which covers the firewall and certificate setup.

Where to go next