IMAS Simulation Database Management Tool Version 0.15

SimDB is the IMAS simulation database management tool designed to track, manage and validate simulations and allow for these simulations to be sent for remote archiving and verification.

A user guide can be found at here.

Contents

User Documentation

• SimDB Installation Guide
  • Installing simdb
  • Installing simdb with specific extras:
• SimDB CLI Tutorial
  • Checking the CLI
  • CLI help
  • Creating a simulation manifest
  • Ingesting the manifest
  • Pushing the simulation to a remote server
  • Authentication
• SimDB user guide
  • Basic usage
  • Key Concepts
  • Local simulation management
  • Alias Naming Rules
  • IMAS URI schema
  • AL4 MDSplus data migration
  • Remote SimDB servers
  • Pushing simulations to a remote
  • Pulling simulations from a remote
  • Querying remotes
  • Accessing Simulation Metadata via the SimDB Dashboard
• SimDB CLI commands
  • Alias
  • Config
  • Database
  • Manifest
  • Provenance
  • Remote
  • Simulation
• Connecting to the ITER remotes
  • Adding the ITER remote
  • Testing the ITER remote

Developer Documentation

• Developer Guide
  • Setting up devloper environment
  • Running the tests
  • Running a development server
  • Setting up PostgreSQL Database
• SimDB server maintenance guide
  • Installing SimDB
  • Running the server (using built-in http server)
  • Using SSL
  • Running the server behind nginx & gunicorn
  • Setting up PostgreSQL database
• simdb package
  • Subpackages
  • Submodules
• SimDB technical design
  • Introduction
  • Supported Platforms
  • High level description
  • CLI functionality
  • Use case narratives and system processing actions
  • Contents of the metadata file proforma
  • Simulation Validation Testing