Client

The client communicates with the central server. The server hosts an API which can be used for this purpose. To see the API documentation you can use the /apidocs page (e.g. https://petronas.vatage6.ai/apidocs). 
We have written two client libraries: one for R and one for Python. The R client currently only supports creating tasks and retrieving their results. 
Python client library
Before you install the Python client, we recommended to check the version of the server you are going to interact with first. The easiest way of doing that is checking the /version endpoint of the server you are going to use:
get
https://SERVER[/api_path]
/version
Retrieve version information of the server
Then you can install the vantage6-client with:
1
pip install vantage6==VERSION
Copied!
R client library
You can install the R client by running:
1
devtools::install_github('IKNL/vtg.basic', subdir='src')
Copied!

Docker

Next - Install

Node

Last modified 6mo ago

Export as PDF

Copy link

Edit on GitHub

Contents

get

Retrieve version information of the server