Edits for better formatting. Also added links to PyPIM resources. (#30)

* Edits for better formatting. Also added links to PyPIM resources. * Update README.rst * Update README.rst Co-authored-by: Roberto Pastor Muela <[email protected]>
ansys · Jul 8, 2022 · 9f3d869 · 9f3d869
1 parent f9bf406
commit 9f3d869
Showing 1 changed file with 95 additions and 56 deletions.
diff --git a/README.rst b/README.rst
@@ -1,12 +1,7 @@
 PyAnsys
 =======
-Welcome to the PyAnsys project.
-
-The PyAnsys project is a collection of Python packages that enable the use of
-Ansys products through Python.
-
-This project originated as a single package, ``pyansys``, and has
-expanded to several main packages:
+Welcome to the PyAnsys project. While this project originated as a single ``pyansys`` package,
+it is now a collection of many Python packages for using Ansys products through Python:
 
 - `PyAEDT <https://aedtdocs.pyansys.com/>`__ : Pythonic interface to AEDT (Ansys Electronic Desktop)
 - `PyDPF-Core <https://dpfdocs.pyansys.com/>`__ : Pythonic interface to DPF (Data Processing Framework) for building more advanced and customized workflows
@@ -22,82 +17,126 @@ Much effort is underway to continue expanding and developing packages in the
 for each package, you can post issues and request new features. You can also email
 questions to `PyAnsys Support <mailto:[email protected]>`_.
 
-PIP package installation
-------------------------
-You must install the applicable packages for an Ansys product. While there
-are multiple ways to install a Python package on your local machine, `pip
-<https://pypi.org/project/pip/>`_ is the package installer for Python. For
-your convenience, this section provides the ``pip`` commands for downloading
-and installing the most recent PyAnsys packages. The next section provides
-links to comprehensive resources for these packages.
+Package installation
+--------------------
+You must install the applicable packages for an Ansys product on your local machine.
+While there are multiple ways to install a Python package, using `pip
+<https://pypi.org/project/pip/>`_, the package installer for Python, is recommended.
+For your convenience, this section provides ``pip`` commands for downloading
+and installing the most recent PyAnsys packages and links to comprehensive resources.
+
+PyAEDT
+~~~~~~
+
+.. code::
+
+   pip install pyaedt
+
+
+- `PyAEDT Documentation <https://aedtdocs.pyansys.com/>`_
+- `PyAEDT PyPI <https://pypi.org/project/pyaedt/>`_
+- `PyAEDT GitHub <https://github.com/pyansys/PyAEDT/>`_
+
+
+PyDPF-Core
+~~~~~~~~~~
+
+.. code::
+
+   pip install ansys-dpf-core
+
+
+- `DPF-Core Documentation <https://dpfdocs.pyansys.com/>`__
+- `DPF-Core PyPI <https://pypi.org/project/ansys-dpf-core/>`__
+- `DPF-Core GitHub <https://github.com/pyansys/pydpf-core>`__
+
 
-**PyAEDT**
-``pip install pyaedt``
+PyDPF-Post
+~~~~~~~~~~
 
-  - `PyAEDT Documentation <https://aedtdocs.pyansys.com/>`_
-  - `PyAEDT PyPI <https://pypi.org/project/pyaedt/>`_
-  - `PyAEDT GitHub <https://github.com/pyansys/PyAEDT/>`_
+.. code::
 
+   pip install ansys-dpf-post
 
-**PyDPF-Core**
-``pip install ansys-dpf-core``
 
-  - `DPF-Core Documentation <https://dpfdocs.pyansys.com/>`__
-  - `DPF-Core PyPI <https://pypi.org/project/ansys-dpf-core/>`__
-  - `DPF-Core GitHub <https://github.com/pyansys/DPF-Core>`__
+- `DPF-Post Documentation <https://postdocs.pyansys.com/>`_
+- `DPF-Post PyPI <https://pypi.org/project/ansys-dpf-post/>`_
+- `DPF-Post GitHub <https://github.com/pyansys/pydpf-post>`_
 
 
-**PyDPF-Post**
-``pip install ansys-dpf-post``
+PyMAPDL
+~~~~~~~
 
-  - `DPF-Post Documentation <https://dpfdocs.pyansys.com/>`_
-  - `DPF-Post PyPI <https://pypi.org/project/ansys-dpf-core/>`_
-  - `DPF-Post GitHub <https://github.com/pyansys/DPF-Post>`_
+.. code::
 
+   pip install ansys-mapdl-core
 
-**PyMAPDL**
-``pip install ansys-mapdl-core``
 
-  - `PyMAPDL Documentation <https://mapdldocs.pyansys.com/>`_
-  - `PyMAPDL PyPI <https://pypi.org/project/ansys-mapdl-core/>`_
-  - `PyMAPDL GitHub <https://github.com/pyansys/pymapdl/>`_
+- `PyMAPDL Documentation <https://mapdldocs.pyansys.com/>`_
+- `PyMAPDL PyPI <https://pypi.org/project/ansys-mapdl-core/>`_
+- `PyMAPDL GitHub <https://github.com/pyansys/pymapdl/>`_
 
 
-**PyMAPDL Reader**
-``pip install ansys-mapdl-reader``
+PyMAPDL Reader
+~~~~~~~~~~~~~~
 
-  - `Legacy PyMAPDL Reader Documentation <https://readerdocs.pyansys.com/>`_
-  - `Legacy PyMAPDL Reader PyPI <https://pypi.org/project/ansys-mapdl-reader/>`_
-  - `Legacy PyMAPDL Reader GitHub <https://github.com/pyansys/pymapdl-reader>`_
+.. code::
 
+   pip install ansys-mapdl-reader
 
-**PyPIM**
-``pip install ansys-platform-instancemanagement``
 
-**Granta MI BoM Analytics**
-``pip install ansys-grantami-bomanalytics``
+- `Legacy PyMAPDL Reader Documentation <https://readerdocs.pyansys.com/>`_
+- `Legacy PyMAPDL Reader PyPI <https://pypi.org/project/ansys-mapdl-reader/>`_
+- `Legacy PyMAPDL Reader GitHub <https://github.com/pyansys/pymapdl-reader>`_
 
-  - `Granta MI BoM Analytics Documentation <https://grantami.docs.pyansys.com/>`_
-  - `Granta MI BoM Analytics PyPI <https://pypi.org/project/ansys-grantami-bomanalytics/>`_
-  - `Granta MI BoM Analytics GitHub <https://github.com/pyansys/grantami-bomanalytics/>`_
 
+PyPIM
+~~~~~
 
-**Shared Components**
+.. code::
+
+   pip install ansys-platform-instancemanagement
+
+
+- `PyPIML Documentation <https://pypim.docs.pyansys.com/>`_
+- `PyPIM PyPI <https://pypi.org/project/ansys-platform-instancemanagement/>`_
+- `PyPIM GitHub <https://github.com/pyansys/pypim/>`_
+
+
+Granta MI BoM Analytics
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code::
+
+   pip install ansys-grantami-bomanalytics
+
+
+- `Granta MI BoM Analytics Documentation <https://grantami.docs.pyansys.com/>`_
+- `Granta MI BoM Analytics PyPI <https://pypi.org/project/ansys-grantami-bomanalytics/>`_
+- `Granta MI BoM Analytics GitHub <https://github.com/pyansys/grantami-bomanalytics/>`_
+
+
+Shared components
+~~~~~~~~~~~~~~~~~
 The PyAnsys project publishes and consumes shared software components that enable
 interoperability between PyAnsys packages and minimize maintenance. For more
 information, see the `Shared Components documentation <https://shared.docs.pyansys.com/>`_.
-The OpenAPI Common library is a shared component. Here is the command for installing it
-and links for its comprehensive resources:
 
-``pip install ansys-openapi-common``
 
-  - `OpenAPI Common Documentation <https://openapi.docs.pyansys.com/index.html/>`_
-  - `OpenAPI Common PyPI <https://pypi.org/project/ansys-openapi-common/>`_
-  - `OpenAPI Common GitHub <https://github.com/pyansys/openapi-common/>`_
+The OpenAPI Common library is a shared component. Here is the command for downloading
+and installing the most recent package and links to its comprehensive resources:
+
+.. code::
+
+   pip install ansys-openapi-common
+
 
+- `OpenAPI Common Documentation <https://openapi.docs.pyansys.com/index.html/>`_
+- `OpenAPI Common PyPI <https://pypi.org/project/ansys-openapi-common/>`_
+- `OpenAPI Common GitHub <https://github.com/pyansys/openapi-common/>`_
 
 
-License and Acknowledgments
+License and acknowledgments
 ---------------------------
 All PyAnsys libraries are licensed under the MIT license.
 
@@ -107,4 +146,4 @@ adding Python interfaces to legally obtained software products
 without changing the core behaviors or licenses of the original
 software.  
 
-For more information about obtaining Ansys products, visit `Ansys <https://www.ansys.com/>`_.
+For more information about Ansys products, visit the `Ansys web site <https://www.ansys.com/>`_.