Merge pull request #159 from boschresearch/135-abaqus-2024

odbclient for Abaqus 2024

Author: johannes-mueller

Diff for: setup.cfg

@@ -66,6 +66,7 @@ unit-testing =
     setuptools
     pytest
     pytest-cov
+    pytest-timeout
     hypothesis
 
 testing =

Diff for: tools/odbclient/setup.cfg

@@ -57,6 +57,7 @@ exclude =
 testing =
     setuptools
     pytest
+    pytest-timout
     pytest-cov
 
 [options.entry_points]

Diff for: tools/odbclient/src/odbclient/odbclient.py

@@ -129,17 +129,20 @@ class OdbClient:
     """
 
     def __init__(self, odb_file, abaqus_bin=None, python_env_path=None):
+        abaqus_bin = abaqus_bin or _guess_abaqus_bin()
+
         self._proc = None
-        env = os.environ
-        env['PYTHONPATH'] = _guess_pythonpath(python_env_path)
 
+        env = os.environ | {"PYTHONPATH": _guess_pythonpath(python_env_path, abaqus_bin)}
         lock_file_exists = os.path.isfile(os.path.splitext(odb_file)[0] + '.lck')
 
-        abaqus_bin = abaqus_bin or _guess_abaqus_bin()
-
-        self._proc = sp.Popen([abaqus_bin, 'python', '-m', 'odbserver', odb_file],
-                              stdout=sp.PIPE, stdin=sp.PIPE, stderr=sp.PIPE,
-                              env=env)
+        self._proc = sp.Popen(
+            [abaqus_bin, 'python', '-m', 'odbserver', odb_file],
+            stdout=sp.PIPE,
+            stdin=sp.PIPE,
+            stderr=sp.PIPE,
+            env=env,
+        )
 
         if lock_file_exists:
             self._gulp_lock_file_warning()
@@ -491,9 +494,9 @@ def _parse_response(self):
         pickle_data = b''
         while True:
             line = self._proc.stdout.readline().rstrip() + b'\n'
-            pickle_data += line
-            if line == b'.\n':
+            if line == b'\n':
                 break
+            pickle_data += line
         return pickle.loads(pickle_data, encoding='bytes')
 
     def __del__(self):
@@ -548,21 +551,39 @@ def _guess_abaqus_bin_windows():
         r"C:/Program Files/SIMULIA/2020/EstProducts/win_b64/code/bin/ABQLauncher.exe",
         r"C:/Program Files/SIMULIA/2020/Products/win_b64/code/bin/ABQLauncher.exe",
         r"C:/Program Files/SIMULIA/2021/EstProducts/win_b64/code/bin/ABQLauncher.exe",
+        r"C:/Program Files/SIMULIA/2022/EstProducts/win_b64/code/bin/SMALauncher.exe",
+        r"C:/Program Files/SIMULIA/2023/EstProducts/win_b64/code/bin/SMALauncher.exe",
+        r"C:/Program Files/SIMULIA/2024/EstProducts/win_b64/code/bin/SMALauncher.exe",
     ]
     for guess in guesses:
         if os.path.exists(guess):
             return guess
     raise OSError("Could not guess abaqus binary path! Please submit as abaqus_bin parameter!")
 
 
-def _guess_pythonpath(python_env_path):
+def _guess_pythonpath(python_env_path, abaqus_bin):
     python_env_path = _guess_python_env_path(python_env_path)
     if python_env_path is None:
         raise OSError("No odbserver environment found.\n"
                       "Please see https://github.com/boschresearch/pylife/blob/develop/tools/odbserver/README.md")
     if sys.platform == 'win32':
         return os.path.join(python_env_path, 'lib', 'site-packages')
-    return os.path.join(python_env_path, 'lib', 'python2.7', 'site-packages')
+
+    python_version = _determine_server_python_version(abaqus_bin)
+    return os.path.join(python_env_path, 'lib', f'python{python_version}', 'site-packages')
+
+
+def _determine_server_python_version(abaqus_bin):
+    proc = sp.Popen(
+        [abaqus_bin, 'python', '--version'],
+        stdout=sp.PIPE,
+        stdin=sp.PIPE,
+        stderr=sp.PIPE,
+    )
+    msg = proc.stdout.readline() or proc.stderr.readline()
+    version_string = msg.decode().split(" ")[1]
+    return version_string[:version_string.rfind(".")]
+
 
 
 def _guess_python_env_path(python_env_path):

Diff for: tools/odbclient/tests/beam_3d_hex_quad.odb renamed to tools/odbclient/tests/beam_3d_hex_quad-2022.odb

@@ -20,9 +20,12 @@
 need an Abaqus installation to run.
 """
 
+import sys
 import os
 import pytest
 import json
+import shutil
+from pathlib import Path
 
 import numpy as np
 import pandas as pd
@@ -32,8 +35,32 @@
 from odbclient.odbclient import OdbServerError
 
 @pytest.fixture
