Holarch

Руководство · SysML v2

Инструменты SysML v2: что проверить перед выбором

Прослушать это руководство 16 мин

Руководство по оценке инструментов SysML v2: что проверить у любого кандидата, как отличить реальную поддержку от слайда, таблица-чек-лист для их оценки и небольшая тестовая модель для загрузки в каждый.

На этой странице
  1. Почему инструменты SysML v2 нужно оценивать отдельно
  2. Что проверить
    1. Покрытие языка и то, как документируются пробелы
    2. Текстовая нотация: редактирование и проверка
    3. Графические представления и синхронизация текста с диаграммами
    4. Стандартная библиотека
    5. Systems Modeling API
    6. Обмен JSON и круговой обмен
    7. Миграция с SysML v1
    8. Совместная работа и управление версиями
    9. Требования и верификация в модели
    10. Анализ и вычисления с единицами
    11. Развёртывание: облако или собственный сервер
    12. Лицензирование и стоимость
    13. Обучение
  3. Чек-лист оценки
  4. Тестовая модель для загрузки в любой инструмент-кандидат
    1. Две пробы для инструмента проверки
  5. Проведение оценки
  6. Ответы Holarch на чек-лист
  7. Попробуйте в Holarch
  8. Что дальше

Почему инструменты SysML v2 нужно оценивать отдельно

SysML v2 — новый язык, а не редакция SysML v1 (раздел чем различаются SysML v1 и v2 сравнивает их подробно). В нём есть текстовая нотация наряду с графической, формальная семантическая основа в KerML, стандартная библиотека величин, единиц и видов представлений и стандартный API для чтения и записи моделей. Инструмент может заявлять о поддержке SysML v2 и при этом охватывать лишь часть этого, а пропущенные части могут оказаться именно теми, от которых зависит ваша программа.

Спецификация велика, и каждый инструмент реализует её поэтапно. Это нормально. В оценке важно знать, какие этапы инструмент прошёл, какие нет, и говорит ли об этом поставщик прямо. Проверки ниже применимы к любому инструменту SysML v2, какой бы ни была его цена или способ развёртывания, а тестовая модель даёт одинаковые входные данные для каждого кандидата.

Чтобы найти кандидатов, начните со списка инструментов SysML v2, который ведёт OMG, и сводки возможностей инструментов SysML v2, опубликованной INCOSE и OMG для поддержки перехода с SysML v1. И то и другое — отправные точки: возьмите из них названия, затем проверьте каждый инструмент сами.

Что проверить

Покрытие языка и то, как документируются пробелы

Запросите заявление о покрытии: каждая область языка (пакеты, определения и использования, специализация и переопределение, кратности, значения и единицы, ограничения, структура, действия, состояния, требования, сценарии использования, случаи анализа и верификации, представления, метаданные, вариативность, индивиды и временные срезы) с уровнем для каждой. Полезные уровни различают четыре случая:

  • инструмент разбирает, проверяет и использует конструкцию;
  • он делает это с названными ограничениями;
  • он сохраняет конструкцию точно в том виде, в каком она записана, но не придаёт ей смысла (она переживает круговой обмен, но ничто её не проверяет и не вычисляет);
  • он её не принимает.

Поставщика, который публикует известные пробелы, легче учитывать в планах, чем того, кто перечисляет только возможности. Считайте «поддерживает SysML v2» без таблицы покрытия неизвестной величиной и проверяйте конструкции, которые используют ваши модели.

Текстовая нотация: редактирование и проверка

Текстовая нотация — то, чем SysML v2 больше всего отличается от v1, и то, в чём больше всего различаются инструменты. Проверьте:

  • Редактирование: подсветку синтаксиса, автодополнение имён и ключевых слов, переход к определению, переименование по всей модели, поиск и замену.
  • Проверку по мере ввода: синтаксические ошибки — это минимум. Полезный инструмент проверки также разрешает каждое имя через импорты, сообщает о повторяющихся и неоднозначных именах, проверяет переопределения по унаследованному, сравнивает размерности единиц и сравнивает направления портов и потоков по соединениям.
  • Текст — это модель: видят ли все остальные представления изменение после правки, или текст — это файл, который инструмент время от времени импортирует?
  • Текст, написанный не инструментом: загрузите текст, написанный вручную или другим инструментом. Комментарии, документация и форматирование текста должны сохраниться.

