1. User guide

In this section of the documentation, we explain how you can interact with the vantage6 hub and the nodes as a user.

There are several ways in which you can interact with the vantage6 hub: the User interface (UI), the Python client, and the API. In the sections below, we describe how to use each of these methods, and what you need to install (if anything).

For most use cases, we recommend to use the User interface, as this requires the least amount of effort. If you want to automate your workflow, we recommend using the Python client.

Warning

Depending on the algorithm used in your project, it may be required to use a specific language to post a task and retrieve the results. This could happen when the output of an algorithm contains a language specific datatype and or serialization. For instance, if the algorithm returns a numpy array, you need to use Python to retrieve the results - and thus you will not be able to see the results in the UI.

• 1.1. User interface
• 1.2. Python client
  • 1.2.1. Requirements
  • 1.2.2. Install
  • 1.2.3. Use
    • Overview
    • Authentication
    • Creating an organization
    • Creating a collaboration
    • Registering a node
    • Creating a task
• 1.3. API