-def client():
-    return odbclient.OdbClient('tests/beam_3d_hex_quad.odb')
+def datapath():
+    base = os.path.dirname(__file__)
+
+    def join_path(filename):
+        return os.path.join(base, filename)
+
+    return join_path
+
+
+@pytest.fixture(params=["2022", "2023", "2024"])
+def abaqus_version(request):
+    return request.param
+
+
+@pytest.fixture
+def abaqus_bin(abaqus_version):
+    if sys.platform == 'win32':
+        return f"C:/Program Files/SIMULIA/{abaqus_version}/EstProducts/win_b64/code/bin/SMALauncher.exe"
+    return shutil.which(f"abaqus{abaqus_version}")
+
+
+@pytest.fixture
+def client(datapath, abaqus_version, abaqus_bin):
+    python_path = os.path.join(Path.home(), ".conda", "envs", f"odbserver-{abaqus_version}")
+    odb_file = datapath(f"beam_3d_hex_quad-{abaqus_version}.odb")
+    return odbclient.OdbClient(odb_file, abaqus_bin=abaqus_bin, python_env_path=python_path)
 
 
 def test_not_existing_odbserver_env():
@@ -54,8 +81,9 @@ def test_odbclient_invalid_instance(client):
     with pytest.raises(KeyError):
         client.node_coordinates("FOO-1-1")
 
-def test_odbclient_node_coordinates(client):
-    expected = pd.read_csv('tests/node_coordinates.csv', index_col='node_id')
+
+def test_odbclient_node_coordinates(client, datapath):
+    expected = pd.read_csv(datapath('node_coordinates.csv'), index_col='node_id')
     pd.testing.assert_frame_equal(client.node_coordinates('PART-1-1'), expected)
 
 
@@ -106,10 +134,8 @@ def test_odbclient_elset_names_invalid_instance_name(client):
         client.elset_names('nonexistent')
 
 
-def test_element_connectivity(client):
-    expected = pd.read_json(
-        'tests/connectivity.json', orient="index"
-    )
+def test_element_connectivity(client, datapath):
+    expected = pd.read_json(datapath('connectivity.json'), orient="index")
     expected.index.names = ["element_id"]
 
     result = client.element_connectivity('PART-1-1')
@@ -141,8 +167,8 @@ def test_variable_names(client):
     np.testing.assert_array_equal(result, expected)
 
 
-def test_variable_stress_element_nodal(client):
-    expected = pd.read_csv('tests/stress_element_nodal.csv', index_col=['node_id', 'element_id'])
+def test_variable_stress_element_nodal(client, datapath):
+    expected = pd.read_csv(datapath('stress_element_nodal.csv'), index_col=['node_id', 'element_id'])
     result = client.variable('S', 'PART-1-1', 'Load', 1)
 
     pd.testing.assert_frame_equal(result, expected)
@@ -160,17 +186,20 @@ def test_variable_invalid_instance_name(client):
         client.variable('S', 'nonexistent', 'Load', 1)
 
 
-def test_variable_stress_integration_point(client):
-    expected = pd.read_csv('tests/stress_integration_point.csv',
-                           index_col=['element_id', 'ipoint_id'])
+def test_variable_stress_integration_point(client, datapath):
+    expected = pd.read_csv(
+        datapath('stress_integration_point.csv'), index_col=['element_id', 'ipoint_id']
+    )
     result = client.variable('S', 'PART-1-1', 'Load', 1, position='INTEGRATION POINTS')
-    result.to_csv('tests/stress_integration_point.csv')
+    result.to_csv(datapath('stress_integration_point.csv'))
     pd.testing.assert_frame_equal(result, expected)
 
 
-@pytest.fixture
-def client_history():
-    return odbclient.OdbClient('tests/history_output_test.odb')
+@pytest.fixture()
+def client_history(datapath, abaqus_version, abaqus_bin):
+    python_path = os.path.join(Path.home(), ".conda", "envs", f"odbserver-{abaqus_version}")
+    odb_file = datapath(f"history_output_test-{abaqus_version}.odb")
+    return odbclient.OdbClient(odb_file, abaqus_bin=abaqus_bin, python_env_path=python_path)
 
 
 def test_history_region_empty(client):
@@ -202,19 +231,111 @@ def test_history_outputs(client_history):
         'CUR3',
     ]
 
+
 def test_history_output_values(client_history):
     assert client_history.history_output_values("Step-1", 'Element ASSEMBLY.1', 'CTF1').array[1] == pytest.approx(0.09999854117631912)
 
 
