Update install commands (#281)

* Update install.rst * Update install section of the getting_started page * Apply suggestions from code review Co-authored-by: German <[email protected]> Co-authored-by: Kathy Pippert <[email protected]> * Remove sidebar-nav-bs.html * Fix ref and newline --------- Co-authored-by: German <[email protected]> Co-authored-by: Kathy Pippert <[email protected]>
ansys · Mar 6, 2023 · c5b81ba · c5b81ba
1 parent 11d6408
commit c5b81ba
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 18 deletions.
diff --git a/docs/source/_templates/sidebar-nav-bs.html b/docs/source/_templates/sidebar-nav-bs.html
diff --git a/docs/source/getting_started/install.rst b/docs/source/getting_started/install.rst
@@ -7,22 +7,44 @@ Installation
 Install using ``pip``
 ---------------------
 
-`pip <https://pypi.org/project/pip/>`_ is the package installer for Python.
+The standard package installer for Python is `pip <https://pypi.org/project/pip/>`_.
+
 To use PyDPF-Post with Ansys 2021 R1 or later, install the latest version
-with:
+with this command:
 
-.. code::
+.. code:: bash
 
    pip install ansys-dpf-post
 
+PyDPF-Post plotting capabilities require an installation of `PyVista <https://pyvista.org/>`_.
+To install PyDPF-Post with its optional plotting functionalities, use this command:
+
+.. code:: bash
+
+   pip install ansys-dpf-post[plotting]
+
+For more information about PyDPF-Post plotting capabilities, see :ref:`user_guide_plotting`.
+
+
+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 <https://github.com/pyansys/pydpf-post/releases/latest>`_ on GitHub.
 
-Install using a wheel file
---------------------------
+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
+then run the following command from within this local directory:
 
-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 <https://github.com/pyansys/pydpf-post>`_ or
-`PyDPF-Post PyPi <https://pypi.org/project/ansys-dpf-post/>`_.
+.. 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 `PyVista wheel <https://pypi.org/project/pyvista/#files>`_
+and unzip it to the same local directory before running the preceding command again.
 
 
 Install in development mode
@@ -33,3 +55,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:: bash
+
+   from ansys.dpf import post
+   from ansys.dpf.post import examples
+   solution = post.load_solution(examples.simple_bar)
+   print(solution)