8. Function documentation

This part of the documentation documents the code of the vantage6 infrastructure. It lists all the functions and classes and describes what they do and how they may be used. Each part of the code is documented separately below.

vantage6.cli	Command line interface for the vantage6 infrastructure.
vantage6.client	Python client for user to communicate with the vantage6 server
vantage6.algorithm.client	Client for the algorithm container to communicate with the vantage6 server.
vantage6.algorithm.tools	Algorithm tools to support the development of algorithms for the vantage6 platform.
vantage6.node	The vantage6 node's core function is to retrieve tasks from the central server, run them and return the results.
vantage6.backend.common	Common functionality for the vantage6 server and algorithm store.
vantage6.common	Common functionality used in multiple vantage6 components.

Note

The API documentation is also included in this section, but as they are formatted differently they are not displayed optimally. To view them as intended, please view the API documentation directly.