Skip to content

Commit 036d78d

Browse files
authored
Mention virtualenv before the install command (#597)
Move the note to use virtual environments before the first `pip` commands, since users may otherwise install the package globally before reading the note. 2026R1 hardening item 39.
1 parent 27af277 commit 036d78d

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

doc/source/intro.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Installation
77
PyDPF - Composites supports Ansys version 2023 R1 and later. Make sure you have a licensed copy of Ansys installed. See
88
:ref:`Compatibility` to understand which ``ansys-dpf-composites`` version corresponds to which Ansys version.
99

10+
You should use a `virtual environment <https://docs.python.org/3/library/venv.html>`_,
11+
because it keeps Python packages isolated from your system Python.
12+
1013
Install the ``ansys-dpf-composites`` package with ``pip``:
1114

1215
.. code::
@@ -27,10 +30,6 @@ Specific versions can be installed by specifying the version in the pip command.
2730
pip install ansys-dpf-composites==0.3.0
2831
2932
30-
You should use a `virtual environment <https://docs.python.org/3/library/venv.html>`_,
31-
because it keeps Python packages isolated from your system Python.
32-
33-
3433
Examples
3534
^^^^^^^^
3635

0 commit comments

Comments
 (0)