1. User guide

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

There are four ways in which you can interact with the central server: the User interface (UI), the Python client, the R 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

Note that for some algorithms, tasks cannot yet be created using the UI, or the results cannot be retrieved. This is because these algorithms have Python-specific datatypes that cannot be decoded in the UI. In this case, you will need to use the Python client to create the task and read the results.

Warning

Depending on your algorithm 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.

• 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. R client
  • 1.3.1. Install
  • 1.3.2. Use
    • Example
• 1.4. API