Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Download mer data #83

Merged
merged 2 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/ansys/simai/core/api/workspace.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,6 @@ def delete_workspace(self, workspace_id: str):

def download_workspace_model_evaluation_report(self, workspace_id: str, file: Optional[File]):
return self.download_file(f"workspaces/{workspace_id}/model-evaluation-report", file)

def download_workspace_mer_data(self, workspace_id: str, file: Optional[File]):
return self.download_file(f"workspaces/{workspace_id}/mer-data", file)
11 changes: 11 additions & 0 deletions src/ansys/simai/core/data/workspaces.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,17 @@ def download_model_evaluation_report(
"""
return self._client._api.download_workspace_model_evaluation_report(self.id, file)

def download_mer_data(self, file: Optional[File] = None) -> Union[None, BinaryIO]:
"""Download the the names, subsets and plotting data of the files used in the AI model and MER for the workspace.

Args:
file: Binary file-object or the path of the file to put the content into.

Returns:
``None`` if a file is specified or a binary file-object otherwise.
"""
return self._client._api.download_workspace_mer_data(self.id, file)


class WorkspaceDirectory(Directory[Workspace]):
"""Provides a collection of methods related to workspaces.
Expand Down
49 changes: 49 additions & 0 deletions tests/test_workspace.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
# SPDX-License-Identifier: MIT
#
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

from typing import TYPE_CHECKING

import responses

if TYPE_CHECKING:
from ansys.simai.core.data.workspaces import Workspace


@responses.activate
def test_workspace_download_mer_data(simai_client):
"""WHEN downloading mer csv file
THEN the content of the file matches the content of the response.
"""

workspace: Workspace = simai_client._workspace_directory._model_from(
{"id": "0011", "name": "riri"}
)
responses.add(
responses.GET,
f"https://test.test/workspaces/{workspace.id}/mer-data",
body=b"mer-data-geometries",
status=200,
)

in_memory = workspace.download_mer_data()
data_in_file = in_memory.readline()
assert data_in_file.decode("ascii") == "mer-data-geometries"
Loading