Графические представления и синхронизация текста с диаграммами

В SysML v2 представление — элемент модели: оно указывает, что оно показывает и фильтрует, а инструмент его отображает. Стандартная библиотека определяет представления General, Interconnection, Action Flow, State Transition, Sequence и Grid. Проверьте, какие из них инструмент рисует, в каких можно редактировать и как он обрабатывает компоновку, которую спецификация оставляет на усмотрение инструмента.

Ключевой тест — синхронизация в обоих направлениях. Переименуйте часть в тексте и посмотрите на каждую диаграмму, которая её показывает. Добавьте соединение на диаграмме и прочитайте получившийся текст. Затем измените обе стороны одновременно, если это могут сделать два человека, и посмотрите, что инструмент сделает с конфликтом.

Стандартная библиотека

Значительная часть смысла SysML v2 заключена в его стандартной библиотеке: скалярные значения, Международная система величин, единицы SI и американские традиционные единицы, стандартные определения представлений и библиотеки ядра KerML. Инструмент должен поставлять библиотеку, разрешать имена по ней и вычислять с ней. Проверьте, что роды величин ISQ и единицы SI разрешаются, что библиотеку нельзя случайно изменить и какую версию библиотеки использует инструмент.

Systems Modeling API

Systems Modeling API — стандартный интерфейс REST к репозиторию моделей: проекты, ветки, коммиты и элементы. Он позволяет инструментам обмениваться моделями без файлов, а вашим собственным сценариям — читать модели. Инструмент может выступать в двух ролях, и любая из них может быть только для чтения:

  • Клиент: инструмент получает данные из другого репозитория, предоставляющего API, и отправляет в него.
  • Сервер: инструмент предоставляет API, чтобы другие инструменты читали, а возможно, и записывали его модели.

Спросите, какая роль, какие маршруты и доступны ли запись, запросы, сравнения и более старые коммиты. Сервер только для чтения всё равно полезен для отчётов и для передачи данных инструментам анализа; его недостаточно, когда другой инструмент должен менять модель.

Обмен JSON и круговой обмен

Помимо текста, модели передаются между инструментами в SysML v2 JSON — формате элементов API с идентификатором у каждого элемента. Идентификаторы важны: в тексте их нет, поэтому инструмент, повторно импортирующий текст, может сопоставлять элементы только по имени, а JSON сохраняет идентичность при обмене. Проверьте круговой обмен: экспортируйте из инструмента A, импортируйте в инструмент B, снова экспортируйте и импортируйте в A. Затем сравните количество элементов, имена, значения с единицами и отношения и прочитайте, как каждый инструмент сообщает о том, что отбросил. Виды элементов, которые инструмент не поддерживает, — это места, где круговой обмен теряет данные.

Миграция с SysML v1

Перевода из v1 в v2 без потерь в автоматическом режиме не существует: языки различаются по структуре, а диаграммы v1 несут компоновку и стереотипы, у которых нет единственного эквивалента в v2. Спросите, как инструмент принимает модели v1 (обычно XMI с профилем SysML 1.x), во что он отображает блоки, части, порты, деятельности, конечные автоматы и требования и формирует ли он отчёт о том, что не преобразовалось. Проверьте это на одной из своих моделей v1, а не на образце поставщика.

Совместная работа и управление версиями

Модели систем — командная работа. Проверьте, могут ли несколько человек редактировать одновременно и как показываются и разрешаются конфликты, какие есть роли (редактирование, рецензирование, просмотр), как работают история и базовые линии и можно ли сравнить две версии поэлементно и как текст. Если ваша организация хранит модели в репозитории, проверьте ветки, объединения и то, как собственная история версий инструмента соотносится с коммитами репозитория.

Требования и верификация в модели

В SysML v2 требование — это ограничение на субъект с отношениями satisfy и verify к проекту и случаям верификации. Проверьте, что инструмент хранит текст требования и ограничение вместе, вычисляет ограничение по значениям модели и строит матрицу верификации из связей verify. Проверьте также, что инструмент хранит вне языка: статус требований, утверждения, результаты испытаний и подозрительные связи после изменения. Это не часть текста SysML v2, поэтому спросите, где они хранятся и переносятся ли при экспорте.

