SysML2.NET

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 28 Open GitHub ↗

A .NET implementation of the OMG SysML2 specification

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# SysML2.NET

SysML2.NET is a .NET implementation of the [OMG SysML2 specification](https://github.com/Systems-Modeling/SysML-v2-Release). SysML2.NET provides a number of libraries in the form of a C# SDK.

> NOTE: Due to an error in the OMG published machine readable specifications, the current code is based on (generated from) https://github.com/Systems-Modeling/SysML-v2-Pilot-Implementation commit f1fd2b83e460f5695e8edcd780f43909f359d299 with comment `ST6RI-854 Updated metamodel files to latest Beta 4 version`.

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_SysML2.NET&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_SysML2.NET)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_SysML2.NET&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_SysML2.NET)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_SysML2.NET&metric=coverage)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_SysML2.NET)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_SysML2.NET&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_SysML2.NET)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_SysML2.NET&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_SysML2.NET)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_SysML2.NET&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_SysML2.NET)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_SysML2.NET&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_SysML2.NET)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_SysML2.NET&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_SysML2.NET)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_SysML2.NET&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_SysML2.NET)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_SysML2.NET&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_SysML2.NET)

## Installation

The packages are available on Nuget at:

project                                                                                               | Nuget
----------------------------------------------------------------------------------------------------- | ------------
[SysML2.NET](https://www.nuget.org/packages/SysML2.NET)                                               | ![NuGet Version](https://img.shields.io/nuget/v/SysML2.NET)
[SysML2.NET.Extensions](https://www.nuget.org/packages/SysML2.NET.Extensions)                         | ![NuGet Version](https://img.shields.io/nuget/v/SysML2.NET.Extensions)
[SysML2.NET.Serializer.Json](https://www.nuget.org/packages/SysML2.NET.Serializer.Json)               | ![NuGet Version](https://img.shields.io/nuget/v/SysML2.NET.Serializer.Json)
[SysML2.NET.Serializer.Xmi](https://www.nuget.org/packages/SysML2.NET.Serializer.Xmi)                 | ![NuGet Version](https://img.shields.io/nuget/v/SysML2.NET.Serializer.Xmi)
[SysML2.NET.Serializer.MessagePack](https://www.nuget.org/packages/SysML2.NET.Serializer.MessagePack) | ![NuGet Version](https://img.shields.io/nuget/v/SysML2.NET.Serializer.MessagePack)
[SysML2.NET.Serializer.TextualNotation](https://www.nuget.org/packages/SysML2.NET.Serializer.TextualNotation) | ![NuGet Version](https://img.shields.io/nuget/v/SysML2.NET.Serializer.TextualNotation)
[SysML2.NET.Kpar](https://www.nuget.org/packages/SysML2.NET.Kpar)                                     | ![NuGet Version](https://img.shields.io/nuget/v/SysML2.NET.Kpar)
[SysML2.NET.REST](https://www.nuget.org/packages/SysML2.NET.REST)                                     | ![NuGet Version](https://img.shields.io/nuget/v/SysML2.NET.REST)
[SysML2.NET.DAL](https://www.nuget.org/packages/SysML2.NET.DAL)                                       | ![NuGet Version](https://img.shields.io/nuget/v/SysML2.NET.DAL)

The reference web-application is available on [docker-hub](https://hub.docker.com/r/stariongroup/sysml2.net.viewer). A demo-version is hosted at http://viewer.sysml2.net.

The generated HTML based meta-model documentation is availabe on [docker-hub](https://hub.docker.com/r/stariongroup/sysml2.net.docs). A live version is available at https://modeldocs.sysml2.net.

## Build Status

GitHub actions are used to build and test the library

Branch | Build Status
------- | :------------
Master | ![Build Status](https://github.com/STARIONGROUP/SysML2.NET/actions/workflows/CodeQuality.yml/badge.svg?branch=master)
Development | ![Build Status](https://github.com/STARIONGROUP/SysML2.NET/actions/workflows/CodeQuality.yml/badge.svg?branch=development)

## API conventions

### 1-based positional operations

A small number of metaclass **operations** that take a positional index — notably `IActionUsage.Argument(int)` and `IActionUsage.InputParameter(int)` — are **1-based**, not 0-based. `Argument(1)` returns the *first* argument, and an index outside `1..count` returns `null`.

This is intentional: these methods are the C# realization of normative OMG SysML v2 metamodel operations (`ActionUsage::argument(i)`, `ActionUsage::inputParameter(i)`), which are 1-based per the specification and the [pilot implementation](https://github.com/Systems-Modeling/SysML-v2-Pilot-Implementation). The SDK is generated as a faithful mirror of the metamodel, so these operations preserve the specification's indexing rather than adopting the C# 0-based convention.

For idiomatic 0-based access, use the underlying collections directly (e.g. `InputParameters()`), which are ordinary 0-based `List<T>`. The 1-based operations are a specification-aligned convenience on top of those lists.

# Software Bill of Materials (SBOM) and Provenance

As part of our commitment to security, transparency, and traceability the docker images and nuget packaves Software Bill of Materials (SBOM), the docker containers also contain Provenance information. These are automatically generated during the build process, providing detailed insights into the components, their licenses, versions, and the integrity of the nugets and docker images. What is Included:

## SBOM (Software Bill of Materials):

- A comprehensive list of all open-source and third-party components included in the Docker images and nugets.
  - Tracks software dependencies, licenses, and versions.
  - Helps with vulnerability management by allowing users to quickly identify potential risks tied to specific components.

## Provenance:

- A record of the image's origin and build process, providing traceability and assurance regarding the integrity of the image.
  - This ensures that the image was built using the declared sources and under the specified conditions, helping verify its authenticity and consistency.

## Why SBOM and Provenance?

- Improved Transparency: Provides full visibility into the open-source and third-party components included in the image.
  - Security Assurance: Enables easier tracking of vulnerabilities associated with specific components, promoting proactive security measures.
  - Compliance: Ensures adherence to licensing requirements and simplifies audits of dependencies and build processes.
  - Image Integrity: Provenance guarantees that the image is built as expected, without unauthorized modifications.
  
# License

The SysML2.NET libraries and reference web-application are provided to the community under the Apache License 2.0. The solution contains files that contain information about the SysML2 metamodel which are distributed with the [GNU Lesser General Public License (LGPL) v3.0](https://opensource.org/licenses/LGPL-3.0).

# Contributions

Contributions to the code-base are welcome. However, before we can accept your contributions we ask any contributor to sign the Contributor License Agreement (CLA) and send this digitaly signed to s.gerene@stariongroup.eu. You can find the CLA's in the CLA folder.

SysML2.NET

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README