SED-ML Specification

The SED-ML specification is the official document describing SED-ML and how tools and libraries should implement support for SED-ML.

Latest release: logo L1V4 pdf
Latest draft: The source is available from https://github.com/SED-ML/sed-ml/tree/master/specification/level-1-version-4.
Please submit changes via pull requests against the repository.
If you find issues with the specification please report them at https://github.com/SED-ML/sed-ml/issues.

Feature requests and proposals

We would like to encourage you to follow the procedure below for contributing to SED-ML development.

Feature requests

Feature requests are “wishes for support” by SED-ML users. They are submitted and tracked using the feature request tracker. The SED-ML editors will revise these wishes at their regular meetings and start discussion on them sed-ml-discuss if necessary. Solutions to feature requests can be provided (independently of a feature request) by starting a new proposal item.

Proposals

Proposals are welcome at all times via GitHub issues. Proposals could be derived from a sed-ml-discuss discussion field (for example, in response to a feature request), or created de novo.

  • Together with your proposal you must provide a sufficiently detailed description of your desired feature, including XML examples, i.e. SED-ML files, containing the proposed new elements in Annotation elements. Final element and attribute names may be decided on later (maybe even hierarchy).
  • The editors then collect vote on whether the outlined proposal goes in to the right direction and should become part of SED-ML.
    • The proposal will be voted on by sedml-discuss members,
    • requiring a majority in favour to be accepted. The vote includes yes-no-revise options.
    • There will be no minimum requirement for the the number of votes needed.
    • The voting process will take place over a 3 week period.
  • Proposals that are rejected will not be rejected for all time, but would need to address the reasons for their rejection before resubmission. Resubmission therefore requires revision of the proposal.
  • Accepted proposals will be integrated with the specification document by the SED-ML editors with the next release. Prerequisites are:
    • at least two implementations in applications ( to demonstrate interoperability)
    • updated examples
    • a written description of the proposal
    and ideally would include:
    • an XML schema for the proposed extension
    • UML diagrams illustrating any new class

All specifications

L1V4 (official specification document) pdf

L1V3 (official specification document) pdf

L1V2 (official specification document) pdf

L1V1 (official specification document) pdf


© 2017-2021 sed-ml.org. Report website issue