simscale_sdk.api package¶

Submodules¶

simscale_sdk.api.ai_models_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.ai_models_api.AIModelsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_prediction(**kwargs)¶

Generate an AI prediction for a simulation based on an AI model # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_prediction(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
create_ai_prediction_request (CreateAiPredictionRequest) –
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

CreateAiPredictionResponse If the method is called asynchronously, returns the request thread.

create_prediction_with_http_info(**kwargs)¶

Generate an AI prediction for a simulation based on an AI model # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_prediction_with_http_info(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
create_ai_prediction_request (CreateAiPredictionRequest) –
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(CreateAiPredictionResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_ai_model(ai_model_id, **kwargs)¶

Get specific AI model belonging to the user # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_ai_model(ai_model_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
ai_model_id (str) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

AiUserModel If the method is called asynchronously, returns the request thread.

get_ai_model_with_http_info(ai_model_id, **kwargs)¶

Get specific AI model belonging to the user # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_ai_model_with_http_info(ai_model_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
ai_model_id (str) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(AiUserModel, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_ai_models(**kwargs)¶

Get all AI models belonging to the user # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_ai_models(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

list[AiUserModel] If the method is called asynchronously, returns the request thread.

get_ai_models_with_http_info(**kwargs)¶

Get all AI models belonging to the user # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_ai_models_with_http_info(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(list[AiUserModel], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_available_ai_model(simulation_id, project_id, **kwargs)¶

Get all AI model belonging to the user that can be used to run a specific simulation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_available_ai_model(simulation_id, project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
simulation_id (str) – (required)
project_id (str) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

list[AvailableAiModel] If the method is called asynchronously, returns the request thread.

get_available_ai_model_with_http_info(simulation_id, project_id, **kwargs)¶

Get all AI model belonging to the user that can be used to run a specific simulation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_available_ai_model_with_http_info(simulation_id, project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
simulation_id (str) – (required)
project_id (str) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(list[AvailableAiModel], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api.folders_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.folders_api.FoldersApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_folder(space_id, folder, **kwargs)¶

Create Folder # noqa: E501

Create a new Folder. If parentFolderId is missing, the folder will be created at the root level of the Space. Folder name clashes are allowed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_folder(space_id, folder, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
folder (Folder) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Folder If the method is called asynchronously, returns the request thread.

create_folder_with_http_info(space_id, folder, **kwargs)¶

Create Folder # noqa: E501

Create a new Folder. If parentFolderId is missing, the folder will be created at the root level of the Space. Folder name clashes are allowed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_folder_with_http_info(space_id, folder, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
folder (Folder) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Folder, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

delete_folder(space_id, folder_id, **kwargs)¶

Delete Folder # noqa: E501

Delete a folder and all its content. The deletion is propagated to all child elements. If the total number of elements to delete is too large, this operation will be carried out asynchronously. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_folder(space_id, folder_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
folder_id (str) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

delete_folder_with_http_info(space_id, folder_id, **kwargs)¶

Delete Folder # noqa: E501

Delete a folder and all its content. The deletion is propagated to all child elements. If the total number of elements to delete is too large, this operation will be carried out asynchronously. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_folder_with_http_info(space_id, folder_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
folder_id (str) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

get_folder_info(space_id, folder_id, **kwargs)¶

Get Folder Info # noqa: E501

Get Folder metadata and current user permissions # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_folder_info(space_id, folder_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
folder_id (str) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Folder If the method is called asynchronously, returns the request thread.

get_folder_info_with_http_info(space_id, folder_id, **kwargs)¶

Get Folder Info # noqa: E501

Get Folder metadata and current user permissions # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_folder_info_with_http_info(space_id, folder_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
folder_id (str) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Folder, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

list_folders_in_folder(space_id, folder_id, **kwargs)¶

List Folders in Folder # noqa: E501

List folders located in a Folder. Filtering or search capabilities are not supported. This only returns the folders of the queried folder, without a recursive expansion to child folders # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_folders_in_folder(space_id, folder_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
folder_id (str) – The folder ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
sort (str) – A field to sort by. The available fields are: ‘name’, ‘createdAt’ and ‘lastModifiedAt’. To indicate sorting direction, the field must be prefixed with ‘+’ (ascending) or ‘-’ (descending), e.g. ?sort=+name
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Folders If the method is called asynchronously, returns the request thread.

list_folders_in_folder_with_http_info(space_id, folder_id, **kwargs)¶

List Folders in Folder # noqa: E501

List folders located in a Folder. Filtering or search capabilities are not supported. This only returns the folders of the queried folder, without a recursive expansion to child folders # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_folders_in_folder_with_http_info(space_id, folder_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
folder_id (str) – The folder ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
sort (str) – A field to sort by. The available fields are: ‘name’, ‘createdAt’ and ‘lastModifiedAt’. To indicate sorting direction, the field must be prefixed with ‘+’ (ascending) or ‘-’ (descending), e.g. ?sort=+name
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Folders, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

list_folders_in_space_root(space_id, **kwargs)¶

List Folders in Space root # noqa: E501

List folders located at the root level of a Space. Filtering or search capabilities are not supported. This only returns the folders at the root level of a Space, without a recursive expansion to child folders. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_folders_in_space_root(space_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
sort (str) – A field to sort by. The available fields are: ‘name’, ‘createdAt’ and ‘lastModifiedAt’. To indicate sorting direction, the field must be prefixed with ‘+’ (ascending) or ‘-’ (descending), e.g. ?sort=+name
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Folders If the method is called asynchronously, returns the request thread.

list_folders_in_space_root_with_http_info(space_id, **kwargs)¶

List Folders in Space root # noqa: E501

List folders located at the root level of a Space. Filtering or search capabilities are not supported. This only returns the folders at the root level of a Space, without a recursive expansion to child folders. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_folders_in_space_root_with_http_info(space_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
sort (str) – A field to sort by. The available fields are: ‘name’, ‘createdAt’ and ‘lastModifiedAt’. To indicate sorting direction, the field must be prefixed with ‘+’ (ascending) or ‘-’ (descending), e.g. ?sort=+name
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Folders, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

list_projects_in_folder(space_id, folder_id, **kwargs)¶

List Projects in Folder # noqa: E501

List projects located in a Folder. Filtering or search capabilities are not supported. This only returns the projects of the queried folder, without a recursive expansion to child folders. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_projects_in_folder(space_id, folder_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
folder_id (str) – The folder ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
sort (str) – A field to sort by. The available fields are: ‘name’, ‘createdAt’ and ‘lastModifiedAt’. To indicate sorting direction, the field must be prefixed with ‘+’ (ascending) or ‘-’ (descending), e.g. ?sort=+name
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Projects If the method is called asynchronously, returns the request thread.

list_projects_in_folder_with_http_info(space_id, folder_id, **kwargs)¶

List Projects in Folder # noqa: E501

List projects located in a Folder. Filtering or search capabilities are not supported. This only returns the projects of the queried folder, without a recursive expansion to child folders. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_projects_in_folder_with_http_info(space_id, folder_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
folder_id (str) – The folder ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
sort (str) – A field to sort by. The available fields are: ‘name’, ‘createdAt’ and ‘lastModifiedAt’. To indicate sorting direction, the field must be prefixed with ‘+’ (ascending) or ‘-’ (descending), e.g. ?sort=+name
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Projects, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

list_projects_in_space_root(space_id, **kwargs)¶

List Projects in Space root # noqa: E501

List projects located at the root level of a Space. Filtering or search capabilities are not supported. This only returns the projects at the root level of a Space, without a recursive expansion to child folders. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_projects_in_space_root(space_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
sort (str) – A field to sort by. The available fields are: ‘name’, ‘createdAt’ and ‘lastModifiedAt’. To indicate sorting direction, the field must be prefixed with ‘+’ (ascending) or ‘-’ (descending), e.g. ?sort=+name
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Projects If the method is called asynchronously, returns the request thread.

list_projects_in_space_root_with_http_info(space_id, **kwargs)¶

List Projects in Space root # noqa: E501

List projects located at the root level of a Space. Filtering or search capabilities are not supported. This only returns the projects at the root level of a Space, without a recursive expansion to child folders. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_projects_in_space_root_with_http_info(space_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
sort (str) – A field to sort by. The available fields are: ‘name’, ‘createdAt’ and ‘lastModifiedAt’. To indicate sorting direction, the field must be prefixed with ‘+’ (ascending) or ‘-’ (descending), e.g. ?sort=+name
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Projects, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

move_content_from_folder(space_id, folder_id, move_content_request, **kwargs)¶

Move Content from Folder # noqa: E501

Move content from this folder. Several resources can be moved with the same request. All resources must be moved to the same target location. Folders cannot be moved to a different Space. Projects can only be moved to a Personal Space if the Space owner and the project owner match. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.move_content_from_folder(space_id, folder_id, move_content_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
folder_id (str) – The folder ID (required)
move_content_request (MoveContentRequest) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

move_content_from_folder_with_http_info(space_id, folder_id, move_content_request, **kwargs)¶

Move Content from Folder # noqa: E501

Move content from this folder. Several resources can be moved with the same request. All resources must be moved to the same target location. Folders cannot be moved to a different Space. Projects can only be moved to a Personal Space if the Space owner and the project owner match. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.move_content_from_folder_with_http_info(space_id, folder_id, move_content_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
folder_id (str) – The folder ID (required)
move_content_request (MoveContentRequest) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

move_content_from_space_root(space_id, move_content_request, **kwargs)¶

Move Content from Space root # noqa: E501

Move content located at the root level of a Space. Several resources can be moved with the same request. All resources must be moved to the same target location. Folders cannot be moved to a different Space. Projects can only be moved to a Personal Space if the Space owner and the project owner match. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.move_content_from_space_root(space_id, move_content_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
move_content_request (MoveContentRequest) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

move_content_from_space_root_with_http_info(space_id, move_content_request, **kwargs)¶

Move Content from Space root # noqa: E501

Move content located at the root level of a Space. Several resources can be moved with the same request. All resources must be moved to the same target location. Folders cannot be moved to a different Space. Projects can only be moved to a Personal Space if the Space owner and the project owner match. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.move_content_from_space_root_with_http_info(space_id, move_content_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
move_content_request (MoveContentRequest) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

update_folder(space_id, folder_id, folder, **kwargs)¶

Update Folder # noqa: E501

Update Folder metadata # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_folder(space_id, folder_id, folder, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
folder_id (str) – (required)
folder (Folder) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Folder If the method is called asynchronously, returns the request thread.

update_folder_with_http_info(space_id, folder_id, folder, **kwargs)¶

Update Folder # noqa: E501

Update Folder metadata # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_folder_with_http_info(space_id, folder_id, folder, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
folder_id (str) – (required)
folder (Folder) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Folder, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api.geometries_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.geometries_api.GeometriesApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

get_geometries(project_id, **kwargs)¶

List geometries within a project # noqa: E501

Only valid geometries that can be used for a simulation setup are included. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_geometries(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Geometries If the method is called asynchronously, returns the request thread.

get_geometries_with_http_info(project_id, **kwargs)¶

List geometries within a project # noqa: E501

Only valid geometries that can be used for a simulation setup are included. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_geometries_with_http_info(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Geometries, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_geometry(project_id, geometry_id, **kwargs)¶

Get information about the geometry # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_geometry(project_id, geometry_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_id (str) – The geometry ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Geometry If the method is called asynchronously, returns the request thread.

get_geometry_mappings(project_id, geometry_id, **kwargs)¶

Describe id mapping of the geometry # noqa: E501

Assignment of topological entities (faces, bodies) in the simulation setup is a non-trivial task. Complex models can consist of several assemblies which may contain multiple occurrences of bodies and their entities. In order to describe an assignment unambiguously the full path from the root part of the model to the actual topological entity is required. SimScale generates unique internal names for all topological entities of a model during the geometry import which are used for assignments within the simulation spec. Examples of internal names are B1_TE5 or A1_I26_A5_I27_B102_TE196. This API endpoint allows to retrieve a mapping between the internal names and a detailed description of the entities which includes: * The topological entity class (body or face) * The original body and entity names * Entity attributes like SDL/TYSA_NAME, SDL/TYSA_UNAME, ATTRIB_XPARASOLID_NAME or SDL/TYSA_COLOUR * The path from the root of the model Please note that during geometry import the model’s topology can be modified (e.g. facet split and other import options) which means that there is no 1:1 mapping between the internal and original names. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_geometry_mappings(project_id, geometry_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_id (str) – The geometry ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_class (str) – The entity class to filter.
bodies (list[str]) – The body names to filter. If multiple body names are provided any match.
entities (list[str]) – The entity names to filter. If multiple entity names are provided any match.
attributes (list[str]) – The attribute names to filter. If multiple attribute names are provided any match.
values (list[str]) – The attribute values to filter. If multiple attribute values are provided any match.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

GeometryMappings If the method is called asynchronously, returns the request thread.

get_geometry_mappings_with_http_info(project_id, geometry_id, **kwargs)¶

Describe id mapping of the geometry # noqa: E501

Assignment of topological entities (faces, bodies) in the simulation setup is a non-trivial task. Complex models can consist of several assemblies which may contain multiple occurrences of bodies and their entities. In order to describe an assignment unambiguously the full path from the root part of the model to the actual topological entity is required. SimScale generates unique internal names for all topological entities of a model during the geometry import which are used for assignments within the simulation spec. Examples of internal names are B1_TE5 or A1_I26_A5_I27_B102_TE196. This API endpoint allows to retrieve a mapping between the internal names and a detailed description of the entities which includes: * The topological entity class (body or face) * The original body and entity names * Entity attributes like SDL/TYSA_NAME, SDL/TYSA_UNAME, ATTRIB_XPARASOLID_NAME or SDL/TYSA_COLOUR * The path from the root of the model Please note that during geometry import the model’s topology can be modified (e.g. facet split and other import options) which means that there is no 1:1 mapping between the internal and original names. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_geometry_mappings_with_http_info(project_id, geometry_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_id (str) – The geometry ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_class (str) – The entity class to filter.
bodies (list[str]) – The body names to filter. If multiple body names are provided any match.
entities (list[str]) – The entity names to filter. If multiple entity names are provided any match.
attributes (list[str]) – The attribute names to filter. If multiple attribute names are provided any match.
values (list[str]) – The attribute values to filter. If multiple attribute values are provided any match.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(GeometryMappings, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_geometry_with_http_info(project_id, geometry_id, **kwargs)¶

Get information about the geometry # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_geometry_with_http_info(project_id, geometry_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_id (str) – The geometry ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Geometry, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

update_geometry(project_id, geometry_id, geometry, **kwargs)¶

Update geometry information # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_geometry(project_id, geometry_id, geometry, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_id (str) – The geometry ID (required)
geometry (Geometry) – Geometry information to be updated (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

update_geometry_with_http_info(project_id, geometry_id, geometry, **kwargs)¶

Update geometry information # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_geometry_with_http_info(project_id, geometry_id, geometry, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_id (str) – The geometry ID (required)
geometry (Geometry) – Geometry information to be updated (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

simscale_sdk.api.geometry_imports_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.geometry_imports_api.GeometryImportsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

get_geometry_import(project_id, geometry_import_id, **kwargs)¶

Get information about the geometry import # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_geometry_import(project_id, geometry_import_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_import_id (str) – The geometry import ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

GeometryImportResponse If the method is called asynchronously, returns the request thread.

get_geometry_import_event_log(project_id, geometry_import_id, **kwargs)¶

Get the geometry import event log # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_geometry_import_event_log(project_id, geometry_import_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_import_id (str) – The geometry import ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

EventLogResponse If the method is called asynchronously, returns the request thread.

get_geometry_import_event_log_with_http_info(project_id, geometry_import_id, **kwargs)¶

Get the geometry import event log # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_geometry_import_event_log_with_http_info(project_id, geometry_import_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_import_id (str) – The geometry import ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(EventLogResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_geometry_import_with_http_info(project_id, geometry_import_id, **kwargs)¶

Get information about the geometry import # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_geometry_import_with_http_info(project_id, geometry_import_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_import_id (str) – The geometry import ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(GeometryImportResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

import_geometry(project_id, geometry_import_request, **kwargs)¶

Import a new geometry # noqa: E501

Geometry import requires the following steps: 1. Request a temporary storage location via POST /storage. 2. Upload your CAD file using the HTTP PUT method to the url provided in the temporary storage location response object. 3. Start the import via POST /projects/{projectId}/geometryimports and include the storageId provided in the temporary storage location response object. 4. Check for the import status via GET /projects/{projectId}/geometryimports/{geometryImportId}. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.import_geometry(project_id, geometry_import_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_import_request (GeometryImportRequest) – Geometry import specification. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

GeometryImportResponse If the method is called asynchronously, returns the request thread.

import_geometry_with_http_info(project_id, geometry_import_request, **kwargs)¶

Import a new geometry # noqa: E501

Geometry import requires the following steps: 1. Request a temporary storage location via POST /storage. 2. Upload your CAD file using the HTTP PUT method to the url provided in the temporary storage location response object. 3. Start the import via POST /projects/{projectId}/geometryimports and include the storageId provided in the temporary storage location response object. 4. Check for the import status via GET /projects/{projectId}/geometryimports/{geometryImportId}. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.import_geometry_with_http_info(project_id, geometry_import_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_import_request (GeometryImportRequest) – Geometry import specification. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(GeometryImportResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api.materials_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.materials_api.MaterialsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_material(material_group_id, **kwargs)¶

Create a new material # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_material(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
create_material_request (CreateMaterialRequest) –
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MaterialResponse If the method is called asynchronously, returns the request thread.

create_material_group(**kwargs)¶

Create new material group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_material_group(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
create_material_group_request (CreateMaterialGroupRequest) –
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MaterialGroupResponse If the method is called asynchronously, returns the request thread.

create_material_group_with_http_info(**kwargs)¶

Create new material group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_material_group_with_http_info(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
create_material_group_request (CreateMaterialGroupRequest) –
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MaterialGroupResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

create_material_with_http_info(material_group_id, **kwargs)¶

Create a new material # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_material_with_http_info(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
create_material_request (CreateMaterialRequest) –
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MaterialResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

create_nested_material_group(material_group_id, **kwargs)¶

Create a child material group for the specified parent group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_nested_material_group(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
create_nested_material_group_request (CreateNestedMaterialGroupRequest) –
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MaterialGroupResponse If the method is called asynchronously, returns the request thread.

create_nested_material_group_with_http_info(material_group_id, **kwargs)¶

Create a child material group for the specified parent group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_nested_material_group_with_http_info(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
create_nested_material_group_request (CreateNestedMaterialGroupRequest) –
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MaterialGroupResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

delete_material_data(material_group_id, material_id, **kwargs)¶

Remove an existing material # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_material_data(material_group_id, material_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
material_id (str) – ID of a material (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

delete_material_data_with_http_info(material_group_id, material_id, **kwargs)¶

Remove an existing material # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_material_data_with_http_info(material_group_id, material_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
material_id (str) – ID of a material (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

delete_material_group(material_group_id, **kwargs)¶

Delete material group, sub-groups associated to it, and materials associated to the group and all sub-groups # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_material_group(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

delete_material_group_with_http_info(material_group_id, **kwargs)¶

Delete material group, sub-groups associated to it, and materials associated to the group and all sub-groups # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_material_group_with_http_info(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

get_material_data(material_group_id, material_id, **kwargs)¶

Get information about an existing material # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_material_data(material_group_id, material_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
material_id (str) – ID of a material (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MaterialResponse If the method is called asynchronously, returns the request thread.

get_material_data_with_http_info(material_group_id, material_id, **kwargs)¶

Get information about an existing material # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_material_data_with_http_info(material_group_id, material_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
material_id (str) – ID of a material (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MaterialResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_material_group_metadata(material_group_id, **kwargs)¶

Fetch material group information # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_material_group_metadata(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MaterialGroupResponse If the method is called asynchronously, returns the request thread.

get_material_group_metadata_with_http_info(material_group_id, **kwargs)¶

Fetch material group information # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_material_group_metadata_with_http_info(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MaterialGroupResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_material_groups(**kwargs)¶

List all the material groups the user has access to # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_material_groups(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MaterialGroupListResponse If the method is called asynchronously, returns the request thread.

get_material_groups_with_http_info(**kwargs)¶

List all the material groups the user has access to # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_material_groups_with_http_info(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MaterialGroupListResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_materials(material_group_id, **kwargs)¶

List materials within the material group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_materials(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MaterialListResponse If the method is called asynchronously, returns the request thread.

get_materials_with_http_info(material_group_id, **kwargs)¶

List materials within the material group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_materials_with_http_info(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MaterialListResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_nested_material_groups(material_group_id, **kwargs)¶

List all sub-groups of the specified material group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_nested_material_groups(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MaterialGroupListResponse If the method is called asynchronously, returns the request thread.

get_nested_material_groups_with_http_info(material_group_id, **kwargs)¶

List all sub-groups of the specified material group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_nested_material_groups_with_http_info(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MaterialGroupListResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

update_material_data(material_group_id, material_id, **kwargs)¶

Update an existing material # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_material_data(material_group_id, material_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
material_id (str) – ID of a material (required)
create_material_request (CreateMaterialRequest) –
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MaterialResponse If the method is called asynchronously, returns the request thread.

update_material_data_with_http_info(material_group_id, material_id, **kwargs)¶

Update an existing material # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_material_data_with_http_info(material_group_id, material_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
material_id (str) – ID of a material (required)
create_material_request (CreateMaterialRequest) –
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MaterialResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

update_material_group_metadata(material_group_id, **kwargs)¶

Update material group information # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_material_group_metadata(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
update_material_group_request (UpdateMaterialGroupRequest) –
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MaterialGroupResponse If the method is called asynchronously, returns the request thread.

update_material_group_metadata_with_http_info(material_group_id, **kwargs)¶

Update material group information # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_material_group_metadata_with_http_info(material_group_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
material_group_id (str) – ID of a material group (required)
update_material_group_request (UpdateMaterialGroupRequest) –
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MaterialGroupResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api.mesh_operations_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.mesh_operations_api.MeshOperationsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

cancel_mesh_operation(project_id, mesh_operation_id, **kwargs)¶

Cancel the mesh operation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_mesh_operation(project_id, mesh_operation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

cancel_mesh_operation_with_http_info(project_id, mesh_operation_id, **kwargs)¶

Cancel the mesh operation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_mesh_operation_with_http_info(project_id, mesh_operation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

check_mesh_operation_setup(project_id, mesh_operation_id, **kwargs)¶

Check the mesh operation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_mesh_operation_setup(project_id, mesh_operation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
simulation_id (str) – The related simulation ID of a physics based mesh operation
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

CheckResponse If the method is called asynchronously, returns the request thread.

check_mesh_operation_setup_with_http_info(project_id, mesh_operation_id, **kwargs)¶

Check the mesh operation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_mesh_operation_setup_with_http_info(project_id, mesh_operation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
simulation_id (str) – The related simulation ID of a physics based mesh operation
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(CheckResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

create_mesh_operation(project_id, mesh_operation, **kwargs)¶

Create a mesh operation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_mesh_operation(project_id, mesh_operation, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation (MeshOperation) – Mesh operation to be created (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MeshOperation If the method is called asynchronously, returns the request thread.

create_mesh_operation_with_http_info(project_id, mesh_operation, **kwargs)¶

Create a mesh operation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_mesh_operation_with_http_info(project_id, mesh_operation, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation (MeshOperation) – Mesh operation to be created (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MeshOperation, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

estimate_mesh_operation(project_id, mesh_operation_id, **kwargs)¶

Estimate the mesh operation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.estimate_mesh_operation(project_id, mesh_operation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Estimation If the method is called asynchronously, returns the request thread.

estimate_mesh_operation_with_http_info(project_id, mesh_operation_id, **kwargs)¶

Estimate the mesh operation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.estimate_mesh_operation_with_http_info(project_id, mesh_operation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Estimation, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_mesh_operation(project_id, mesh_operation_id, meshing_spec_schema_version='5.0', **kwargs)¶

Get information about the mesh operation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_mesh_operation(project_id, mesh_operation_id, meshing_spec_schema_version, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
meshing_spec_schema_version (str) – Version of the schema the meshing spec should conform to (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MeshOperation If the method is called asynchronously, returns the request thread.

get_mesh_operation_event_log(project_id, mesh_operation_id, **kwargs)¶

Get the mesh operation event log # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_mesh_operation_event_log(project_id, mesh_operation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

EventLogResponse If the method is called asynchronously, returns the request thread.

get_mesh_operation_event_log_with_http_info(project_id, mesh_operation_id, **kwargs)¶

Get the mesh operation event log # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_mesh_operation_event_log_with_http_info(project_id, mesh_operation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(EventLogResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_mesh_operation_sdk_code(project_id, mesh_operation_id, **kwargs)¶

Get Python SDK code for the mesh operation # noqa: E501

Important: due to incompatibilities between the source Spec version and the target SDK version the generated code may contain incomplete sections or even be invalid. The generated code is provided as a convenience and should be reviewed and adapted before use. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_mesh_operation_sdk_code(project_id, mesh_operation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
sdk_version (str) – Version of the SDK to generate code for
sdk_language (str) – Language of the SDK to generate code for. Only Python is currently supported.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

str If the method is called asynchronously, returns the request thread.

get_mesh_operation_sdk_code_with_http_info(project_id, mesh_operation_id, **kwargs)¶

Get Python SDK code for the mesh operation # noqa: E501

Important: due to incompatibilities between the source Spec version and the target SDK version the generated code may contain incomplete sections or even be invalid. The generated code is provided as a convenience and should be reviewed and adapted before use. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_mesh_operation_sdk_code_with_http_info(project_id, mesh_operation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
sdk_version (str) – Version of the SDK to generate code for
sdk_language (str) – Language of the SDK to generate code for. Only Python is currently supported.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_mesh_operation_with_http_info(project_id, mesh_operation_id, meshing_spec_schema_version, **kwargs)¶

Get information about the mesh operation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_mesh_operation_with_http_info(project_id, mesh_operation_id, meshing_spec_schema_version, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
meshing_spec_schema_version (str) – Version of the schema the meshing spec should conform to (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MeshOperation, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_mesh_operations(project_id, **kwargs)¶

List mesh operations for a project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_mesh_operations(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MeshOperations If the method is called asynchronously, returns the request thread.

get_mesh_operations_with_http_info(project_id, **kwargs)¶

List mesh operations for a project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_mesh_operations_with_http_info(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MeshOperations, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

start_mesh_operation(project_id, mesh_operation_id, **kwargs)¶

Start the mesh operation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.start_mesh_operation(project_id, mesh_operation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
simulation_id (str) – The related simulation ID of a physics based mesh operation
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

start_mesh_operation_with_http_info(project_id, mesh_operation_id, **kwargs)¶

Start the mesh operation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.start_mesh_operation_with_http_info(project_id, mesh_operation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
simulation_id (str) – The related simulation ID of a physics based mesh operation
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

update_mesh_operation(project_id, mesh_operation_id, mesh_operation, **kwargs)¶

Update information about the mesh operation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_mesh_operation(project_id, mesh_operation_id, mesh_operation, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
mesh_operation (MeshOperation) – Mesh operation to be updated (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

update_mesh_operation_with_http_info(project_id, mesh_operation_id, mesh_operation, **kwargs)¶

Update information about the mesh operation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_mesh_operation_with_http_info(project_id, mesh_operation_id, mesh_operation, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_operation_id (str) – The mesh operation ID (required)
mesh_operation (MeshOperation) – Mesh operation to be updated (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

simscale_sdk.api.meshes_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.meshes_api.MeshesApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

get_mesh(project_id, mesh_id, **kwargs)¶

Get information about the mesh # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_mesh(project_id, mesh_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_id (str) – The mesh ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Mesh If the method is called asynchronously, returns the request thread.

get_mesh_with_http_info(project_id, mesh_id, **kwargs)¶

Get information about the mesh # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_mesh_with_http_info(project_id, mesh_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
mesh_id (str) – The mesh ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Mesh, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_meshes(project_id, **kwargs)¶

List meshes within a project # noqa: E501

Only finished and non-uploaded meshes are included. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_meshes(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Meshes If the method is called asynchronously, returns the request thread.

get_meshes_with_http_info(project_id, **kwargs)¶

List meshes within a project # noqa: E501

Only finished and non-uploaded meshes are included. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_meshes_with_http_info(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Meshes, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api.project_permissions_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.project_permissions_api.ProjectPermissionsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

get_requester_project_permissions(project_id, **kwargs)¶

Get User Project Permissions # noqa: E501

Get Info about the Permissions that the current requester user has for this Project. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_requester_project_permissions(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

ProjectPermissions If the method is called asynchronously, returns the request thread.

get_requester_project_permissions_with_http_info(project_id, **kwargs)¶

Get User Project Permissions # noqa: E501

Get Info about the Permissions that the current requester user has for this Project. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_requester_project_permissions_with_http_info(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(ProjectPermissions, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api.projects_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.projects_api.ProjectsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_project(project, **kwargs)¶

Create a new project # noqa: E501

The visibility of the Project will be determined by the available capabilities of the requesting user. If the user can create private projects, the Project will be private. Otherwise, it will be public. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_project(project, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project (Project) – Project to be created (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Project If the method is called asynchronously, returns the request thread.

create_project_with_http_info(project, **kwargs)¶

Create a new project # noqa: E501

The visibility of the Project will be determined by the available capabilities of the requesting user. If the user can create private projects, the Project will be private. Otherwise, it will be public. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_project_with_http_info(project, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project (Project) – Project to be created (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Project, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_project(project_id, **kwargs)¶

Get information about an existing project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_project(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Project If the method is called asynchronously, returns the request thread.

get_project_with_http_info(project_id, **kwargs)¶

Get information about an existing project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_project_with_http_info(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Project, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_projects(**kwargs)¶

List projects # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_projects(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Projects If the method is called asynchronously, returns the request thread.

get_projects_with_http_info(**kwargs)¶

List projects # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_projects_with_http_info(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Projects, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

update_project(project_id, project, **kwargs)¶

Update an existing project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_project(project_id, project, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
project (Project) – Project to be updated (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

update_project_with_http_info(project_id, project, **kwargs)¶

Update an existing project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_project_with_http_info(project_id, project, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
project (Project) – Project to be updated (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

simscale_sdk.api.reports_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.reports_api.ReportsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

cancel_report_job(project_id, report_id, **kwargs)¶

cancel_report_job # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_report_job(project_id, report_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
report_id (str) – The report ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

cancel_report_job_with_http_info(project_id, report_id, **kwargs)¶

cancel_report_job # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_report_job_with_http_info(project_id, report_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
report_id (str) – The report ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

create_report(project_id, report_request, **kwargs)¶

create_report # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_report(project_id, report_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
report_request (ReportRequest) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

ReportResponse If the method is called asynchronously, returns the request thread.

create_report_with_http_info(project_id, report_request, **kwargs)¶

create_report # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_report_with_http_info(project_id, report_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
report_request (ReportRequest) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(ReportResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

delete_report(project_id, report_id, **kwargs)¶

delete_report # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_report(project_id, report_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
report_id (str) – The report ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

delete_report_with_http_info(project_id, report_id, **kwargs)¶

delete_report # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_report_with_http_info(project_id, report_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
report_id (str) – The report ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

get_report(project_id, report_id, **kwargs)¶

get_report # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_report(project_id, report_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
report_id (str) – The report ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

ReportResponse If the method is called asynchronously, returns the request thread.

get_report_with_http_info(project_id, report_id, **kwargs)¶

get_report # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_report_with_http_info(project_id, report_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
report_id (str) – The report ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(ReportResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_reports(project_id, **kwargs)¶

get_reports # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_reports(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID if given
run_id (str) – The simulation run ID if given
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

ReportResponses If the method is called asynchronously, returns the request thread.

get_reports_with_http_info(project_id, **kwargs)¶

get_reports # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_reports_with_http_info(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID if given
run_id (str) – The simulation run ID if given
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(ReportResponses, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

start_report_job(project_id, report_id, **kwargs)¶

start_report_job # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.start_report_job(project_id, report_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
report_id (str) – The report ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

start_report_job_with_http_info(project_id, report_id, **kwargs)¶

start_report_job # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.start_report_job_with_http_info(project_id, report_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
report_id (str) – The report ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

update_report(project_id, report_id, report_request, **kwargs)¶

update_report # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_report(project_id, report_id, report_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
report_id (str) – The report ID (required)
report_request (ReportRequest) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

ReportResponse If the method is called asynchronously, returns the request thread.

update_report_with_http_info(project_id, report_id, report_request, **kwargs)¶

update_report # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_report_with_http_info(project_id, report_id, report_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
report_id (str) – The report ID (required)
report_request (ReportRequest) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(ReportResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api.simulation_runs_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.simulation_runs_api.SimulationRunsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

add_wind_data_to_simulation_run(project_id, simulation_id, run_id, wind_data, **kwargs)¶

Add wind data to a simulation run (works only for PWC runs) # noqa: E501

You can use this endpoint to add wind data to an existing PWC run. This means that for the new run, only the statistical surface solution will be regenerated based on the new wind data, while the individual results of each direction will be kept from the original run. This endpoint is only used to trigger the execution of the new simulation run - before calling this endpoint make sure to update the simulation spec with the new wind data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_wind_data_to_simulation_run(project_id, simulation_id, run_id, wind_data, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
wind_data (WindData) – Metadata of the newly created simulation run (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

SimulationRun If the method is called asynchronously, returns the request thread.

add_wind_data_to_simulation_run_with_http_info(project_id, simulation_id, run_id, wind_data, **kwargs)¶

Add wind data to a simulation run (works only for PWC runs) # noqa: E501

You can use this endpoint to add wind data to an existing PWC run. This means that for the new run, only the statistical surface solution will be regenerated based on the new wind data, while the individual results of each direction will be kept from the original run. This endpoint is only used to trigger the execution of the new simulation run - before calling this endpoint make sure to update the simulation spec with the new wind data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_wind_data_to_simulation_run_with_http_info(project_id, simulation_id, run_id, wind_data, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
wind_data (WindData) – Metadata of the newly created simulation run (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(SimulationRun, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

cancel_simulation_run(project_id, simulation_id, run_id, **kwargs)¶

Cancel the simulation run # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_simulation_run(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

cancel_simulation_run_sub_run(project_id, simulation_id, run_id, sub_run_id, **kwargs)¶

Cancel the sub-run of a parametric run # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_simulation_run_sub_run(project_id, simulation_id, run_id, sub_run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
sub_run_id (str) – The simulation sub-run ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

cancel_simulation_run_sub_run_with_http_info(project_id, simulation_id, run_id, sub_run_id, **kwargs)¶

Cancel the sub-run of a parametric run # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_simulation_run_sub_run_with_http_info(project_id, simulation_id, run_id, sub_run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
sub_run_id (str) – The simulation sub-run ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

cancel_simulation_run_with_http_info(project_id, simulation_id, run_id, **kwargs)¶

Cancel the simulation run # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_simulation_run_with_http_info(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

create_simulation_run(project_id, simulation_id, simulation_run, **kwargs)¶

Create a simulation run # noqa: E501

This operation creates a run in status READY, however the run is not automatically started. The run must be started explicitly using the POST /projects/{projectId}/simulations/{simulationId}/runs/{runId}/start endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_simulation_run(project_id, simulation_id, simulation_run, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
simulation_run (SimulationRun) – Simulation run to be created (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

SimulationRun If the method is called asynchronously, returns the request thread.

create_simulation_run_with_http_info(project_id, simulation_id, simulation_run, **kwargs)¶

Create a simulation run # noqa: E501

This operation creates a run in status READY, however the run is not automatically started. The run must be started explicitly using the POST /projects/{projectId}/simulations/{simulationId}/runs/{runId}/start endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_simulation_run_with_http_info(project_id, simulation_id, simulation_run, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
simulation_run (SimulationRun) – Simulation run to be created (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(SimulationRun, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

delete_simulation_run_sub_run(project_id, simulation_id, run_id, sub_run_id, **kwargs)¶

Delete the sub-run of a parametric run # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_simulation_run_sub_run(project_id, simulation_id, run_id, sub_run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
sub_run_id (str) – The simulation sub-run ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

delete_simulation_run_sub_run_with_http_info(project_id, simulation_id, run_id, sub_run_id, **kwargs)¶

Delete the sub-run of a parametric run # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_simulation_run_sub_run_with_http_info(project_id, simulation_id, run_id, sub_run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
sub_run_id (str) – The simulation sub-run ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

get_simulation_run(project_id, simulation_id, run_id, **kwargs)¶

Get basic information about the simulation run # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

SimulationRun If the method is called asynchronously, returns the request thread.

get_simulation_run_event_log(project_id, simulation_id, run_id, **kwargs)¶

Get the simulation run event log # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_event_log(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

EventLogResponse If the method is called asynchronously, returns the request thread.

get_simulation_run_event_log_with_http_info(project_id, simulation_id, run_id, **kwargs)¶

Get the simulation run event log # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_event_log_with_http_info(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(EventLogResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_simulation_run_results(project_id, simulation_id, run_id, **kwargs)¶

List available results for a simulation runs # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_results(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
type (str) – The result type. The possible values are ‘SOLUTION_FIELD’, ‘CONVERGENCE_PLOT’, ‘PLOT’, ‘TABLE’.
category (str) – The result category. For solution fields values include ‘SOLUTION’, ‘AVERAGED_SOLUTION’, ‘TRANSIENT_SOLUTION’, ‘STATISTICAL_SURFACE_SOLUTION’, etc. For convergence plots values include ‘RESIDUALS_PLOT’, ‘NUMBER_OF_NEWTON_ITERATIONS’, etc. For plots values include ‘FORCE_PLOT’, ‘MOMENT_PLOT’, ‘FORCE_COEFFICIENTS_PLOT’, ‘PROBE_POINT_PLOT’, ‘AREA_AVERAGE’, ‘FACE_CALC’, etc.
quantity (str) – The result quantity, only applies to plot result types. Valid values include ‘Ux’, ‘Uy’, ‘Uz’, ‘p’, ‘k’, ‘omega’, ‘T’, ‘displacement’, ‘von Mises stress’, etc.
name (str) – The name that was defined for extra simulation result outputs.
direction (float) – The result direction, only applies to Pedestrian Wind Comfort analysis.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

SimulationRunResults If the method is called asynchronously, returns the request thread.

get_simulation_run_results_with_http_info(project_id, simulation_id, run_id, **kwargs)¶

List available results for a simulation runs # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_results_with_http_info(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
type (str) – The result type. The possible values are ‘SOLUTION_FIELD’, ‘CONVERGENCE_PLOT’, ‘PLOT’, ‘TABLE’.
category (str) – The result category. For solution fields values include ‘SOLUTION’, ‘AVERAGED_SOLUTION’, ‘TRANSIENT_SOLUTION’, ‘STATISTICAL_SURFACE_SOLUTION’, etc. For convergence plots values include ‘RESIDUALS_PLOT’, ‘NUMBER_OF_NEWTON_ITERATIONS’, etc. For plots values include ‘FORCE_PLOT’, ‘MOMENT_PLOT’, ‘FORCE_COEFFICIENTS_PLOT’, ‘PROBE_POINT_PLOT’, ‘AREA_AVERAGE’, ‘FACE_CALC’, etc.
quantity (str) – The result quantity, only applies to plot result types. Valid values include ‘Ux’, ‘Uy’, ‘Uz’, ‘p’, ‘k’, ‘omega’, ‘T’, ‘displacement’, ‘von Mises stress’, etc.
name (str) – The name that was defined for extra simulation result outputs.
direction (float) – The result direction, only applies to Pedestrian Wind Comfort analysis.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(SimulationRunResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_simulation_run_sdk_code(project_id, simulation_id, run_id, **kwargs)¶

Get Python SDK code for the simulation run # noqa: E501

Important: due to incompatibilities between the source Spec version and the target SDK version the generated code may contain incomplete sections or even be invalid. The generated code is provided as a convenience and should be reviewed and adapted before use. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_sdk_code(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
sdk_version (str) – Version of the SDK to generate code for
sdk_language (str) – Language of the SDK to generate code for. Only Python is currently supported.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

str If the method is called asynchronously, returns the request thread.

get_simulation_run_sdk_code_with_http_info(project_id, simulation_id, run_id, **kwargs)¶

Get Python SDK code for the simulation run # noqa: E501

Important: due to incompatibilities between the source Spec version and the target SDK version the generated code may contain incomplete sections or even be invalid. The generated code is provided as a convenience and should be reviewed and adapted before use. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_sdk_code_with_http_info(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
sdk_version (str) – Version of the SDK to generate code for
sdk_language (str) – Language of the SDK to generate code for. Only Python is currently supported.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_simulation_run_spec(project_id, simulation_id, run_id, **kwargs)¶

Get the simulation run spec # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_spec(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
simulation_spec_schema_version (str) – Version of the schema the simulation spec should conform to
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

SimulationSpec If the method is called asynchronously, returns the request thread.

get_simulation_run_spec_with_http_info(project_id, simulation_id, run_id, **kwargs)¶

Get the simulation run spec # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_spec_with_http_info(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
simulation_spec_schema_version (str) – Version of the schema the simulation spec should conform to
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(SimulationSpec, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_simulation_run_sub_run_results(project_id, simulation_id, run_id, sub_run_id, **kwargs)¶

Get the simulation sub-run results # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_sub_run_results(project_id, simulation_id, run_id, sub_run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
sub_run_id (str) – The simulation sub-run ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
type (str) – The result type. The possible values are ‘SOLUTION_FIELD’, ‘CONVERGENCE_PLOT’, ‘PLOT’, ‘TABLE’.
category (str) – The result category. For solution fields values include ‘SOLUTION’, ‘AVERAGED_SOLUTION’, ‘TRANSIENT_SOLUTION’, ‘STATISTICAL_SURFACE_SOLUTION’, etc. For convergence plots values include ‘RESIDUALS_PLOT’, ‘NUMBER_OF_NEWTON_ITERATIONS’, etc. For plots values include ‘FORCE_PLOT’, ‘MOMENT_PLOT’, ‘FORCE_COEFFICIENTS_PLOT’, ‘PROBE_POINT_PLOT’, ‘AREA_AVERAGE’, ‘FACE_CALC’, etc.
quantity (str) – The result quantity, only applies to plot result types. Valid values include ‘Ux’, ‘Uy’, ‘Uz’, ‘p’, ‘k’, ‘omega’, ‘T’, ‘displacement’, ‘von Mises stress’, etc.
name (str) – The name that was defined for extra simulation result outputs.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

SimulationRunResults If the method is called asynchronously, returns the request thread.

get_simulation_run_sub_run_results_with_http_info(project_id, simulation_id, run_id, sub_run_id, **kwargs)¶

Get the simulation sub-run results # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_sub_run_results_with_http_info(project_id, simulation_id, run_id, sub_run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
sub_run_id (str) – The simulation sub-run ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
type (str) – The result type. The possible values are ‘SOLUTION_FIELD’, ‘CONVERGENCE_PLOT’, ‘PLOT’, ‘TABLE’.
category (str) – The result category. For solution fields values include ‘SOLUTION’, ‘AVERAGED_SOLUTION’, ‘TRANSIENT_SOLUTION’, ‘STATISTICAL_SURFACE_SOLUTION’, etc. For convergence plots values include ‘RESIDUALS_PLOT’, ‘NUMBER_OF_NEWTON_ITERATIONS’, etc. For plots values include ‘FORCE_PLOT’, ‘MOMENT_PLOT’, ‘FORCE_COEFFICIENTS_PLOT’, ‘PROBE_POINT_PLOT’, ‘AREA_AVERAGE’, ‘FACE_CALC’, etc.
quantity (str) – The result quantity, only applies to plot result types. Valid values include ‘Ux’, ‘Uy’, ‘Uz’, ‘p’, ‘k’, ‘omega’, ‘T’, ‘displacement’, ‘von Mises stress’, etc.
name (str) – The name that was defined for extra simulation result outputs.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(SimulationRunResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_simulation_run_sub_run_spec(project_id, simulation_id, run_id, sub_run_id, **kwargs)¶

Get the simulation sub-run spec # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_sub_run_spec(project_id, simulation_id, run_id, sub_run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
sub_run_id (str) – The simulation sub-run ID (required)
simulation_spec_schema_version (str) – Version of the schema the simulation spec should conform to
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

SimulationSpec If the method is called asynchronously, returns the request thread.

get_simulation_run_sub_run_spec_with_http_info(project_id, simulation_id, run_id, sub_run_id, **kwargs)¶

Get the simulation sub-run spec # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_sub_run_spec_with_http_info(project_id, simulation_id, run_id, sub_run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
sub_run_id (str) – The simulation sub-run ID (required)
simulation_spec_schema_version (str) – Version of the schema the simulation spec should conform to
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(SimulationSpec, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_simulation_run_sub_runs(project_id, simulation_id, run_id, **kwargs)¶

List of subruns of parametric runs # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_sub_runs(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

SimulationRuns If the method is called asynchronously, returns the request thread.

get_simulation_run_sub_runs_with_http_info(project_id, simulation_id, run_id, **kwargs)¶

List of subruns of parametric runs # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_sub_runs_with_http_info(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(SimulationRuns, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_simulation_run_with_http_info(project_id, simulation_id, run_id, **kwargs)¶

Get basic information about the simulation run # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_run_with_http_info(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(SimulationRun, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_simulation_runs(project_id, simulation_id, **kwargs)¶

List simulation runs for a simulation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_runs(project_id, simulation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

SimulationRuns If the method is called asynchronously, returns the request thread.

get_simulation_runs_with_http_info(project_id, simulation_id, **kwargs)¶

List simulation runs for a simulation # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_runs_with_http_info(project_id, simulation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(SimulationRuns, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

start_simulation_run(project_id, simulation_id, run_id, **kwargs)¶

Start the simulation run # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.start_simulation_run(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

start_simulation_run_with_http_info(project_id, simulation_id, run_id, **kwargs)¶

Start the simulation run # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.start_simulation_run_with_http_info(project_id, simulation_id, run_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

update_simulation_run(project_id, simulation_id, run_id, simulation_run, **kwargs)¶

Update an existing simulation run # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_simulation_run(project_id, simulation_id, run_id, simulation_run, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
simulation_run (SimulationRun) – Simulation run to be updated (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

update_simulation_run_with_http_info(project_id, simulation_id, run_id, simulation_run, **kwargs)¶

Update an existing simulation run # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_simulation_run_with_http_info(project_id, simulation_id, run_id, simulation_run, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
run_id (str) – The simulation run ID (required)
simulation_run (SimulationRun) – Simulation run to be updated (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

simscale_sdk.api.simulations_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.simulations_api.SimulationsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

check_simulation_setup(project_id, simulation_id, **kwargs)¶

Check the simulation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_simulation_setup(project_id, simulation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

CheckResponse If the method is called asynchronously, returns the request thread.

check_simulation_setup_with_http_info(project_id, simulation_id, **kwargs)¶

Check the simulation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.check_simulation_setup_with_http_info(project_id, simulation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(CheckResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

create_geometry_primitive(project_id, geometry_primitive, **kwargs)¶

Create a geometry primitive for reference within a Simulation spec. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_geometry_primitive(project_id, geometry_primitive, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_primitive (GeometryPrimitive) – Geometry primitive specification. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

GeometryPrimitiveResponse If the method is called asynchronously, returns the request thread.

create_geometry_primitive_with_http_info(project_id, geometry_primitive, **kwargs)¶

Create a geometry primitive for reference within a Simulation spec. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_geometry_primitive_with_http_info(project_id, geometry_primitive, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
geometry_primitive (GeometryPrimitive) – Geometry primitive specification. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(GeometryPrimitiveResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

create_simulation(project_id, simulation_spec, **kwargs)¶

Create a simulation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_simulation(project_id, simulation_spec, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_spec (SimulationSpec) – Simulation to be created (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Simulation If the method is called asynchronously, returns the request thread.

create_simulation_with_http_info(project_id, simulation_spec, **kwargs)¶

Create a simulation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_simulation_with_http_info(project_id, simulation_spec, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_spec (SimulationSpec) – Simulation to be created (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Simulation, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

estimate_simulation_setup(project_id, simulation_id, **kwargs)¶

Estimate the simulation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.estimate_simulation_setup(project_id, simulation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Estimation If the method is called asynchronously, returns the request thread.

estimate_simulation_setup_with_http_info(project_id, simulation_id, **kwargs)¶

Estimate the simulation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.estimate_simulation_setup_with_http_info(project_id, simulation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Estimation, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_simulation(project_id, simulation_id, **kwargs)¶

Get information about the simulation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation(project_id, simulation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
simulation_spec_schema_version (str) – Version of the schema the simulation spec should conform to
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

SimulationSpec If the method is called asynchronously, returns the request thread.

get_simulation_sdk_code(project_id, simulation_id, **kwargs)¶

Get Python SDK code for the simulation # noqa: E501

Important: due to incompatibilities between the source Spec version and the target SDK version the generated code may contain incomplete sections or even be invalid. The generated code is provided as a convenience and should be reviewed and adapted before use. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_sdk_code(project_id, simulation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
sdk_version (str) – Version of the SDK to generate code for
sdk_language (str) – Language of the SDK to generate code for. Only Python is currently supported.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

str If the method is called asynchronously, returns the request thread.

get_simulation_sdk_code_with_http_info(project_id, simulation_id, **kwargs)¶

Get Python SDK code for the simulation # noqa: E501

Important: due to incompatibilities between the source Spec version and the target SDK version the generated code may contain incomplete sections or even be invalid. The generated code is provided as a convenience and should be reviewed and adapted before use. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_sdk_code_with_http_info(project_id, simulation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
sdk_version (str) – Version of the SDK to generate code for
sdk_language (str) – Language of the SDK to generate code for. Only Python is currently supported.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_simulation_with_http_info(project_id, simulation_id, **kwargs)¶

Get information about the simulation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulation_with_http_info(project_id, simulation_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
simulation_spec_schema_version (str) – Version of the schema the simulation spec should conform to
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(SimulationSpec, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_simulations(project_id, **kwargs)¶

List simulation setups within a project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulations(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Simulations If the method is called asynchronously, returns the request thread.

get_simulations_with_http_info(project_id, **kwargs)¶

List simulation setups within a project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_simulations_with_http_info(project_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
limit (int) – The number of items to return.
page (int) – The page number. Use in combination with limit.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Simulations, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

update_simulation(project_id, simulation_id, simulation_spec, **kwargs)¶

Update information about the simulation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_simulation(project_id, simulation_id, simulation_spec, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
simulation_spec (SimulationSpec) – Simulation to be updated (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

update_simulation_materials(project_id, simulation_id, material_update_request, **kwargs)¶

Update materials in the simulation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_simulation_materials(project_id, simulation_id, material_update_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
material_update_request (MaterialUpdateRequest) – Material update operations (required)
preview (bool) – If present and true, the update material operation(s) will not be persisted and the returned response will only be a preview of the simulation.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

MaterialUpdateResponse If the method is called asynchronously, returns the request thread.

update_simulation_materials_with_http_info(project_id, simulation_id, material_update_request, **kwargs)¶

Update materials in the simulation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_simulation_materials_with_http_info(project_id, simulation_id, material_update_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
material_update_request (MaterialUpdateRequest) – Material update operations (required)
preview (bool) – If present and true, the update material operation(s) will not be persisted and the returned response will only be a preview of the simulation.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(MaterialUpdateResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

update_simulation_with_http_info(project_id, simulation_id, simulation_spec, **kwargs)¶

Update information about the simulation setup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_simulation_with_http_info(project_id, simulation_id, simulation_spec, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
simulation_id (str) – The simulation ID (required)
simulation_spec (SimulationSpec) – Simulation to be updated (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

None If the method is called asynchronously, returns the request thread.

simscale_sdk.api.space_permissions_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.space_permissions_api.SpacePermissionsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

get_requester_space_permissions(space_id, **kwargs)¶

Get User Space Permissions # noqa: E501

Get Info about the Permissions that the current requester user has in this Space. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_requester_space_permissions(space_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

SpacePermissions If the method is called asynchronously, returns the request thread.

get_requester_space_permissions_with_http_info(space_id, **kwargs)¶

Get User Space Permissions # noqa: E501

Get Info about the Permissions that the current requester user has in this Space. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_requester_space_permissions_with_http_info(space_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(SpacePermissions, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

list_space_permissions(space_id, **kwargs)¶

List Space Permissions # noqa: E501

See who has access to a Space # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_space_permissions(space_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Permissions If the method is called asynchronously, returns the request thread.

list_space_permissions_with_http_info(space_id, **kwargs)¶

List Space Permissions # noqa: E501

See who has access to a Space # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_space_permissions_with_http_info(space_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Permissions, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

update_space_permissions(space_id, permissions, **kwargs)¶

Update Space Permissions # noqa: E501

Update who has access to a Space. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_space_permissions(space_id, permissions, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
permissions (Permissions) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Permissions If the method is called asynchronously, returns the request thread.

update_space_permissions_with_http_info(space_id, permissions, **kwargs)¶

Update Space Permissions # noqa: E501

Update who has access to a Space. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_space_permissions_with_http_info(space_id, permissions, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
permissions (Permissions) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Permissions, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api.spaces_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.spaces_api.SpacesApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

get_space_info(space_id, **kwargs)¶

Get Space Info # noqa: E501

Get Space metadata, current user permissions, and view Space settings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_space_info(space_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Space If the method is called asynchronously, returns the request thread.

get_space_info_with_http_info(space_id, **kwargs)¶

Get Space Info # noqa: E501

Get Space metadata, current user permissions, and view Space settings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_space_info_with_http_info(space_id, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – The space ID (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Space, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_user_spaces(**kwargs)¶

Get User Spaces # noqa: E501

Get Info about the User Personal Space and all the Team Spaces the user has access to. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_user_spaces(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Spaces If the method is called asynchronously, returns the request thread.

get_user_spaces_with_http_info(**kwargs)¶

Get User Spaces # noqa: E501

Get Info about the User Personal Space and all the Team Spaces the user has access to. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_user_spaces_with_http_info(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Spaces, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

update_space(space_id, space, **kwargs)¶

Update Space # noqa: E501

Update Space metadata and settings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_space(space_id, space, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
space (Space) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Space If the method is called asynchronously, returns the request thread.

update_space_with_http_info(space_id, space, **kwargs)¶

Update Space # noqa: E501

Update Space metadata and settings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_space_with_http_info(space_id, space, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
space_id (str) – (required)
space (Space) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Space, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api.storage_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.storage_api.StorageApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_storage(**kwargs)¶

Create a temporary storage location # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_storage(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Storage If the method is called asynchronously, returns the request thread.

create_storage_with_http_info(**kwargs)¶

Create a temporary storage location # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_storage_with_http_info(async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(Storage, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api.table_imports_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.table_imports_api.TableImportsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

import_table(project_id, table_import_request, **kwargs)¶

Import a new table for reference within a Simulation spec. # noqa: E501

Table import requires the following steps: 1. Request a temporary storage location via POST /storage. 2. Upload your table definition using the HTTP PUT method to the url provided in the temporary storage location response object. 3. Import via POST /projects/{projectId}/tableimports and include the storageId provided in the temporary storage location response object. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.import_table(project_id, table_import_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
table_import_request (TableImportRequest) – Table import specification. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

TableImportResponse If the method is called asynchronously, returns the request thread.

import_table_with_http_info(project_id, table_import_request, **kwargs)¶

Import a new table for reference within a Simulation spec. # noqa: E501

Table import requires the following steps: 1. Request a temporary storage location via POST /storage. 2. Upload your table definition using the HTTP PUT method to the url provided in the temporary storage location response object. 3. Import via POST /projects/{projectId}/tableimports and include the storageId provided in the temporary storage location response object. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.import_table_with_http_info(project_id, table_import_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
project_id (str) – The project ID (required)
table_import_request (TableImportRequest) – Table import specification. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(TableImportResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api.users_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.users_api.UsersApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

signup_user(user_signup_request, **kwargs)¶

Signup a user # noqa: E501

Signup a new user. The current requester user needs to be authenticated. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.signup_user(user_signup_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
user_signup_request (UserSignupRequest) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

UserSignupResponse If the method is called asynchronously, returns the request thread.

signup_user_with_http_info(user_signup_request, **kwargs)¶

Signup a user # noqa: E501

Signup a new user. The current requester user needs to be authenticated. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.signup_user_with_http_info(user_signup_request, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
user_signup_request (UserSignupRequest) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(UserSignupResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api.wind_api module¶

SimScale API

The version of the OpenAPI document: 0.0.0 Generated by: https://openapi-generator.tech

class simscale_sdk.api.wind_api.WindApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

get_wind_data(latitude, longitude, **kwargs)¶

Get wind condition for given coordinates # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_wind_data(latitude, longitude, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
latitude (str) – Latitude coordinate in WGS84 format (required)
longitude (str) – Longitude coordinate in WGS84 format (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

WindRoseResponse If the method is called asynchronously, returns the request thread.

get_wind_data_with_http_info(latitude, longitude, **kwargs)¶

Get wind condition for given coordinates # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_wind_data_with_http_info(latitude, longitude, async_req=True) >>> result = thread.get()

Parameters:

bool (async_req) – execute request asynchronously
latitude (str) – Latitude coordinate in WGS84 format (required)
longitude (str) – Longitude coordinate in WGS84 format (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

tuple(WindRoseResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

simscale_sdk.api package¶

Submodules¶

simscale_sdk.api.ai_models_api module¶

simscale_sdk.api.folders_api module¶

simscale_sdk.api.geometries_api module¶

simscale_sdk.api.geometry_imports_api module¶

simscale_sdk.api.materials_api module¶

simscale_sdk.api.mesh_operations_api module¶

simscale_sdk.api.meshes_api module¶

simscale_sdk.api.project_permissions_api module¶

simscale_sdk.api.projects_api module¶

simscale_sdk.api.reports_api module¶

simscale_sdk.api.simulation_runs_api module¶

simscale_sdk.api.simulations_api module¶

simscale_sdk.api.space_permissions_api module¶

simscale_sdk.api.spaces_api module¶

simscale_sdk.api.storage_api module¶

simscale_sdk.api.table_imports_api module¶

simscale_sdk.api.users_api module¶

simscale_sdk.api.wind_api module¶

SimScale Python SDK

Navigation

Related Topics