Анализ и вычисления с единицами

Каждое значение в модели SysML v2 может нести единицу, и выражения их комбинируют. Проверьте, что инструмент вычисляет выражения с единицами (общую массу из масс трёх частей в килограммах), сообщает об ошибке размерности как об ошибке и вычисляет ограничения требований по результату. Затем проверьте нужные вам более крупные возможности анализа: решение параметрических задач, бюджеты и свёртки, анализ компромиссов, симуляцию потоков действий или конечных автоматов. Спросите, что вычисляется из модели, а что требует дополнительных данных, специфичных для инструмента.

Развёртывание: облако или собственный сервер

Проверьте, где хранится модель и кто эксплуатирует инструмент: размещённый сервис, настольная установка или сервер в вашей собственной среде. Для контролируемых данных или данных с экспортными ограничениями спросите о собственном размещении, расположении данных, вариантах входа и о том, как настраиваются или отключаются функции ИИ, если они есть.

Лицензирование и стоимость

Сравнивайте общую стоимость для вашей команды, а не прейскурантную цену за место: читатели и рецензенты, академическое или ознакомительное использование, стоимость API или серверного варианта и что станет с вашими моделями, если вы перестанете платить. Проверьте, доступен ли экспорт в стандартных форматах в каждом тарифе, чтобы ваши модели оставались вашими.

Обучение

SysML v2 нов для большинства инженеров, включая тех, кто свободно владеет v1. Ищите справочную документацию, которая описывает нотацию в объёме, поддерживаемом инструментом, рабочие примеры, демо-модель для изучения и пошаговые материалы по экранам самого инструмента. Обучение языку и обучение инструменту — разные потребности; проверьте, что покрыты обе.

Чек-лист оценки

Оценивайте каждого кандидата по одним и тем же вопросам и на одних и тех же входных данных. «Показано» означает, что вы видели, как это работает на тестовой модели или вашей собственной модели, а не на слайде.

ОбластьВопросКак проверить
Покрытие языкаОпубликована ли таблица покрытия с известными пробелами?Найдите в ней конструкции, которые используют ваши модели; загрузите тестовую модель
Текстовая нотацияПроверяет ли редактор имена, переопределения, единицы и направления по мере ввода?Загрузите две пробы; каждая должна давать одну проблему
Графические представленияКакие стандартные представления рисуются и редактируются?Откройте Interconnection View и представление переходов состояний тестовой модели
Синхронизация текста и диаграммПоявляется ли изменение на одной стороне сразу на другой?Переименуйте controller в тексте; добавьте соединение на диаграмме и прочитайте текст
Стандартная библиотекаРазрешаются ли величины ISQ, единицы SI и стандартные представления?Тестовая модель импортирует ISQ, SI и StandardViewDefinitions
Systems Modeling APIКлиент, сервер или оба? Только чтение или чтение и запись?Прочитайте элементы тестовой модели из другого инструмента или сценарием
Круговой обмен JSONСохраняются ли идентификаторы элементов? Что отбрасывается и сообщается ли об этом?Экспортируйте, импортируйте во второй инструмент, снова экспортируйте, сравните
Миграция с v1Есть ли путь импорта из SysML v1 с отчётом?Преобразуйте одну из своих моделей v1
Совместная работаОдновременное редактирование, роли, базовые линии, сравнение?Два человека редактируют один пакет; сравните с базовой линией
Требования и верификацияВычисляются ли ограничения и строится ли матрица верификации?Снизьте предел массы до 20 kg и убедитесь, что требование не выполняется
Анализ с единицамиВычисляются ли значения с единицами? Что ещё вычисляется?Проверьте, что totalMass вычисляется как 23 kg
РазвёртываниеРазмещённый сервис, настольная версия, собственный сервер?Запросите варианты в письменном виде, с расположением данных
Лицензирование и стоимостьОбщая стоимость для авторов, рецензентов и читателей; экспорт в каждом тарифе?Рассчитайте стоимость для вашей команды, включая рецензентов
ОбучениеСправочник по языку, примеры, руководства по инструменту?Попросите нового пользователя смоделировать тестовую систему только по документации

