Skip to content

SIMULUS Documentation

SIMULUS provides a large set of reference documentation, containing both auto-generated content from design but also manual content.

The SIMULUS reference documentation site is available at: https://sim.space-codev.org/docs.

SIMULUS versions

The SIMULUS reference documentation is provided independently for each version of SIMULUS. The main differences implemented in a new version of SIMULUS are described in the Software Release Notes which can be found in SIMULUS - SRN - Implemented Changes. Important information about breaking changes are described as well in the Special notes, also part of the SRN.

Top Level documentation structure

The reference documentation top level is structure according to the projects composing SIMULUS. In addition a top level SIMULUS chapter provides product level documentation for the complete SIMULUS framework. This includes important documents such as:

Structure of project documentation

For each SIMULUS projects a set of reference documents are provided:

  • Interface Control Document: description of the SMP interfaces defined in the project as well as other external interfaces of interest. Some of the subchapters included are:
    • System Design Overview: brief description of the interfaces defined in the project.
    • Software Interfaces Design: auto-generated documentation of SMP interfaces.
    • Data Interfaces Documentation: description of external data interfaces (e.g. input or output file formats, communication protocols)
  • Software Detailed Design: description of the architectural design of the project and its defined models. Some of the subchapters included are:
    • System Design Overview: brief description of the models defined in the project.
    • Software top-level architectural design: brief description of the project design.
    • Software Product Components: detailed description of the models defined in the project.
    • Detailed design documentation: auto-generated documentation of SMP models.
    • Data types definition: auto-generated documentation of SMP data types.
  • Software Requirements Specification: requirements that drive the design of the project.
  • Software Test Plan: definition of tests used to validate the project.
  • Software Test Report: results of the execution of the project tests.
  • Software User Manual: description of the capabilities and usage of the project. Some of the subchapters included are:
    • Overview Section: brief description of the components and usage of the project.
    • Instruction Section: detailed instructions for the usage of the project.
    • Reference Section: auto-generated documentation of SMP published elements.
  • Technical Notes: additional technical documentation related to the project.