restflow.client

Client for restflow

Classes

AbstractHf3Session()	Abstract base class for the Remote or Local Hiflow3 session.
HiFlowRestClient(url)	High level api for restflow services
Simulation(lowlevel, token)	The simulation is a Hiflow3Session on the server.

Exceptions

HTTPResponseError(message, **kwargs)
RestApiException

exception restflow.client.HTTPResponseError(message, **kwargs)

Bases: exceptions.BaseException

class restflow.client.HiFlowRestClient(url)

Bases: object

High level api for restflow services

Parameters:url (str) – the base url for the service, eg. http://localhost:5000

open_simulation()

upload_mesh(filename=None, url=None)

Uploads the given mesh file, or request a download of url from the service.

Parameters:

• filename (str) – uploads the given the to the server
• url (str) – server will download the file behind tis URL

Returns:

a identifier of the new created file on the server

Return type:

str

exception restflow.client.RestApiException

Bases: exceptions.BaseException

class restflow.client.Simulation(lowlevel, token)

Bases: restflow.base.AbstractHf3Session

The simulation is a Hiflow3Session on the server. You should not directly create this, ask ..py:meth:HiFlowRestClient.open_simulation instead.

bc

get_result(step, function='vtu', target=None)

get_result_files()

get_result_step()

hf3

run()