Тестовая модель для загрузки в любой инструмент-кандидат

Эта модель достаточно мала, чтобы её набрать, и всё же затрагивает большую часть того, что нужно для оценки: импорты из стандартной библиотеки, определения и использования частей с переопределёнными значениями и единицами, сопряжённые порты, соединения и связывание, конечный автомат, действие с последовательностями, два требования с ограничениями, satisfy, случай верификации и два представления. Сохраните её как pump-station.sysml и загрузите в каждый инструмент.

Система — насос для воды на солнечной энергии: панель питает контроллер, контроллер управляет насосом. Установка должна весить не более 25 kg, а пиковая мощность панели должна превышать номинальную мощность насоса не менее чем на 20 %. Если нотация для вас нова, учебник по SysML v2 знакомит с каждой конструкцией, которую использует эта модель.

package PumpStation {
  doc /* A solar-powered water pump: a small probe model for evaluating SysML v2 tools. */

  private import ScalarValues::*;
  private import ISQ::*;
  private import SI::*;

  port def PowerPort {
    out attribute voltage : ElectricPotentialValue;
  }

  port def WaterPort {
    out attribute pressure : PressureValue;
  }

  part def SolarPanel {
    attribute mass : MassValue;
    attribute peakPower : PowerValue;
    port powerOut : PowerPort;
  }

  part def Controller {
    attribute mass : MassValue;
    port powerIn : ~PowerPort;
    port motorOut : PowerPort;
  }

  part def Pump {
    attribute mass : MassValue;
    attribute ratedPower : PowerValue;
    port powerIn : ~PowerPort;
    port outlet : WaterPort;
  }

  item def StartSignal;
  item def StopSignal;

  state def PumpModes {
    entry; then idle;
    state idle;
    state pumping;
    transition first idle accept StartSignal then pumping;
    transition first pumping accept StopSignal then idle;
  }

  action def DeliverWater {
    action convertSunlight;
    action regulatePower;
    action driveImpeller;
    first start then convertSunlight;
    first convertSunlight then regulatePower;
    first regulatePower then driveImpeller;
    first driveImpeller then done;
  }

  part def PumpUnit {
    part panel : SolarPanel {
      attribute redefines mass = 12 [kg];
      attribute redefines peakPower = 400 [W];
    }
    part controller : Controller {
      attribute redefines mass = 2 [kg];
    }
    part pump : Pump {
      attribute redefines mass = 9 [kg];
      attribute redefines ratedPower = 300 [W];
    }
    port outlet : WaterPort;

    connect panel.powerOut to controller.powerIn;
    connect controller.motorOut to pump.powerIn;
    bind outlet = pump.outlet;

    attribute totalMass : MassValue = panel.mass + controller.mass + pump.mass;
    exhibit state modes : PumpModes;
  }

  part pumpUnit : PumpUnit {
    perform action delivery : DeliverWater;
  }
}

package PumpRequirements {
  private import PumpStation::*;
  private import ScalarValues::*;
  private import ISQ::*;
  private import SI::*;

  requirement def <'PS-1'> MassLimit {
    doc /* The pump unit shall weigh no more than the mass limit, so that one person can carry it. */
    subject unit : PumpUnit;
    attribute limit : MassValue;
    require constraint { unit.totalMass <= limit }
  }

  requirement def <'PS-2'> PowerMargin {
    doc /* The panel's peak power shall exceed the pump's rated power by at least 20 %. */
    subject unit : PumpUnit;
    require constraint { unit.panel.peakPower >= 1.2 * unit.pump.ratedPower }
  }

  requirement pumpSpec {
    subject unit : PumpUnit;
    requirement mass : MassLimit {
      attribute redefines limit = 25 [kg];
    }
    requirement power : PowerMargin;
  }

  satisfy pumpSpec by pumpUnit;

  verification def <'VC-1'> WeighUnit {
    doc /* Weigh the assembled pump unit on a calibrated scale. */
    subject unit : PumpUnit;
    objective {
      verify pumpSpec.mass;
    }
    return verdict : Boolean = unit.totalMass <= pumpSpec.mass.limit;
  }
}

