Skip to content

structural-explainability/se-mapspec

Repository files navigation

se-mapspec

Docs Site Repo Python 3.15+ License

CI Docs Links

Structural Explainability MapSpec: mapping vocabulary and structural correspondence rules for the SE ecosystem.

Context

se-constitution

  • defines rules

se-kernel

  • defines primitives those rules depend on

se-admin

  • enforces rules across repositories

se-mapspec

  • defines how structures correspond across systems

Owns

  • mapping vocabulary
  • mapping relation patterns
  • constraints for expressing mappings between artifacts

Includes

mapping primitives

  • source-target relationships
  • correspondence identifiers

mapping structure

  • how mappings are declared
  • how elements align across systems

mapping constraints

  • allowed mapping forms
  • structural consistency requirements

reference patterns

  • stable references between mapped elements

Elsewhere

  • se-mapping-*
  • se-adapter-*

Other projects will provide:

  • adapters
  • runtime transformations
  • runtime connectors
  • data processing logic
  • domain semantics

Command Reference

Show command reference

In a machine terminal

Open a machine terminal where you want the project:

git clone https://github.com/structural-explainability/se-mapspec

cd se-mapspec
code .

In a VS Code terminal

uv self update
uv python pin 3.15
uv sync --extra dev --extra docs --upgrade

uvx pre-commit install

git add -A
uvx pre-commit run --all-files
# repeat if changes were made
git add -A
uvx pre-commit run --all-files

# run the module
uv run python -m se_mapspec

# do chores
npx markdownlint-cli "**/*.md" --fix
uv run python -m ruff format .
uv run python -m ruff check . --fix
uv run python -m pyright
uv run python -m pytest
uv run python -m zensical build

# save progress
git add -A
git commit -m "update"
git push -u origin main

Citation

CITATION.cff

License

LICENSE

Manifest

SE_MANIFEST.toml