Skip to content

Commit 207c1fd

Browse files
authored
Update README (#246)
* Update README.rst * Create AUTHORS.md
1 parent 3574a44 commit 207c1fd

File tree

2 files changed

+11
-19
lines changed

2 files changed

+11
-19
lines changed

AUTHORS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Authors
2+
3+
## Project Lead
4+
5+
* [Alex Kaszynski](https://github.com/akaszynski)
6+
7+
## Contributors
8+
9+
* [German Martinez Ayuso](https://github.com/germa89)

README.rst

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Please see the `PyMAPDL-Reader Documentation
5858
modules at `PyDPF-Core <https://github.com/pyansys/pydpf-core>`_ and
5959
`PyDPF-Post <https://github.com/pyansys/pydpf-post>`_ as they provide a
6060
modern interface to Ansys result files using a client/server
61-
interface using the same software used within Ansys Workbench, but
61+
interface using the same software used within Ansys Mechanical, but
6262
via a Python client.
6363

6464

@@ -72,22 +72,6 @@ You can also visit `pymapdl-reader <https://github.com/pyansys/pymapdl-reader>`_
7272
to download the source or releases from GitHub.
7373

7474

75-
Python 3.10 Extra Instructions
76-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77-
78-
PyMAPDL-Reader requires the `VTK library <https://vtk.org/>`_ which, at the
79-
moment, is not available for Python 3.10 in `their official channel
80-
<https://pypi.org/project/vtk/>`_.
81-
82-
If you wish to install PyMAPDL-Reader in Python 3.10, you can still do it by
83-
using the unofficial VTK wheel from PyVista using ``--find-links``. This tells ``pip`` to look for vtk at `wheels.pyvista.org <https://wheels.pyvista.org/>`_. Use this with::
84-
85-
pip install ansys-mapdl-reader --find-links https://wheels.pyvista.org/
86-
87-
Please visit `Unofficial VTK Wheels for Python 3.10
88-
<https://github.com/pyvista/pyvista/discussions/2064>`_ for further details.
89-
90-
9175
Examples
9276
--------
9377

@@ -313,12 +297,11 @@ you will need to install your own C++ compiler. We recommend:
313297
314298
1. Install Visual C++
315299
a. See `here <https://wiki.python.org/moin/WindowsCompilers>`_ for a list of which Python versions correspond to which Visual C++ version
316-
b. Only Python <= 3.8 appears to be supported at the moment.
317300
2. Install the development version of pymapdl-reader to your Python environment
318301
a. Navigate to the project's top level (the same directory as this README)
319302
b. run ``pip install -e .``
320303
321304
322305
License and Acknowledgments
323306
---------------------------
324-
The ``ansys-mapdl-reader`` module is licensed under the MIT license.
307+
The ``ansys-mapdl-reader`` library is licensed under the MIT license.

0 commit comments

Comments
 (0)