Skip to content

Commit a71472e

Browse files
PipKatPProfizi
andauthored
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]>
1 parent 9647d1e commit a71472e

File tree

2 files changed

+31
-28
lines changed

2 files changed

+31
-28
lines changed

README.md

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -39,33 +39,36 @@ without ever leaving the Python environment.
3939

4040
## Documentation
4141

42-
Visit the [DPF-Core Documentation](https://dpfdocs.pyansys.com) for a
43-
detailed description of the library, or see the [Examples
44-
Gallery](https://dpfdocs.pyansys.com/version/stable/examples/index.html) for more
45-
detailed examples.
42+
Visit the [DPF-Core Documentation](https://dpfdocs.pyansys.com) for
43+
comprehensive information on this library. See the
44+
[Examples](https://dpfdocs.pyansys.com/version/stable/examples/index.html)
45+
for how-to information.
4646

4747
## Installation
4848

49-
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
52-
[here](https://dpfdocs.pyansys.com/version/stable/getting_started/index.html#compatibility).
49+
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.
5352

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,
5558
install the latest version with this command:
5659

5760
```con
5861
pip install ansys-dpf-core
5962
```
6063

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:
6366

6467
```con
6568
pip install ansys-dpf-core[plotting]
6669
```
6770

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.
6972

7073
To use PyDPF-Core with Ansys 2021 R1, install the latest version
7174
with this command:
@@ -74,14 +77,11 @@ with this command:
7477
pip install ansys-dpf-core<0.3.0
7578
```
7679

80+
### Brief demo
7781

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.
8383

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:
8585

8686
```pycon
8787
>>> from ansys.dpf import core as dpf
@@ -120,31 +120,29 @@ To open a result file and explore what's inside, do:
120120

121121
```
122122

123-
Read a result with:
123+
Read a result with this command:
124124

125125
```pycon
126126
>>> result = model.results.displacement.eval()
127127
```
128128

129-
Then start connecting operators with:
129+
Then, start connecting operators with this code:
130130

131131
```pycon
132132
>>> from ansys.dpf.core import operators as ops
133133
>>> norm = ops.math.norm(model.results.displacement())
134134
```
135135

136-
### Starting the Service
136+
### Starting the service
137137

138138
The ``ansys.dpf.core`` library automatically starts a local instance of the DPF service in the
139139
background and connects to it. If you need to connect to an existing
140-
remote or local DPF instance, use the ``connect_to_server`` function:
140+
remote or local DPF instance, use the ``connect_to_server`` method:
141141

142142
```pycon
143143
>>> from ansys.dpf import core as dpf
144144
>>> dpf.connect_to_server(ip='10.0.0.22', port=50054)
145145
```
146146

147-
Once connected, this connection will remain for the duration of the
148-
module until you exit python or connect to a different server.
149-
150-
147+
Once connected, this connection remains for the duration of the
148+
module. It closes when you exit Python or connect to a different server.

docs/source/contributing.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,14 @@ Post issues
2828
Use the `PyDPF-Core Issues <https://github.com/pyansys/pydpf-core/issues>`_
2929
page to submit questions, report bugs, and request new features.
3030

31-
To reach the PyAnsys support team, email `pyansys.support@ansys.com <pyansys.support@ansys.com>`_.
31+
To reach the project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.
3232

3333
View documentation
3434
------------------
3535
Documentation for the latest stable release of PyDPF-Core is hosted at
36-
`PyDPF-Core Documentation <https://dpf.docs.pyansys.com/>`_.
36+
`PyDPF-Core Documentation <https://dpf.docs.pyansys.com/>`_.
37+
38+
In the upper right corner of the documentation's title bar, there is an option
39+
for switching from viewing the documentation for the latest stable release
40+
to viewing the documentation for the development version or previously
41+
released versions.

0 commit comments

Comments
 (0)