From e18c5e4b3413ca0651028bfac08850112792b36f Mon Sep 17 00:00:00 2001 From: PProfizi <100710998+PProfizi@users.noreply.github.com> Date: Fri, 10 Feb 2023 11:16:25 +0100 Subject: [PATCH 1/5] Update install.rst --- docs/source/getting_started/install.rst | 31 ++++++++++++++++++------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/docs/source/getting_started/install.rst b/docs/source/getting_started/install.rst index 7eed9c1ff..407061a97 100644 --- a/docs/source/getting_started/install.rst +++ b/docs/source/getting_started/install.rst @@ -7,23 +7,38 @@ Installation Install using ``pip`` --------------------- -`pip `_ is the package installer for Python. +The standard package installer for Python is `pip `_. + To use PyDPF-Post with Ansys 2021 R1 or later, install the latest version -with: +with this command: .. code:: pip install ansys-dpf-post +To install PyDPF-Post with its optional plotting functionalities, use: + +.. code:: + pip install ansys-dpf-post[plotting] + -Install using a wheel file --------------------------- +Install without internet +------------------------ + +If you are unable to install PyDPF-Post on the host machine using ``pip`` due to +network isolation, download the wheelhouse corresponding to your platform and Python interpreter version +for the latest release of PyDPF-Post from the assets section of the `latest PyDPF-Post release on GitHub `_. + +The wheelhouse is a ZIP file containing Python wheels for all the packages PyDPF-Post requires to run. +To install PyDPF-Post using the downloaded wheelhouse, unzip the wheelhouse to a local directory, +then use the following command from within this local directory: +.. code:: -If you are unable to install PyDPF-Post on the host machine due to -network isolation, download the latest wheel file from `PyDPF-Post -GitHub `_ or -`PyDPF-Post PyPi `_. + pip install --no-index --find-links=. ansys-dpf-post +Beware that PyDPF-Post wheelhouses do not include the optional plotting dependencies. +To allow for plotting capabilities, also download the wheel corresponding to your platform and Python interpreter version +for `PyVista `_, then place it in the same previous local directory and run the command above. Install in development mode --------------------------- From 13257a99c12b3f52c0d6ddb38c2357b98b99c9d3 Mon Sep 17 00:00:00 2001 From: "paul.profizi" Date: Fri, 10 Feb 2023 11:58:13 +0100 Subject: [PATCH 2/5] Update install section of the getting_started page --- docs/source/getting_started/install.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/source/getting_started/install.rst b/docs/source/getting_started/install.rst index 407061a97..8669292bd 100644 --- a/docs/source/getting_started/install.rst +++ b/docs/source/getting_started/install.rst @@ -16,11 +16,14 @@ with this command: pip install ansys-dpf-post +PyDPF-Post plotting capabilities require to have `PyVista `_ installed. To install PyDPF-Post with its optional plotting functionalities, use: .. code:: pip install ansys-dpf-post[plotting] +For more information about PyDPF-Post plotting capabilities, see :ref:`_user_guide_plotting`. + Install without internet ------------------------ @@ -40,6 +43,7 @@ Beware that PyDPF-Post wheelhouses do not include the optional plotting dependen To allow for plotting capabilities, also download the wheel corresponding to your platform and Python interpreter version for `PyVista `_, then place it in the same previous local directory and run the command above. + Install in development mode --------------------------- @@ -48,3 +52,16 @@ clone the repository and install it using ``pip`` with the ``-e`` development flag: .. include:: ../pydpf-post_clone_install.rst + + +Check the installation +---------------------- + +Run the following Python code to verify your PyDPF-Post installation: + +.. code:: + + from ansys.dpf import post + from ansys.dpf.post import examples + solution = post.load_solution(examples.simple_bar) + print(solution) From 8c1e5318539784146f8af6dc4781d047c1e74aa8 Mon Sep 17 00:00:00 2001 From: PProfizi <100710998+PProfizi@users.noreply.github.com> Date: Thu, 2 Mar 2023 18:43:05 +0100 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: German <28149841+germa89@users.noreply.github.com> Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> --- docs/source/getting_started/install.rst | 28 ++++++++++++++----------- 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/docs/source/getting_started/install.rst b/docs/source/getting_started/install.rst index 8669292bd..83bf72ac4 100644 --- a/docs/source/getting_started/install.rst +++ b/docs/source/getting_started/install.rst @@ -12,14 +12,15 @@ The standard package installer for Python is `pip `_ installed. -To install PyDPF-Post with its optional plotting functionalities, use: +PyDPF-Post plotting capabilities require an installation of `PyVista `_. +To install PyDPF-Post with its optional plotting functionalities, use this command: + +.. code:: bash -.. code:: pip install ansys-dpf-post[plotting] For more information about PyDPF-Post plotting capabilities, see :ref:`_user_guide_plotting`. @@ -29,19 +30,22 @@ Install without internet ------------------------ If you are unable to install PyDPF-Post on the host machine using ``pip`` due to -network isolation, download the wheelhouse corresponding to your platform and Python interpreter version -for the latest release of PyDPF-Post from the assets section of the `latest PyDPF-Post release on GitHub `_. +network isolation, you can download the wheelhouse corresponding to your platform +and Python interpreter version. To obtain the latest release, go to the **Assets** section +for the `latest PyDPF-Post release `_ + on GitHub. The wheelhouse is a ZIP file containing Python wheels for all the packages PyDPF-Post requires to run. -To install PyDPF-Post using the downloaded wheelhouse, unzip the wheelhouse to a local directory, -then use the following command from within this local directory: -.. code:: +To install PyDPF-Post using the downloaded wheelhouse, unzip the wheelhouse to a local directory and +then run the following command from within this local directory: + +.. code:: bash pip install --no-index --find-links=. ansys-dpf-post Beware that PyDPF-Post wheelhouses do not include the optional plotting dependencies. -To allow for plotting capabilities, also download the wheel corresponding to your platform and Python interpreter version -for `PyVista `_, then place it in the same previous local directory and run the command above. +To allow for plotting capabilities, also download the `PyVista wheel `_ +and unzip it to the same local directory before running the preceding command again. Install in development mode @@ -59,7 +63,7 @@ Check the installation Run the following Python code to verify your PyDPF-Post installation: -.. code:: +.. code:: bash from ansys.dpf import post from ansys.dpf.post import examples From 9e0aa6b07a1098fd19714de32d439b4bd9b9af5a Mon Sep 17 00:00:00 2001 From: "paul.profizi" Date: Mon, 6 Mar 2023 14:24:44 +0100 Subject: [PATCH 4/5] Remove sidebar-nav-bs.html --- docs/source/_templates/sidebar-nav-bs.html | 9 --------- 1 file changed, 9 deletions(-) delete mode 100644 docs/source/_templates/sidebar-nav-bs.html diff --git a/docs/source/_templates/sidebar-nav-bs.html b/docs/source/_templates/sidebar-nav-bs.html deleted file mode 100644 index 07de2cbc4..000000000 --- a/docs/source/_templates/sidebar-nav-bs.html +++ /dev/null @@ -1,9 +0,0 @@ - From bb9f5e203703434d0dfa52b0f54926fa8c183aa3 Mon Sep 17 00:00:00 2001 From: "paul.profizi" Date: Mon, 6 Mar 2023 14:44:59 +0100 Subject: [PATCH 5/5] Fix ref and newline --- docs/source/getting_started/install.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/source/getting_started/install.rst b/docs/source/getting_started/install.rst index 83bf72ac4..47bff99d5 100644 --- a/docs/source/getting_started/install.rst +++ b/docs/source/getting_started/install.rst @@ -23,7 +23,7 @@ To install PyDPF-Post with its optional plotting functionalities, use this comma pip install ansys-dpf-post[plotting] -For more information about PyDPF-Post plotting capabilities, see :ref:`_user_guide_plotting`. +For more information about PyDPF-Post plotting capabilities, see :ref:`user_guide_plotting`. Install without internet @@ -32,8 +32,7 @@ Install without internet If you are unable to install PyDPF-Post on the host machine using ``pip`` due to network isolation, you can download the wheelhouse corresponding to your platform and Python interpreter version. To obtain the latest release, go to the **Assets** section -for the `latest PyDPF-Post release `_ - on GitHub. +for the `latest PyDPF-Post release `_ on GitHub. The wheelhouse is a ZIP file containing Python wheels for all the packages PyDPF-Post requires to run. To install PyDPF-Post using the downloaded wheelhouse, unzip the wheelhouse to a local directory and