Accessing the client API entry-point

If the TVB REST server you want to access runs at another address, change the parameter in the bellow TVBClient instantiation.

from tvb.interfaces.rest.client.tvb_client import TVBClient
tvb_client = TVBClient("http://localhost:9090")

Attempt to login and start using the client API to send requests, by calling different types of methods:

• methods that return a list of DTOs

tvb_client.browser_login()
list_of_user_projects = tvb_client.get_project_list()
list_of_datatypes_in_project = tvb_client.get_data_in_project(list_of_user_projects[0].gid)
list_of_operations_for_datatype = tvb_client.get_operations_for_datatype(list_of_datatypes_in_project[0].gid)

• method that download data files locally, under a folder chosen by the client

datatype_path = tvb_client.retrieve_datatype(list_of_datatypes_in_project[0].gid, download_folder)

• method that loads in memory the datatype downloaded previously

datatype = tvb_client.load_datatype_from_file(datatype_path)

• methods that launch operations in the TVB server

  Such an operation requires the client to prepare the operation configuration and send it in an H5 file together with the requests.

  By using the client API, the user only needs to instantiate the proper Model class and send it as argument to the following method. It wraps the serialization of the Model inside the H5 and the attaching to the POST request.

  The example above launches a Fourier analyzer, we suppose the Fourier AlgorithmDTO is list_of_operations_for_datatype[0].

from tvb.adapters.analyzers.fourier_adapter import FFTAdapterModel, FourierAdapter

project_gid = list_of_user_projects[0].gid
model = FFTAdapterModel()
# logic to fill the model with required attributes
operation_gid = tvb_client.launch_operation(project_gid, FourierAdapter, model)

• method to monitor the status of an operation

monitor_operation(tvb_client, operation_gid)