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.0rc20.tar.gz (640.7 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.0rc20-py3-none-any.whl (291.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: imas_standard_names-0.7.0rc20.tar.gz
  • Upload date:
  • Size: 640.7 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.0rc20.tar.gz
Algorithm Hash digest
SHA256 5b70aa0acf8497b2b852c6396f7e54b89b181ae81103cb1234b933f1fa32bceb
MD5 b38d3ea20fe62e2291b32050fdb06f0a
BLAKE2b-256 2f2d0a329be8b1df4213137cd15131ca6d809fd453b771078935afcd338fda06

See more details on using hashes here.

Provenance

The following attestation bundles were made for imas_standard_names-0.7.0rc20.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.0rc20-py3-none-any.whl.

File metadata

File hashes

Hashes for imas_standard_names-0.7.0rc20-py3-none-any.whl
Algorithm Hash digest
SHA256 276434a689d4fbde66ffd72c299e91035fa32b1094c315c8e6b964d4ad823d28
MD5 8a87ce436ee141ec58a16422b1f3817c
BLAKE2b-256 b9d49a8895e2d0f0a7b2207e3ffde820852cda7ac83a10be9a3a1e44d40e7260

See more details on using hashes here.

Provenance

The following attestation bundles were made for imas_standard_names-0.7.0rc20-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