README.md

SimDB simulation management tool

SimDB tracks, manages, validates and shares scientific simulations. You describe a simulation and its data in a small manifest file, ingest it into your local catalogue, and push it to a shared SimDB server where colleagues can query, validate and reuse it. It is built for IMAS fusion-simulation workflows.

Quickstart

SimDB requires Python 3.11 or newer.

pip install imas-simdb
simdb --version

Catalogue a simulation and share it:

simdb manifest create manifest.yaml      # create and edit a manifest
simdb simulation ingest manifest.yaml    # add it to your local catalogue
simdb simulation push [REMOTE] SIM_ID    # push it to a server

Query simulations by metadata:

simdb simulation query code.name=SOLPS-ITER     # local
simdb remote [REMOTE] query code.name=SOLPS-ITER # on a server

See the quickstart guide for a full walkthrough.

Documentation

Full documentation is at simdb.readthedocs.io:

• Installation
• Tutorial: catalogue your first simulation
• CLI reference
• Connect to ITER
• Operating a server
• Developer guide

License

SimDB is licensed under the LGPLv3 license. See LICENSE.txt.

Contact

• Issues and feature requests: GitHub Issues
• Documentation: simdb.readthedocs.io