Skip to content

ode4hera/SysML-v2-SPDM

Repository files navigation

ODE4HERA Logo

ODE4HERA SysML v2 Libraries: Simulation Process & Data Management

Package Checks License

This repository contains a SysML v2 library package to support Simulation Process & Data Management (SPDM) concepts. Refer to the package readme and examples for more details.

The library presented in this repository has originally been developed in the ODE4HERA (Open Digital Environment for Hybrid-Electric Regional Architectures) project and has received funding from the European Union Clean Aviation Joint Undertaking under grant agreement nr 101140510.

Getting Started

To get started using the library, either clone the repo or install it from the Sysand package index:

sysand add ode4hera/spdm

When cloning locally, be sure to install any needed dependencies:

sysand sync

The library is best viewed and used with Syside Editor.

Citing

If you are using the library in your work, please cite:

Ziegler, K. et al., "Connecting Simulation and Data Management Tools Through Open Standards to Support Hybrid Aircraft Design". Eng. Proc. 2026, 133, 40. 10.3390/engproc2026133040

Bussemaker, J.H., Torrigiani, F., & Cabaleiro, C. (2026). HERA Architecture Framework Libraries. ODE4HERA Consortium. doi: 10.5281/zenodo.18267042

Contributing

The project is a joint effort by the ODE4HERA consortium, however everyone is encouraged to contribute!

If you find a bug or have suggestions for improvement, please file an issue using the Github issue tracker. If you require support or want to collaborate in other ways, feel free to contact us (see below for contact details).

If you want to contribute to the library:

  • Fork the repository and commit your contributions to the fork
    • Make sure to update or add documentation and/or examples if needed
  • Read and sign the Contributor License Agreement (CLA), and send it to the email address below
  • Create a pull request into the main branch

The project is administered by the DLR Institute of System Architectures in Aeronautics. You can contact us at digital.engineering at dlr.de.

Repository Structure

The repository is built up in the following way:

  • spdm: contains the actual library package, which is a Sysand project
    • The package has example models in the examples sub-folder that demonstrate usage of the library
    • The package additionally has: a readme (shown on the Sysand package page) with documentation, a changelog, and a license file
  • package_checks: contains code for testing the package before merging/releasing, written as Python code using pytest
    • The checks need Syside Automator, which is commercial software
    • The repository has a license key configured so the checks can be executed
  • examples_dev: contains models for demonstrating/developing the package that are not part of the published package, used for example for internal discussions or demonstrations

Refer to the Sysand index documentation to learn more about how the package should be structured to be publishable.

Version Release Process

To release a new version, first ensure all relevant branches have been merged into main using pull requests (and ensure package checks pass, the kpar can be built, and the CLA has been signed if needed).

Then to release a new version:

  1. Update version numbers in files and .project.json.
  2. Create a new release with a tag in the form v0.0.0.
    • The kpar will be built and uploaded to Sysand automatically.
  3. Verify that the new version is available on Sysand.

Currently, there is no predefined release schedule.

About

SysML v2 Libraries for Simulation Process & Data Management (SPDM)

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages