Merge branch 'master' into maint/order_operators_init

Author: PProfizi

.github/ISSUE_TEMPLATE/bug.yml

@@ -61,6 +61,8 @@ body:
       label: Which DPF/Ansys version are you using?
       multiple: false
       options:
+       - 'Ansys 2024 R1'
+       - 'Ansys 2023 R2'
        - 'DPF Server 2023.2.pre1'
        - 'DPF Server 2023.2.pre0'
        - 'Ansys 2023 R1'

.github/ISSUE_TEMPLATE/examples.yml

@@ -0,0 +1,75 @@
+name: 🎓 Adding an example
+description: Proposing a new example for the library
+title: "Example proposal: ..."
+labels: ["example"]
+assignees: [""]
+
+body:
+
+  - type: textarea
+    id: example-description
+    attributes:
+      label: '📝 Description of the example'
+      placeholder: Describe what example you devised and why it is useful for the project.
+
+    validations:
+      required: true
+
+  - type: textarea
+    id: example-files
+    attributes:
+      label: '📁 Files needed for running the example'
+      placeholder: >
+        Drag and drop the files used in your example, together with the script employed.
+        Test the example files before uploading to ensure they at least run on your machine.
+        Add any additional comments/explanations that maintainers may need for running the example.
+        If you have issues uploading your files because of the file extension/type, upload them
+        as a .zip file.
+    validations:
+      required: true
+
+  - type: dropdown
+    id: os-name
+    attributes:
+      label: '💻 Which operating system are you using?'
+      multiple: false
+      options:
+       - 'Windows'
+       - 'MacOS'
+       - 'Linux'
+    validations:
+      required: true
+
+  - type: textarea
+    id: ansys-version
+    attributes:
+      label: '📀 Which ANSYS version are you using?'
+      placeholder: Indicate the ANSYS version of the products you are using.
+
+    validations:
+      required: false
+
+  - type: dropdown
+    id: python-version
+    attributes:
+      label: '🐍 Which Python version are you using?'
+      description: Run `python --version` to verify your Python version
+      multiple: false
+      options:
+       - '3.7'
+       - '3.8'
+       - '3.9'
+       - '3.10'
+       - '3.11'
+    validations:
+      required: true
+
+  - type: textarea
+    id: installed-packages
+    attributes:
+      label: '📦 Installed packages'
+      description: Run `python -m pip freeze` to list installed packages
+      placeholder: Paste the output of `python -m pip freeze` here.
+      render: shell
+    validations:
+      required: true

src/ansys/dpf/core/config.py

@@ -34,6 +34,25 @@ class Config:
         Server with the channel connected to the remote or local instance. The default is
         ``None``, in which case an attempt is made to use the global server.
 
+    Examples
+    --------
+    Create an operator configuration, instantiate the operator and
+    run it with the configuration.
+
+    >>> from ansys.dpf import core as dpf
+    >>> config_add = dpf.Config("add")
+    >>> config_add.set_work_by_index_option(True)
+    >>> op = dpf.operators.math.add(config=config_add)
+
+    Modify the copy of an operator's configuration and set it as current config
+    of the operator.
+
+    >>> from ansys.dpf import core as dpf
+    >>> op = dpf.operators.math.add()
+    >>> config_add = op.config
+    >>> config_add.set_work_by_index_option(True)
+    >>> op.config = config_add
+
     """
 
     def __init__(self, operator_name=None, config=None, server=None, spec=None):
@@ -144,6 +163,18 @@ def set_config_option(self, config_name, config_value):
             Value to give to a configuration option.
         config_name : str
             Name of the configuration option.
+
+        Examples
+        --------
+        Modify the copy of an operator's configuration and set it as current config
+        of the operator.
+
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.math.add()
+        >>> config_add = op.config
+        >>> config_add.set_config_option(config_name="work_by_index", config_value=True)
+        >>> op.config = config_add
+
         """
         return self.__set_config_option__(config_value, config_name)
 

src/ansys/dpf/core/core.py

@@ -97,14 +97,6 @@ def upload_file_in_tmp_folder(file_path, new_file_name=None, server=None):
       server_file_path : str
            path generated server side
 
-    Examples
-    --------
-    >>> from ansys.dpf import core as dpf
-    >>> from ansys.dpf.core import examples
-    >>> server = dpf.start_local_server(config=dpf.AvailableServerConfigs.GrpcServer,
-    ... as_global=False)
-    >>> file_path = dpf.upload_file_in_tmp_folder(examples.find_static_rst(), server=server)
-
     Notes
     -----
     Is not implemented for usage with type(server)=
@@ -162,17 +154,6 @@ def download_file(server_file_path, to_client_file_path, server=None):
         Server with channel connected to the remote or local instance. When
         ``None``, attempts to use the global server.
 
-    Examples
-    --------
-    >>> from ansys.dpf import core as dpf
-    >>> from ansys.dpf.core import examples
-    >>> server = dpf.start_local_server(config=dpf.AvailableServerConfigs.GrpcServer,
-    ... as_global=False)
-    >>> file_path = dpf.upload_file_in_tmp_folder(examples.find_static_rst(), server=server)
-    >>> dpf.download_file(file_path, examples.find_static_rst(),  server=server)
-    <BLANKLINE>
-    ...
-
     Notes
     -----
     Is not implemented for usage with type(server)=

src/ansys/dpf/core/dpf_operator.py

@@ -474,12 +474,26 @@ def config(self):
         """Copy of the operator's current configuration.
 
         You can modify the copy of the configuration and then use ``operator.config = new_config``
-        or create an operator with the new configuration as a parameter.
+        or instantiate an operator with the new configuration as a parameter.
+
+        For information on an operator's options, see the documentation for that operator.
 
         Returns
         ----------
         :class:`ansys.dpf.core.config.Config`
             Copy of the operator's current configuration.
+
+        Examples
+        --------
+        Modify the copy of an operator's configuration and set it as current config
+        of the operator.
+
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.math.add()
+        >>> config_add = op.config
+        >>> config_add.set_work_by_index_option(True)
+        >>> op.config = config_add
+
         """
         config = self._api.operator_get_config(self)
         return Config(config=config, server=self._server, spec=self._spec)