From ff8230244f73d729ea7890c679b992202531193c Mon Sep 17 00:00:00 2001 From: "paul.profizi" Date: Thu, 2 Jun 2022 11:25:36 +0200 Subject: [PATCH 1/7] Changing Installation section of README.md --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 351324ce6a7..de41123c558 100644 --- a/README.md +++ b/README.md @@ -38,12 +38,22 @@ detailed examples. ## Installation -Install this repository with: +DPF requires an Ansys installation and must be compatible with it. +Compatibility between PyDPF-Core and Ansys is documented +[here](https://dpfdocs.pyansys.com/getting_started/index.html#compatibility). + +Starting with Ansys 2021R2, install this package with: ``` pip install ansys-dpf-core ``` +For use with Ansys 2021R1, install this package with: + +``` +pip install ansys-dpf-core==0.2.1 +``` + You can also clone and install this repository with: ``` From 44774b720b0cdb8553b2da160faad079dced8eb9 Mon Sep 17 00:00:00 2001 From: "paul.profizi" Date: Thu, 2 Jun 2022 11:58:21 +0200 Subject: [PATCH 2/7] Move Compatibility section at the top of the Getting Started page --- docs/source/getting_started/index.rst | 80 +++++++++++++-------------- 1 file changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/source/getting_started/index.rst b/docs/source/getting_started/index.rst index 987759b1c3c..6dd85c0bb64 100755 --- a/docs/source/getting_started/index.rst +++ b/docs/source/getting_started/index.rst @@ -4,6 +4,46 @@ Getting Started =============== +Compatibility +~~~~~~~~~~~~~ +DPF supports Windows 10 and CentOS 7 and later. For +more information, see `Ansys Platform Support `_. + +Other platforms may be supported by using DPF within a +containerization ecosystem such as Docker or Kubernetes. +For more information, see :ref:`docker`. + +*************************** +Client Server Compatibility +*************************** + +The `ansys.grpc.dpf `_ module should be synchronized +with the server version as shown here: + +.. list-table:: Client-Server Compatibility + :widths: 35 35 35 + :header-rows: 1 + + * - Ans.Dpf.Grpc.exe server version + - ansys.grpc.dpf python module version + - ansys.dpf.core python module version + * - 3.0 (Ansys 2022R1) + - 0.4.0 + - >=0.4.0 + * - 2.0 (Ansys 2021R2) + - 0.3.0 + - >=0.3.0 + * - 1.0 (Ansys 2021R1) + - 0.2.2 + - 0.2.* + + +Future development will try to ensure backward compatibility from the client to the server. + + +To start a server with Ans.Dpf.Grpc.bat or Ans.Dpf.Grpc.sh (used in the `start_local_server` function), +please make sure that the environment variable `AWP_ROOT{VER}` with (VER=212, 221, ...) is set. + Architecture ~~~~~~~~~~~~~ @@ -96,43 +136,3 @@ Optional package dependencies can be installed for specific usage: - `Matplotlib `_ for chart plotting - `PyVista `_ for 3D plotting - `Scooby `_ for dependency reports - -Compatibility -~~~~~~~~~~~~~ -DPF supports Windows 10 and CentOS 7 and later. For -more information, see `Ansys Platform Support `_. - -Other platforms may be supported by using DPF within a -containerization ecosystem such as Docker or Kubernetes. -For more information, see :ref:`docker`. - -*************************** -Client Server Compatibility -*************************** - -The `ansys.grpc.dpf `_ module should be synchronized -with the server version as shown here: - -.. list-table:: Client-Server Compatibility - :widths: 35 35 35 - :header-rows: 1 - - * - Ans.Dpf.Grpc.exe server version - - ansys.grpc.dpf python module version - - ansys.dpf.core python module version - * - 3.0 (Ansys 2022R1) - - 0.4.0 - - >=0.4.0 - * - 2.0 (Ansys 2021R2) - - 0.3.0 - - >=0.3.0 - * - 1.0 (Ansys 2021R1) - - 0.2.2 - - 0.2.* - - -Future development will try to ensure backward compatibility from the client to the server. - - -To start a server with Ans.Dpf.Grpc.bat or Ans.Dpf.Grpc.sh (used in the `start_local_server` function), -please make sure that the environment variable `AWP_ROOT{VER}` with (VER=212, 221, ...) is set. From 4d4ce9259208fb1f1d987ac4ea373c9ec9f54203 Mon Sep 17 00:00:00 2001 From: "paul.profizi" Date: Thu, 2 Jun 2022 12:07:54 +0200 Subject: [PATCH 3/7] Improve Install section --- docs/source/getting_started/install.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/source/getting_started/install.rst b/docs/source/getting_started/install.rst index ffdb8310336..769a75311a6 100644 --- a/docs/source/getting_started/install.rst +++ b/docs/source/getting_started/install.rst @@ -3,19 +3,24 @@ ********************* Installation with PIP ********************* -Once Ansys 2021 R1 or later is installed, you can install the -DPF-Core module with: +Once Ansys 2021 R2 or later is installed, you can install PyDPF-Core with: .. code:: pip install ansys-dpf-core -This installs the latest version of DPF-Core and all necessary +This installs the latest version of PyDPF-Core and all necessary dependencies. +To use PyDPF-Core with Ansys 2021 R1, you must install PyDPF-Core with: + +.. code:: + + pip install ansys-dpf-core<0.3.0 + If you are unable to install this module on the host machine due to -network isolation, download the latest release wheel at `DPF-Core +network isolation, download the latest or a specific release wheel at `DPF-Core GitHub `_ or from PyPi at `DPF-Core PyPi `_ From 101a70aab18bdad79e3dbfce3b53c4b98c63c441 Mon Sep 17 00:00:00 2001 From: "paul.profizi" Date: Thu, 2 Jun 2022 12:08:28 +0200 Subject: [PATCH 4/7] Improve Compatibility section --- docs/source/getting_started/index.rst | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/source/getting_started/index.rst b/docs/source/getting_started/index.rst index 6dd85c0bb64..fe914ab64ea 100755 --- a/docs/source/getting_started/index.rst +++ b/docs/source/getting_started/index.rst @@ -17,8 +17,15 @@ For more information, see :ref:`docker`. Client Server Compatibility *************************** -The `ansys.grpc.dpf `_ module should be synchronized -with the server version as shown here: +The DPF server version depends on the Ansys installation version. +The PyDPF-Core client used must be compatible with it according to the table below. +Notice that starting with Ansys 2021 R2 one can use any PyDPF-Core >= 3.0. +Only Ansys 2021 R1 requires a specific version of PyDPF-Core (0.2.*). + +Future development will always try to ensure backward compatibility from the client to the server. + +The `ansys.grpc.dpf `_ module should also be synchronized +with the server version. .. list-table:: Client-Server Compatibility :widths: 35 35 35 @@ -37,10 +44,6 @@ with the server version as shown here: - 0.2.2 - 0.2.* - -Future development will try to ensure backward compatibility from the client to the server. - - To start a server with Ans.Dpf.Grpc.bat or Ans.Dpf.Grpc.sh (used in the `start_local_server` function), please make sure that the environment variable `AWP_ROOT{VER}` with (VER=212, 221, ...) is set. From bdff583ccf86dda27310f3f9e28b274513756eec Mon Sep 17 00:00:00 2001 From: "paul.profizi" Date: Thu, 2 Jun 2022 14:49:11 +0200 Subject: [PATCH 5/7] Add compatibility check-box to the issue template --- .github/ISSUE_TEMPLATE/bug.yml | 79 ++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000000..6a6ac749fe0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,79 @@ +name: 🐞 Bug, problem, error +description: Fill a bug report here +title: "Bug located in ..." +labels: ["bug"] +assignees: [""] + +body: + + - type: markdown + attributes: + value: '# 🐞 **Problem**' + + - type: checkboxes + id: new-bug + attributes: + label: Before submitting the issue + description: Please, make sure the following conditions are met + options: + - label: I have checked for [Compatibility](https://dpfdocs.pyansys.com/getting_started/index.html#compatibility) issues + required: true + - label: I have searched among the existing issues + required: true + - label: I am using a Python virtual environment + required: true + + - type: textarea + id: bug-description + attributes: + label: Description of the bug + placeholder: Describe what bug you encountered and what should have happened + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps To Reproduce + placeholder: Please write the steps in a list form + validations: + required: true + + - type: markdown + attributes: + value: '# 🖥️ **System Information**' + + - type: dropdown + id: os-name + attributes: + label: Which Operating System are you using? + multiple: false + options: + - 'Windows' + - 'MacOS' + - 'Linux' + validations: + required: true + + - 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' + 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 + validations: + required: true \ No newline at end of file From 242aa78019a61f6ba4f820f13c82b85c390167a7 Mon Sep 17 00:00:00 2001 From: PProfizi <100710998+PProfizi@users.noreply.github.com> Date: Thu, 2 Jun 2022 18:33:02 +0200 Subject: [PATCH 6/7] Update docs/source/getting_started/index.rst Co-authored-by: Camille Bellot <80476446+cbellot000@users.noreply.github.com> --- docs/source/getting_started/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/getting_started/index.rst b/docs/source/getting_started/index.rst index fe914ab64ea..bf016f76992 100755 --- a/docs/source/getting_started/index.rst +++ b/docs/source/getting_started/index.rst @@ -6,7 +6,7 @@ Getting Started Compatibility ~~~~~~~~~~~~~ -DPF supports Windows 10 and CentOS 7 and later. For +DPF supports Windows 10 and CentOS 7 and later. For more information, see `Ansys Platform Support `_. Other platforms may be supported by using DPF within a From 8bb33d1c7f7bfa693acca8ffc7970ffa92809c90 Mon Sep 17 00:00:00 2001 From: "paul.profizi" Date: Thu, 2 Jun 2022 18:35:22 +0200 Subject: [PATCH 7/7] Remove mention of Dockers for now --- docs/source/getting_started/index.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/source/getting_started/index.rst b/docs/source/getting_started/index.rst index bf016f76992..c670feba656 100755 --- a/docs/source/getting_started/index.rst +++ b/docs/source/getting_started/index.rst @@ -9,10 +9,6 @@ Compatibility DPF supports Windows 10 and CentOS 7 and later. For more information, see `Ansys Platform Support `_. -Other platforms may be supported by using DPF within a -containerization ecosystem such as Docker or Kubernetes. -For more information, see :ref:`docker`. - *************************** Client Server Compatibility ***************************