Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • RCS software must be delivered with at least the source code and the executable "ready-to-be-used" on the roc-dev server. The executable can be a script or a binary file.
  • RCS software must be delivered with the up-to-date documentation (user manual, software specification and design)
  • RCS software must be delivered with the up-to-date descriptor file (see RCS ICD for more details, available in ROC Documents)
  • RCS software must be "pushed" on the "master" branch of the dedicated project in the https://gitlab.obspm.fr/ROC/RCS group. There is one project by RCS
  • Every RCS software delivered must be tagged on Git with a version (use "git tag" command for this)
  • The ROC team must be informed each time a new version of the software is "pushed"

What is the descriptor file?

The descriptor file (or descriptor) is JSON format file used by the ROC pipelines to identify and call the RCS in an autonomous way.

A RCS delivered without or with a badly formatted descriptor cannot be run by the ROC pipelines.

See RCS ICD for more details about the descriptor, available in ROC Documents.

How can be sure that my descriptor file is well formatted?

The ROC team will always performed verifications of your descriptor just after each RCS delivery.

A JSON format file, as for XML, can be validated against a schema. A JSON schema is following the specifications from http://json-schema.org/draft-04/schema. Dedicated documentation can be found at https://spacetelescope.github.io/understanding-json-schema.

A copy of the RCS descriptor JSON file “cawa-schema.json” can be found in the RCS folder of the https://gitlab.obspm.fr/ROC/DataPool Git repository. Teams are free to download and use this file to verify that their descriptor is compliant.

This schema is also showed in the appendices of the RCS ICD (available in ROC Documents).

How can be sure that my RCS software is compliant with the ROC pipeline calling interface?

The ROC pipeline calling interface is described in the RCS ICD (available in ROC Documents).

Additionaly, the ROC will make available in its roc-dev server a tool that allows teams to verify that their software is compliant. This tool simulates the calling of the software as expected by the ROC pipelines.

This tool should be released prior to the launch.

ROC Gitlab-related questions

...

The table below lists the URLs of the issue tracking interface for each RCS:

How can I access to the RCS issue tracking interface?

...