Sysand Index Publishing Guide

Manual submission

This guide will instruct how to submit your package to Sysand Package Index manually. Sensmetry is currently working on automating this process.

  1. Produce your package

    Sysand CLI at the moment can only package textual SysML v2 files into .kpar project interchange archives. Therefore, the Sysand Package Index currently only accepts projects developed in SysML v2 textual files.

  2. Fill out the questionnaire
    • Name of the project: Make it short and sweet. Avoid having spaces in the name if possible.
    • Description: Couple of sentences describing what this project can be used for. Keep it succinct.
    • Version: A version number of the project you're submitting. Shall follow the Semantic Versioning schema.
    • License: Which license this project is licensed under, e.g. MIT, Apache, GPL, any other. Ideally the license has an identifier from SPDX. If no license is given here, we will assume that the package is licensed under the MIT license.
    • Maintainer: A list of names of main maintainers (individuals or companies), preferably with email address, of the project.
    • Website: A URL to where people can find more information about the project. Can be a homepage, or a GitHub/GitLab repository. This is an optional field.
    • Topic: A list of topics relevant to the project. These will be treated as keywords. In the future, users will be able to search/filter the package index using topics.
    • Usage: A list of dependencies this project depends on, with links to them if the dependencies do not exist on the Sysand package index yet. By default your project will most likely depend on SysML v2 standard libraries. Important: To be able to publish your package to the index, all of its dependencies must be publicly available!
  3. (Optional) Package the project into .kpar

    Once you have the answers to the questions above and you are using Sysand CLI to manage your project, you can put the answers into the .project.json file and use Sysand CLI to package the project into one neat .kpar file.

    More information on how to do that can be found in the User Guide.

  4. Send the project to Sysand team

    When you have the project and the answers to the questionnaire prepared, please send them as an email to sysand@sensmetry.com. The Sysand team will review the project and the answers, package everything into a .kpar package, and upload it to the Index.

    Do not forget to attach the required .sysml (or .kpar) files to the email!

    5. Terms of publishing

    By submitting your package to the Sysand Package Index, you confirm that:

    • You agree not to submit packages containing malicious code, inappropriate content, or content that infringes on third-party rights.
    • You (co-)own the rights to the package and have the rights to redistribute it.
    • The package does not contain any proprietary or confidential data that cannot be shared publicly.
    • You acknowledge that you are responsible for maintaining accurate package information and metadata.
    • You give the right to Sensmetry to redistribute the package publicly through the Sysand Package Index.
    • You consent to Sensmetry running basic validations on the package using the Syside tool and making the validation results public.
    • Accept that Sensmetry reserves the right to modify these terms and the service without prior notice.