Skip to main content

A collection of Standard Names used in the Fusion Conventions and logic for creating a static website for documentation.

Project description

pre-commit Ruff Python versions CI/CD status Coverage status Documentation

IMAS Standard Names

Grammar library and read-only MCP server for IMAS Standard Names — a controlled vocabulary for fusion data variables.

Quick Start

MCP Server

Configure your AI assistant to use the standard names tools:

# Install the MCP server
uv tool install imas-standard-names

# Or with pip
pip install imas-standard-names

Add to your MCP configuration (e.g., Claude Desktop, VS Code):

{
  "mcpServers": {
    "imas-standard-names": {
      "command": "standard-names-mcp"
    }
  }
}

Python Library

from imas_standard_names import StandardNameCatalog

catalog = StandardNameCatalog()
entry = catalog.get("electron_temperature")
print(f"{entry.name}: {entry.unit}{entry.description}")

Installation

The tools and catalog are distributed separately:

Package Purpose
imas-standard-names Grammar library, validation, read-only MCP server
imas-standard-names-catalog Standard names catalog (YAML + SQLite)

Basic Installation

# Tools + catalog (recommended)
pip install imas-standard-names[catalog]

# Tools only
pip install imas-standard-names

Catalog Options

The catalog can be accessed in several ways:

# Option 1: Install catalog package (recommended)
pip install imas-standard-names-catalog

# Option 2: Download pre-built database
wget https://github.com/iterorganization/imas-standard-names-catalog/releases/latest/download/catalog.db
export STANDARD_NAMES_CATALOG_DB=./catalog.db

# Option 3: Clone catalog repository (for development)
git clone https://github.com/iterorganization/imas-standard-names-catalog.git
export STANDARD_NAMES_CATALOG_ROOT=./imas-standard-names-catalog/standard_names

Development Setup

git clone https://github.com/iterorganization/imas-standard-names.git
cd imas-standard-names
uv sync

Architecture

This project uses a two-repository architecture:

Name generation is handled by imas-codex, which uses ISN's grammar API to mint candidates.

This separation allows independent versioning — catalog content, tooling, and generation logic evolve separately.

Documentation

Full documentation: iterorganization.github.io/IMAS-Standard-Names

MCP Tools

The MCP server provides read-only tools for AI assistants to work with standard names:

Grammar & Schema

Tool Purpose
get_grammar Grammar rules, patterns, and composition guidance
get_schema Entry schema for understanding catalog entry structure
compose_standard_name Build valid names from structured parts
parse_standard_name Parse names into grammatical components
get_vocabulary Controlled vocabulary tokens by grammar segment

Catalog Query

Tool Purpose
search_standard_names Find names by concept using semantic search
list_standard_names List names with filtering by status, tags, kind
fetch_standard_names Get complete metadata for specific names
check_standard_names Fast batch validation of name existence

Reference & Validation

Tool Purpose
validate_catalog Check catalog integrity and grammar compliance
get_tokamak_parameters Reference tokamak machine parameters

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

imas_standard_names-0.7.0rc19.tar.gz (639.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

imas_standard_names-0.7.0rc19-py3-none-any.whl (289.9 kB view details)

Uploaded Python 3

File details

Details for the file imas_standard_names-0.7.0rc19.tar.gz.

File metadata

  • Download URL: imas_standard_names-0.7.0rc19.tar.gz
  • Upload date:
  • Size: 639.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for imas_standard_names-0.7.0rc19.tar.gz
Algorithm Hash digest
SHA256 3f7677e113aa2f4558142a079cbc952794268af96817c261664cb8b276032ea1
MD5 3d5c4b998fe634aae375bcc033c0367e
BLAKE2b-256 92fdc9595acc757f0b2a83ec2ce55c404ad50a0d57b9e263c8887640fc98497f

See more details on using hashes here.

Provenance

The following attestation bundles were made for imas_standard_names-0.7.0rc19.tar.gz:

Publisher: release.yml on iterorganization/IMAS-Standard-Names

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file imas_standard_names-0.7.0rc19-py3-none-any.whl.

File metadata

File hashes

Hashes for imas_standard_names-0.7.0rc19-py3-none-any.whl
Algorithm Hash digest
SHA256 c0a06f329b0e780c15d4c999669ece7b67f11e671269ce0de455026bc6ba81b7
MD5 ff23a58420451f3ce40bcb9d730d48bc
BLAKE2b-256 703830bab8b3a5fbbbe0f4de814e682343f58122b6de010e0a1f922ed19a8418

See more details on using hashes here.

Provenance

The following attestation bundles were made for imas_standard_names-0.7.0rc19-py3-none-any.whl:

Publisher: release.yml on iterorganization/IMAS-Standard-Names

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page