package PumpViews {
  private import PumpStation::*;
  private import StandardViewDefinitions::*;

  view unitConnections : InterconnectionView {
    expose PumpStation::PumpUnit;
  }

  view pumpStates : StateTransitionView {
    expose PumpStation::PumpModes;
  }
}

Что должен показать инструмент, поддерживающий эти конструкции:

  • Ни ошибок, ни предупреждений. Инструмент, который сообщает здесь о проблемах, либо не поддерживает какую-то конструкцию, либо иначе читает стандартную библиотеку; спросите, что именно.
  • totalMass вычисляется как 23 kg: 12 kg + 2 kg + 9 kg.
  • Оба требования выполняются: 23 kg не превышает 25 kg, а 400 W больше, чем 1,2 × 300 W = 360 W.
  • unitConnections рисует панель, контроллер и насос с их портами, два соединения и выход, связанный с границей установки.
  • pumpStates рисует два состояния с начальным переходом и двумя переходами по триггерам.
  • Матрица верификации показывает PS-1, верифицированное VC-1, и PS-2 без случая верификации.

Две пробы для инструмента проверки

Инструмент проверки оправдывает себя на ошибках. Загружайте каждую пробу отдельно; в каждой ровно одна проблема.

Первая задаёт мощности значение в килограммах. Инструмент, проверяющий размерности, сообщает об ошибке в значении:

package UnitProbe {
  private import ISQ::*;
  private import SI::*;

  part def Pump {
    attribute ratedPower : PowerValue;
  }

  part pump : Pump {
    attribute redefines ratedPower = 300 [kg];
  }
}

Вторая разбирается и разрешается без ошибок, но её требование не выполняется: установка весит 11 kg при пределе 10 kg. Инструмент, вычисляющий ограничения требований, сообщает об этом; инструмент, который только разбирает текст, молча её принимает.

package RequirementProbe {
  private import ISQ::*;
  private import SI::*;

  part def Pump {
    attribute mass : MassValue;
  }

  part def Unit {
    part pump : Pump {
      attribute redefines mass = 9 [kg];
    }
    attribute totalMass : MassValue = pump.mass + 2 [kg];
  }

  requirement def Light {
    subject unit : Unit;
    require constraint { unit.totalMass <= 10 [kg] }
  }

  part unit : Unit;
  requirement light : Light;
  satisfy light by unit;
}

Обе пробы, как и тестовая модель, проверены языковым движком: модель не даёт проблем, а каждая проба даёт ровно одну описанную проблему.

Проведение оценки

  1. Сначала запишите свои потребности. Какие конструкции используют ваши модели, какие представления читают ваши рецензенты, какие инструменты должны обмениваться моделями и где могут храниться данные. Взвесьте по ним строки чек-листа.
  2. Прочитайте заявление о покрытии и известные пробелы каждого поставщика. Отметьте каждую строку чек-листа: заявлено, не заявлено или не указано.
  3. Загрузите тестовую модель и пробы в каждого кандидата. Запишите дословно, что сообщает каждый инструмент.
  4. Загрузите одну из своих моделей. Реальная модель находит проблемы, которых не находит ни один образец: размер, именование, необычные конструкции.
  5. Проведите один круговой обмен с инструментом, с которым вы обмениваетесь чаще всего.
  6. Попросите нового пользователя построить тестовую модель только по документации инструмента и засеките время.

Храните доказательства (снимки экрана, экспортированные файлы, сообщения каждого инструмента) вместе с оценками. Запись решения, показывающая, что проверялось, ценнее для комиссии по рецензированию, чем матрица возможностей, скопированная из материалов поставщика.

Ответы Holarch на чек-лист

Holarch — инструмент, с помощью которого сделаны снимки экрана на этой странице, поэтому вот его собственные ответы, каждый со страницей, которая его подтверждает. «Частично» и «Пока нет» означают ровно то, что сказано.

