VITALISE D3.5 VITALISE SDK Manual
Beristain Andoni · Zenodo (CERN European Organization for Nuclear Research) · 2022
This is a companion document to the online software development kit (SDK) documentation deliverable itself. It contains a snapshot of the SDK documentation at the time of delivery (it will be updated as technological development advances) and a description of the process followed to select the suitable SDK documentation tools for this use case scenario. It also includes a description of the general researcher workflow to use the VITALISE SDK. Currently the SDK only applies for the Python language, and it is based on the object oriented paradigm (OOP) paradigm and abstract classes. For the documentation generation we have chosen sphinx with automatic documentation generation from docstrings and markdown. And for making the manual available, we have chosen Gitlab pages and Gitlab’s continuous integration – deployment (CI-CD) to keep the documentation updated. The updated online SDK manual is available at: https://vitalise-project-group.gitlab.io/bayaz/