-def test_history_region_description(client_history):
-    assert (
-        client_history.history_region_description("Step-1", 'Element ASSEMBLY.1')
-        == "Output at assembly ASSEMBLY instance ASSEMBLY element 1"
-    )
-
-
-def test_history_info(client_history):
-    expected = json.loads("""
-{"Output at assembly ASSEMBLY instance ASSEMBLY node 1 region RP-1": {"History Outputs": ["RF1", "RF2", "RF3", "RM1", "RM2", "RM3", "U1", "U2", "U3", "UR1", "UR2", "UR3"], "History Region": "Node ASSEMBLY.1", "Steps ": ["Step-1", "Step-2"]}, "Output at assembly ASSEMBLY instance ASSEMBLY element 1": {"History Outputs": ["CTF1", "CTF2", "CTF3", "CTM1", "CTM2", "CTM3", "CU1", "CU2", "CU3", "CUR1", "CUR2", "CUR3"], "History Region": "Element ASSEMBLY.1", "Steps ": ["Step-1", "Step-2"]}, "Output at assembly ASSEMBLY instance ASSEMBLY node 2 region SET-5": {"History Outputs": ["RF1", "RF2", "RF3", "RM1", "RM2", "RM3", "U1", "U2", "U3", "UR1", "UR2", "UR3"], "History Region": "Node ASSEMBLY.2", "Steps ": ["Step-1", "Step-2"]}, "Output at assembly ASSEMBLY": {"History Outputs": ["ALLAE", "ALLCCDW", "ALLCCE", "ALLCCEN", "ALLCCET", "ALLCCSD", "ALLCCSDN", "ALLCCSDT", "ALLCD", "ALLDMD", "ALLDTI", "ALLEE", "ALLFD", "ALLIE", "ALLJD", "ALLKE", "ALLKL", "ALLPD", "ALLQB", "ALLSD", "ALLSE", "ALLVD", "ALLWK", "ETOTAL"], "History Region": "Assembly ASSEMBLY", "Steps ": ["Step-1", "Step-2"]}}
-    """)
-    assert client_history.history_info() == expected
+def test_history_region_description(client_history, abaqus_version):
+    result = client_history.history_region_description("Step-1", 'Element ASSEMBLY.1')
+    expected = "Output at assembly ASSEMBLY instance ASSEMBLY element 1"
+    if abaqus_version == "2024":
+        expected += " region _PICKEDSET21"
+    assert result == expected
+
+
+def test_history_info(client_history, abaqus_version):
+    expected = {
+        "Output at assembly ASSEMBLY": {
+            "History Outputs": [
+                "ALLAE",
+                "ALLCCDW",
+                "ALLCCE",
+                "ALLCCEN",
+                "ALLCCET",
+                "ALLCCSD",
+                "ALLCCSDN",
+                "ALLCCSDT",
+                "ALLCD",
+                "ALLDMD",
+                "ALLDTI",
+                "ALLEE",
+                "ALLFD",
+                "ALLIE",
+                "ALLJD",
+                "ALLKE",
+                "ALLKL",
+                "ALLPD",
+                "ALLQB",
+                "ALLSD",
+                "ALLSE",
+                "ALLVD",
+                "ALLWK",
+                "ETOTAL",
+            ],
+            "History Region": "Assembly ASSEMBLY",
+            "Steps ": ["Step-1", "Step-2"],
+        },
+        "Output at assembly ASSEMBLY instance ASSEMBLY node 1 region RP-1": {
+            "History Outputs": [
+                "RF1",
+                "RF2",
+                "RF3",
+                "RM1",
+                "RM2",
+                "RM3",
+                "U1",
+                "U2",
+                "U3",
+                "UR1",
+                "UR2",
+                "UR3",
+            ],
+            "History Region": "Node ASSEMBLY.1",
+            "Steps ": ["Step-1", "Step-2"],
+        },
+        "Output at assembly ASSEMBLY instance ASSEMBLY element 1": {
+            "History Outputs": [
+                "CTF1",
+                "CTF2",
+                "CTF3",
+                "CTM1",
+                "CTM2",
+                "CTM3",
+                "CU1",
+                "CU2",
+                "CU3",
+                "CUR1",
+                "CUR2",
+                "CUR3",
+            ],
+            "History Region": "Element ASSEMBLY.1",
+            "Steps ": ["Step-1", "Step-2"],
+        },
+        "Output at assembly ASSEMBLY instance ASSEMBLY node 2 region SET-5": {
+            "History Outputs": [
+                "RF1",
+                "RF2",
+                "RF3",
+                "RM1",
+                "RM2",
+                "RM3",
+                "U1",
+                "U2",
+                "U3",
+                "UR1",
+                "UR2",
+                "UR3",
+            ],
+            "History Region": "Node ASSEMBLY.2",
+            "Steps ": ["Step-1", "Step-2"],
+        },
+    }
+    if abaqus_version == "2024":
+        expected["Output at assembly ASSEMBLY region Whole Model"] = expected.pop("Output at assembly ASSEMBLY")
+        element_1 = expected.pop("Output at assembly ASSEMBLY instance ASSEMBLY element 1")
+        expected["Output at assembly ASSEMBLY instance ASSEMBLY element 1 region _PICKEDSET21"] = element_1
+        expected["Output at assembly ASSEMBLY instance ASSEMBLY element 1 region _PICKEDSET22"] = element_1
+
+    result = client_history.history_info()
+    assert result == expected