Merged PR 236741: move from codedv

move from codedv

Related work items: #308291

Author: cbellot000

.gitignore

@@ -0,0 +1,52 @@
+
+
+#########################
+## DPF
+#########################
+
+# cache and pyc
+__pycache__
+.pytest_cache
+.spyproject
+
+#tests
+__pycache__
+/tests/.pytest_cache
+
+#ansys/dpf
+/ansys/dpf/__pycache__
+
+#ansys/dpf/core
+/ansys/dpf/core/__pycache__
+
+#operators
+/ansys/dpf/core/operators/__pycache__
+
+#other
+/perso
+.ipynb_checkpoints/
+
+# compiled documentation
+docs/build
+docs/source/examples
+
+# pip files
+*.egg-info
+build/
+dist/
+
+# emacs
+flycheck*
+*~
+\#*\#
+.\#*
+
+# docker bin
+docker/v211
+
+# pytest -coverage
+.coverage
+test-output.xml
+
+# downloaded files
+ansys/dpf/core/examples/_cache/

README.md

@@ -1,20 +1,17 @@
-# Introduction 
-TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project. 
+# DPF
+ANSYS Data Processing Framework.
 
-# Getting Started
-TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
-1.	Installation process
-2.	Software dependencies
-3.	Latest releases
-4.	API references
+## Disclaimer
 
-# Build and Test
-TODO: Describe and show how to build your code and run the tests. 
+This API is currently a work in progress - things will break and change!
 
-# Contribute
-TODO: Explain how other users and developers can contribute to make your code better. 
 
