This section is almost the same as the node requirements section - their requirements are very similar.
The (minimal) requirements of the node and server are similar. Note that these are recommendations: it may also work on other hardware, operating systems, versions of Python etc. (but they are not tested as much).
x86 CPU architecture + virtualization enabled
1 GB memory
Stable and fast (1 Mbps+ internet connection)
Note that the server’s IP address should also be reachable by all users and nodes. This will usually be a public IP address.
Operating system: Ubuntu 18.04+
For the server, Ubuntu is highly recommended. It is possible to run a development server (using vserver start) on Windows or MacOS, but for production purposes we recommend using Ubuntu.
The hardware requirements of the node also depend on the algorithms that the node will run. For example, you need much less compute power for a descriptive statistical algorithm than for a machine learning model.
We recommend you install vantage6 in a new, clean Python (Conda) environment.
Higher versions of Python (3.11+) will most likely also work, as might lower versions (3.8 or 3.9). However, we develop and test vantage6 on version 3.10, so that is the safest choice.
Note that Python 3.10 is only used in vantage6 versions 3.8.0 and higher. In lower versions, Python 3.7 is required.
Docker facilitates encapsulation of applications and their dependencies in packages that can be easily distributed to diverse systems. Algorithms are stored in Docker images which nodes can download and execute. Besides the algorithms, both the node and server are also running from a docker container themselves.
Please refer to this page
on how to install Docker. To verify that Docker is installed and running
you can run the
hello-world example from Docker.
docker run hello-world
Note that for Linux, some post-installation
be required. Vantage6 needs to be able to run docker without
and these steps ensure just that.
For Windows, if you are using Docker Desktop, it may be preferable to limit the amount of memory Docker can use - in some cases it may otherwise consume much memory and slow down the system. This may be achieved as described here.
Always make sure that Docker is running while using vantage6!
We recommend to always use the latest version of Docker.