vantage6 consists of several components that can be installed and run in several different ways. Which component(s) you need, and how you wish to install them, depends on your use case.
Creating computation requests can be done by either a researcher or an external application. The vantage6 server accepts computation requests (tasks) through HTTP requests containing a JSON body. This JSON body contains the algorithm, input and an address where the computation request should be executed. Depending on the algorithm the expected input (and the serialization) is different.
R there is a client package available. But you can also create your custom interface in your preferred language to communicate to the API.
pip install vantage6-client
See the section Running analysis for more info on how to use these clients.
As a data provider for the vantage6 solution you need to install the node package. There are two flavors, Docker (preferred) or non-Docker. In any case, make sure you install the General requirements first.
A (central) server allows parties to connect and exchange computation tasks and their results. To do this you need to install the server package. There are, just as in the case of the node, two flavors: Docker (preferred) or non-Docker. Make sure you go though the General requirements before installing the Docker or non-Docker.
Besides installing the vantage6 server you might also want to host a Docker registry. This would contain images that can be used for computations in the vantage6 solution. See Docker registry on how to setup this.
git clone https://github.com/IKNL/vantage6-master
Then install the sub-modules (packages) as editable:
pip install -e vantage6-master/vantage6-commonpip install -e vantage6-master/vantage6-clientpip install -e vantage6-master/vantage6pip install -e vantage6-master/vantage6-nodepip install -e vantage6-master/vantage6-server
Section to be created in the future. Please contact us on Discord if you want to develop an algorithm!