Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update install commands #281

Merged
merged 5 commits into from
Mar 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions docs/source/_templates/sidebar-nav-bs.html

This file was deleted.

53 changes: 44 additions & 9 deletions docs/source/getting_started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)