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.

Sign up for GitHub

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

Add and document an [examples] extra requirement #525

Merged
merged 3 commits into from
Sep 27, 2024
Merged

Add and document an [examples] extra requirement #525

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d0e66a
Add and document an [examples] extra requirement
greschd Sep 26, 2024
0407898
Update doc/source/intro.rst
greschd Sep 26, 2024
c624ecc
Update doc/source/intro.rst
greschd Sep 27, 2024
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: 8 additions & 1 deletion doc/source/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,14 @@ Install the ``ansys-dpf-composites`` package with ``pip``:

pip install ansys-dpf-composites

Specific versions can be installed by specifying the version in the pip command. For example: Ansys 2023 R1 requires ansys-dpf-composites version 0.1.0:

To install the optional requirements used in the examples, add the ``[examples]`` suffix when installing the package:
greschd marked this conversation as resolved.
Show resolved Hide resolved

.. code::

pip install ansys-dpf-composites[examples]
nshum4 marked this conversation as resolved.
Show resolved Hide resolved

Specific versions can be installed by specifying the version in the pip command. For example, Ansys 2023 R1 requires ansys-dpf-composites version 0.1.0:

.. code::

Expand Down
Loading