Manuals.md

Title: Manuals introduction
Author: Jutta
status: dump

Introduction

There are two sides to the manuals for the KM3NeT open science system. On the one hand manuals are needed for the external user to understand the use of the data and the interfaces, on the other hand manuals are needed for KM3NeT members to actually contribute their software and data to the open science system.

However, as documentation to an evolving system as required for this deliverable is valid only for a short time, this document aims to give an overview over the different sources of documentation and point to the actual currently valid version. Only where documentation is not made available as versioned web resource or is in its content central to the architecture, the actual manual is copied or appended here.

Note that most documentation for software is built automatically for source documentation and human-created documenation content is for most part hosted on the KM3NeT gitlab instance, as described in Deliverable 4.8. As the KM3NeT solution builds heavily on third-party software, documentation of this software is available elsewhere and pointed out here.

Manuals for users of the KM3NeT open science system

Manuals for the servers and platforms

Summary

platform	documentation URL	content
VO server Help	http://vo.km3net.de/static/help.shtml	Start page for Help
KM3NeT ODC	https://open-data.pages.km3net.de/openserver/	Documentation on the ODC
Gitlab	https://git.km3net.de/help	Built-in gitlab help system & documentation
Open Science Portal	https://open-data.pages.km3net.de/openscienceportal/HowTo.html	Quickstart to the system
Education Portal	https://edu.km3net.de/using-the-education-portal/	Info on access options

VO server

The DaCHS server comes with auto-generated documentation to the end points and numerous auto-generated listings of metadata, in addition to links to interface software and tutorials on their use.

Topic	documentation URL	content
TAP service	http://vo.km3net.de/__system__/tap/run/info	How to use TAP service
ADQL	http://vo.km3net.de/__system__/adql/query/info	How to use ADQL query
Data set descriptions	http://vo.km3net.de/__system__/dc_tables/show/tableinfo/ant20_01.main	Description of data table for ANTARES data

KM3NeT Open Data Center

Manuals for software

Summary

Software	documentation URL	description	content

Integration examples and workflows

Workflows are made accessible as Jupyter notebooks, which serve to show the integration between the data and software components. All example notebooks can be downloaded from the Open Science Portal as package.

Name	File name	description	components

|