Skip to content

Installation#

Installing a user environment#

Not on PyPI yet

math-spec is on the alpha stream. Every tag is published from build.yml, so the first upload is the first tag cut after the project's trusted publisher is registered — see RELEASING.md. The commands below are what that release will look like. Until it appears, install from a checkout or a git reference.

math-spec installs with any of the common package managers. Use a dedicated environment. If you are new to Python, pixi, conda and uv all run on Windows, macOS and GNU/Linux.

pixi add --pypi math_spec

uv add math_spec

conda create -n math-spec "python>=3.12" "pip"
conda activate math-spec
pip install math_spec

pip install math_spec

math-spec is written and tested against Python 3.12 and above. Use a version with active support (see endoflife.date).

Installing a development environment#

A development environment installs from a clone:

git clone https://github.com/energy-models/math-spec
cd math-spec

pixi run pre-commit-install
pixi run test

The development documentation has the rest.

Editor completion and offline checking#

The YAML keys ship as a JSON Schema, schema/math-spec.schema.json, generated from the same declarations that to_spec validates against. An editor reads it for key completion, and a job with no Python reads it for a structure check. The examples below read it over the network; a vendored copy takes a path in the same slot.

Map the schema in VS Code#

Install the Red Hat YAML extension, then map the schema per workspace:

// .vscode/settings.json
"yaml.schemas": { "https://raw.githubusercontent.com/energy-models/math-spec/main/schema/math-spec.schema.json": ["*.model.yaml"] }

or per file, with a modeline on its first line:

# yaml-language-server: $schema=https://raw.githubusercontent.com/energy-models/math-spec/main/schema/math-spec.schema.json

That gives key completion, hover documentation, the closed vocabulary behind dtype:, domain: and sense:, and a mark on a misspelled key.

Check a file without Python#

For a pre-commit hook or a non-Python CI job:

uvx check-jsonschema --schemafile https://raw.githubusercontent.com/energy-models/math-spec/main/schema/math-spec.schema.json model.yaml

The schema validates structure only. expression: and where: are strings to it, and the math inside them is checked by to_spec.