You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Change email address and explain how to change doc versions (#905)
* Change email address and explain how to change doc versions
* Edit README
* Remove extra blank lines in README.md that are causing Codacy Static Code Analysis check to fail
---------
Co-authored-by: Paul Profizi <[email protected]>
PyDPF-Core requires DPF to be available, either thanks to a compatible Ansys installation or after installing the
50
-
standalone server package ``ansys-dpf-server`` (see [here](https://dpf.docs.pyansys.com/version/stable/user_guide/getting_started_with_dpf_server.html)).
51
-
Compatibility between PyDPF-Core and Ansys is documented
PyDPF-Core requires DPF to be available. You can either have a compatible Ansys version installed
50
+
or install the standalone ``ansys-dpf-server`` server package. For more information, see
51
+
[Getting Started with DPF Server](https://dpf.docs.pyansys.com/version/stable/user_guide/getting_started_with_dpf_server.html) in the PyDPF-Core documentation.
53
52
54
-
To use PyDPF-Core with ``ansys-dpf-server`` or Ansys 2021 R2 or later,
53
+
For the compatibility between PyDPF-Core and Ansys, see
54
+
[Compatibility](https://dpf.docs.pyansys.com/version/stable/getting_started/compatibility.html) in
55
+
the PyDPF-Core documentation.
56
+
57
+
To use PyDPF-Core with the ``ansys-dpf-server`` server package or with Ansys 2021 R2 or later,
55
58
install the latest version with this command:
56
59
57
60
```con
58
61
pip install ansys-dpf-core
59
62
```
60
63
61
-
PyDPF-Core plotting capabilities require to have `PyVista <https://pyvista.org/>`_ installed.
62
-
To install PyDPF-Core with its optional plotting functionalities, use:
64
+
PyDPF-Core plotting capabilities require `PyVista <https://pyvista.org/>`_ to be installed.
65
+
To install PyDPF-Core with its optional plotting functionalities, use this command:
63
66
64
67
```con
65
68
pip install ansys-dpf-core[plotting]
66
69
```
67
70
68
-
For more information about PyDPF-Core plotting capabilities, see [Plotting](https://dpf.docs.pyansys.com/version/stable/user_guide/plotting.html).
71
+
For more information on PyDPF-Core plotting capabilities, see [Plot](https://dpf.docs.pyansys.com/version/stable/user_guide/plotting.html) in the PyDPF-Core documentation.
69
72
70
73
To use PyDPF-Core with Ansys 2021 R1, install the latest version
71
74
with this command:
@@ -74,14 +77,11 @@ with this command:
74
77
pip install ansys-dpf-core<0.3.0
75
78
```
76
79
80
+
### Brief demo
77
81
78
-
### Brief Demo
79
-
80
-
Provided you have DPF available, either thanks to an Ansys installation or after installing the
81
-
standalone server package ``ansys-dpf-server`` (see [here](https://dpf.docs.pyansys.com/version/stable/user_guide/getting_started_with_dpf_server.html)),
82
-
a DPF server will start automatically once you start using PyDPF-Core.
82
+
Provided you have DPF available, a DPF server automatically starts once you start using PyDPF-Core.
83
83
84
-
To open a result file and explore what's inside, do:
84
+
To open a result file and explore what's inside, use this code:
85
85
86
86
```pycon
87
87
>>> from ansys.dpf import core as dpf
@@ -120,31 +120,29 @@ To open a result file and explore what's inside, do:
0 commit comments