ОбластьУровеньHolarch сегодня
Покрытие языкаЧастичноОпубликованная таблица всех областей с уровнем, ограничениями и известными пробелами. Вариативность, индивиды и временные срезы, пользовательские ключевые слова и семантические метаданные проверяются и вычисляются; файлы .kerml пока не импортируются; текстовые представления на SysML и KerML проверяются, на других языках сохраняются как текст. Покрытие языка SysML v2
Текстовая нотацияПоддерживаетсяРедактор, проверяющий по мере ввода (синтаксис, имена, типизация, кратности, единицы, направления, вычисление), с автодополнением, переходом к определению, переименованием, поиском и заменой. Редактор, Проверки
Графические представленияЧастичноПредставления General, Interconnection, Action Flow, State Transition, Sequence и Grid, все редактируемые. Представления последовательности рисуют сообщения между линиями жизни и комбинированные фрагменты (alt, opt, loop и par). Представления SysML v2
Синхронизация текста и диаграммПоддерживаетсяОдна модель за текстом и каждым представлением; правка на одной стороне видна на другой. Текст и представления синхронизированы
Стандартная библиотекаПоддерживаетсяЗагружена и доступна только для чтения, с ISQ, SI и американскими традиционными единицами и стандартными определениями представлений. Стандартная библиотека
Systems Modeling APIЧастичноКак клиент: получение из одной ветки репозитория, предоставляющего API, и отправка в неё. Как сервер: другие инструменты читают текущую модель и делают коммиты в ветки запросов на изменение, которые утверждающий применяет в Holarch. Получение и отправка, Systems Modeling API
Круговой обмен JSONЧастичноИмпорт и экспорт SysML v2 JSON с сохранением идентификаторов элементов. Виды элементов, которые Holarch не интерпретирует, сохраняются в импортированном виде и записываются обратно без изменений при экспорте. Обмен моделями SysML v2
Миграция с v1ЧастичноПрямой импорт модели SysML 1.x (Cameo или MagicDraw .mdzip либо XMI из Cameo, Enterprise Architect, Rhapsody или Papyrus) в проект SysML v2 с преобразованием в текст SysML v2 и проверкой, с отчётом о том, что преобразовано, приближено или пропущено и почему. Диаграммы и их компоновка не преобразуются. Импорт моделей SysML v1
Совместная работаПоддерживаетсяСовместное редактирование в реальном времени с объединением по членам в редакторе, роли, базовые линии, хранящие модель, и сравнение по элементам и по тексту пакетов. Совместная работа, Базовые линии
Требования и верификацияПоддерживаетсяОграничения требований, вычисляемые по модели, RVTM и Центр тестирования, построенные из связей verify, утверждения, TBD/TBR и ссылки для проверки. Требования и верификация
Анализ с единицамиЧастичноВычисление с единицами, параметрические представления, решающие одну неизвестную на ограничение, бюджеты, анализ компромиссов и симуляция потоков действий и конечных автоматов. Случай анализа вычисляется, только когда у каждого входа есть значение. Вычисление, единицы и анализ
РазвёртываниеПоддерживаетсяРазмещённое веб-приложение, а по запросу — развёртывание в вашей собственной среде. Безопасность, Контакты
Лицензирование и стоимостьПоддерживаетсяТариф Free для студентов, преподавателей, личных проектов и индивидуальной оценки; компании могут бесплатно попробовать тариф Individual в течение 1 месяца; платные тарифы для коммерческого использования; бесплатные рецензенты и читатели в каждом тарифе. Цены
ОбучениеЧастичноСправочник Docs по каждой странице SysML v2, пошаговый учебник, демо Hybrid Car, девять пошаговых учебников по SysML v2 в приложении и серия видеоуроков по SysML v2, в которой строится модель Hybrid Car. Видеокурсы обучения посвящены проектам LML. Начало работы, Учебники по SysML v2, Учебник по SysML v2

Попробуйте в Holarch

  1. Сохраните тестовую модель как pump-station.sysml.
  2. Откройте Модель → Импорт и экспорт, выберите В новый проект SysML v2 и перетащите файл. См. импорт файлов в новый проект.
  3. Откройте Модель → Редактор. Строка состояния показывает «Проблем нет», а каждый пакет — это документ.
  4. Откройте список Диаграммы и щёлкните unitConnections или pumpStates.
  5. Откройте Верификация → RVTM, чтобы увидеть требования со случаем, который их верифицирует.
Тестовая модель в редакторе, без проблем.
Представление unitConnections: сопряжённые порты, два соединения и связывание.
RVTM, построенная из связи verify модели.

Что дальше