Skip to content
/ suma Public

Management utility for SUMA (STEP Unified Model-Based Standards Architecture)

Notifications You must be signed in to change notification settings

metanorma/suma

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
Jun 18, 2024
Jun 7, 2024
Jun 7, 2024
Jan 10, 2025
Jun 7, 2024
Dec 21, 2024
Jun 7, 2024
Jun 7, 2024
Oct 17, 2024
Oct 17, 2024
Jun 7, 2024
Dec 27, 2024
Jun 7, 2024
Jun 7, 2024
Dec 27, 2024

Repository files navigation

Suma: utility for the STEP Unified Model-driven Architecture

Purpose

SUMA, the "STEP Unified Model-Based Standards Architecture", is a authoring and publication system developed for the management of EXPRESS schemas and its documentation.

This utility is used by the ISO 10303 collection to build the following artifacts:

  • the STEP Resource Library (SRL)

Install

$ gem install suma

Usage

General

# Defaults to `suma help`
$ suma
Commands:
  suma build METANORMA_SITE_MANIFEST  # Build collection specified in site manifest (`metanorma*.yml`)
  suma help [COMMAND]                 # Describe available commands or one specific command

Where:

METANORMA_SITE_MANIFEST

This is the path to the Metanorma site manifest, typically metanorma.yml.

Compilation

To compile SRL subset test collection
$ bundle exec suma build metanorma-test.yml
To build SRL collection
$ bundle exec suma build metanorma-srl.yml

Generating full schema listing files

We generate the full schema collection listing using the --no-compile option in the suma command.

The generated schemas-*.yaml file name is derived from the input file name with the word metanorma replaced with schemas.

$ bundle exec suma build --no-compile metanorma-srl.yml
# => generates schemas-srl.yml

All documents need to have a schemas.yaml in their document root that lists out which schemas the document includes.

License

Copyright Ribose. BSD 2-clause license.

About

Management utility for SUMA (STEP Unified Model-Based Standards Architecture)

Resources

Code of conduct

Stars

Watchers

Forks

Packages

No packages published