-If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files:
-- [ASP.NET Core](https://github.com/aspnet/Home)
-- [Visual Studio Code](https://github.com/Microsoft/vscode)
-- [Chakra Core](https://github.com/Microsoft/ChakraCore)
+## Get Started
+
+Clone or copy this directory and then install using:
+
+```
+pip install . --user
+```
+
+See the example scripts in the examples folder for some basic example.  More will be added later.

ansys/dpf/core/__init__.py

@@ -0,0 +1,81 @@
+import os
+import socket
+
+from ansys.dpf.core._version import __version__
+
+# environment variables for pyansys.com
+if 'jupyter' in socket.gethostname():
+    if 'ANSYS_PATH' not in os.environ:
+        os.environ['ANSYS_PATH'] = '/mnt/ansys_inc/v212/'
+    if 'DPF_PATH' not in os.environ:
+        os.environ['DPF_PATH'] = '/mnt/ansys_inc/dpf/bin_v%s/Ans.dpf.core.Grpc.exe' % __version__
+    if 'AWP_UNIT_TEST_FILES' not in os.environ:
+        os.environ['AWP_UNIT_TEST_FILES'] = '/mnt/ansys_inc/dpf/test_files/'
+
+from ansys.dpf.core.misc import module_exists, Report
+from ansys.dpf.core.dpf_operator import Operator, Config
+from ansys.dpf.core.model import Model
+from ansys.dpf.core.field import Field, FieldDefinition, Dimensionnality
+from ansys.dpf.core.fields_container import FieldsContainer
+from ansys.dpf.core.meshes_container import MeshesContainer
+from ansys.dpf.core.scopings_container import ScopingsContainer
+from ansys.dpf.core.server import (start_local_server, _global_server,
+                                   connect_to_server)
+from ansys.dpf.core.data_sources import DataSources
+from ansys.dpf.core.scoping import Scoping
+from ansys.dpf.core.common import types, natures, locations, shell_layers
+from ansys.dpf.core.core import BaseService, load_library, download_file, upload_file, upload_file_in_tmp_folder
+from ansys.dpf.core.time_freq_support import TimeFreqSupport
+from ansys.dpf.core.operators_helper import sum, to_nodal, norm, eqv, element_dot, sqr
+from ansys.dpf.core.meshed_region import MeshedRegion
+from ansys.dpf.core.result_info import ResultInfo
+from ansys.dpf.core.collection import Collection
+from ansys.dpf.core.workflow import Workflow
+from ansys.dpf.core import operators
+from ansys.dpf.core.fields_factory import field_from_array
+
+# for matplotlib
+# solves "QApplication: invalid style override passed, ignoring it."
+os.environ['QT_STYLE_OVERRIDE'] = ''
+
+# Setup data directory
+USER_DATA_PATH = None
+EXAMPLES_PATH = None
+if os.environ.get('DPF_DOCKER', False):  # pragma: no cover
+    # Running DPF within docker (likely for CI)
+    # path must be relative to DPF directory
+    #
+    # assumes the following docker mount:
+    # -v /tmp:/dpf/_cache
+    EXAMPLES_PATH = '/tmp'
+else:
+    try:
+        import appdirs
+        USER_DATA_PATH = appdirs.user_data_dir('ansys-dpf-core')
+        if not os.path.exists(USER_DATA_PATH):  # pragma: no cover
+            os.makedirs(USER_DATA_PATH)
+
+        EXAMPLES_PATH = os.path.join(USER_DATA_PATH, 'examples')
+        if not os.path.exists(EXAMPLES_PATH):  # pragma: no cover
+            os.makedirs(EXAMPLES_PATH)
+    except:  # pragma: no cover
+        pass
+
+
+# Configure PyVista's ``rcParams`` for dpf
+if module_exists("pyvista"):
+    import pyvista as pv
+    pv.rcParams['interactive'] = True
+    pv.rcParams["cmap"] = "jet"
+    pv.rcParams["font"]["family"] = "courier"
+    pv.rcParams["title"] = "DPF"
+
+
+SERVER = None
+
+def has_local_server():
+    """Returns True when a local DPF gRPC server has been created"""
+    return SERVER is not None
+
+
+_server_instances = []

ansys/dpf/core/_version.py

@@ -0,0 +1,7 @@
+"""Version for ansys-dpf-core"""
+# major, minor, patch
+version_info = 0, 2, 1
+
+# Nice string for the version
+__version__ = '.'.join(map(str, version_info))
+__ansys_version__ = "212"

ansys/dpf/core/aeneid.py

@@ -0,0 +1,44 @@
+from ansys.dpf.core.server import DpfServer
+
+"""Aeneid specific functions and classes"""
+
+def start_server_using_service_manager():  # pragma: no cover
+    if dpf.core.module_exists("grpc_interceptor_headers"):
+        import grpc_interceptor_headers
+        from  grpc_interceptor_headers.header_manipulator_client_interceptor import header_adder_interceptor    
+    else:
+        raise ValueError('Module grpc_interceptor_headers is missing to use service manager, please install it using pip install grpc_interceptor_headers')
+
+    service_manager_url = f"http://{LOCALHOST}:8089/v1"
+
+    definition = requests.get(url=service_manager_url + "/definitions/dpf").json()
+    rsp = requests.post(url=service_manager_url + "/jobs", json=definition)
+    job = rsp.json()
+
+    dpf_task = job['taskGroups'][0]['tasks'][0]
+    dpf_service = dpf_task['services'][0]
+    dpf_service_name = dpf_service['name']
+    dpf_url = f"{dpf_service['host']}:{dpf_service['port']}"
+
+    channel = grpc.insecure_channel(dpf_url)
+    header_adder =  header_adder_interceptor('service-name', dpf_service_name)
+    intercept_channel = grpc.intercept_channel(channel, header_adder)
+    dpf.core.SERVER = DpfJob(service_manager_url, dpf_service_name,intercept_channel)
+
+    dpf.core._server_instances.append(dpf.core.SERVER)
+
+
+class DpfJob(DpfServer) # pragma: no cover
+    def __init__(self, service_manager_url, job_name, channel):
+        self.sm_url = service_manager_url
+        self.job_name = job_name
+        super().channel = channel
+
+    def shutdown(self):
+        requests.delete(url=f'{self.sm_url}/jobs/{self.job_name}')
+
+    def __del__(self):
+        try:
+            self.shutdown()
+        except:
+            pass

ansys/dpf/core/available_result.py

@@ -0,0 +1,77 @@
+from warnings import warn
+from ansys.grpc.dpf import available_result_pb2, base_pb2
+from ansys.dpf.core.common import remove_spaces
+
+class AvailableResult:
+    """A class used to represent an Available result which can be
+    requested via an operator
+
+    Parameters
+    ----------
+    availableresult : AvailableResult message
+    """
+
+    def __init__(self, availableresult):
+        """Initialize the AvailableResult with an availableResult message"""
+        self._message = availableresult
+
+    def __str__(self):
+        txt = self.name+'\n' +\
+              'Operator name: "%s"\n' % self.operator_name +\
+              'Number of components: %d\n' % self.n_components +\
+              'Dimensionality: %s\n' % self.dimensionality +\
+              'Homogeneity: %s\n' % self.homogeneity
+        if self.unit:
+            txt += 'Units: %s\n' % self.unit
+        return txt
+
+    @property
+    def name(self):
+        """Result operator"""
+        return remove_spaces(self._message.physicsname)
+
+    @property
+    def n_components(self):
+        """Number of components of the results"""
+        return self._message.ncomp
+
+    @property
+    def dimensionality(self):
+        """Dimensionality nature of the result (vector, scalar, tensor...)"""
+        return base_pb2.Nature.Name(self._message.dimensionality).lower()
+
+    @property
+    def homogeneity(self):
+        """Homogeneity of the result"""
+        try:
+            homogeneity = self._message.homogeneity
+            return available_result_pb2.Homogeneity.Name(homogeneity).lower()
+        except ValueError as exception:
+            warn(str(exception))
+            return ''
+
+    @property
+    def unit(self):
+        """Unit of the result"""
+        return self._message.unit.lower()
+
+    @property
+    def operator_name(self):
+        """Name of the corresponding operator"
+        """
+        return self._message.name
+    
+    @property
+    def sub_results(self):
+        """List of sub result"
+        """
+        rep_sub_res =self._message.sub_res
+        list = []
+        for sub_res in rep_sub_res:
+            try :
+                int(sub_res.name)
+                dict ={"name":"principal"+sub_res.name, "operator name":sub_res.op_name, "description":sub_res.description }
+            except :
+                dict ={"name":sub_res.name, "operator name":sub_res.op_name, "description":sub_res.description }
+            list.append(dict)
+        return list