diff --git a/README.rst b/README.rst index 0f563f84..f3e7bdaf 100644 --- 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 `__ : Pythonic interface to AEDT (Ansys Electronic Desktop) - `PyDPF-Core `__ : 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 `_. -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 -`_ 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 +`_, 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 `_ +- `PyAEDT PyPI `_ +- `PyAEDT GitHub `_ + + +PyDPF-Core +~~~~~~~~~~ + +.. code:: + + pip install ansys-dpf-core + + +- `DPF-Core Documentation `__ +- `DPF-Core PyPI `__ +- `DPF-Core GitHub `__ + -**PyAEDT** -``pip install pyaedt`` +PyDPF-Post +~~~~~~~~~~ - - `PyAEDT Documentation `_ - - `PyAEDT PyPI `_ - - `PyAEDT GitHub `_ +.. code:: + pip install ansys-dpf-post -**PyDPF-Core** -``pip install ansys-dpf-core`` - - `DPF-Core Documentation `__ - - `DPF-Core PyPI `__ - - `DPF-Core GitHub `__ +- `DPF-Post Documentation `_ +- `DPF-Post PyPI `_ +- `DPF-Post GitHub `_ -**PyDPF-Post** -``pip install ansys-dpf-post`` +PyMAPDL +~~~~~~~ - - `DPF-Post Documentation `_ - - `DPF-Post PyPI `_ - - `DPF-Post GitHub `_ +.. code:: + pip install ansys-mapdl-core -**PyMAPDL** -``pip install ansys-mapdl-core`` - - `PyMAPDL Documentation `_ - - `PyMAPDL PyPI `_ - - `PyMAPDL GitHub `_ +- `PyMAPDL Documentation `_ +- `PyMAPDL PyPI `_ +- `PyMAPDL GitHub `_ -**PyMAPDL Reader** -``pip install ansys-mapdl-reader`` +PyMAPDL Reader +~~~~~~~~~~~~~~ - - `Legacy PyMAPDL Reader Documentation `_ - - `Legacy PyMAPDL Reader PyPI `_ - - `Legacy PyMAPDL Reader GitHub `_ +.. 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 `_ +- `Legacy PyMAPDL Reader PyPI `_ +- `Legacy PyMAPDL Reader GitHub `_ - - `Granta MI BoM Analytics Documentation `_ - - `Granta MI BoM Analytics PyPI `_ - - `Granta MI BoM Analytics GitHub `_ +PyPIM +~~~~~ -**Shared Components** +.. code:: + + pip install ansys-platform-instancemanagement + + +- `PyPIML Documentation `_ +- `PyPIM PyPI `_ +- `PyPIM GitHub `_ + + +Granta MI BoM Analytics +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code:: + + pip install ansys-grantami-bomanalytics + + +- `Granta MI BoM Analytics Documentation `_ +- `Granta MI BoM Analytics PyPI `_ +- `Granta MI BoM Analytics GitHub `_ + + +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 `_. -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 `_ - - `OpenAPI Common PyPI `_ - - `OpenAPI Common GitHub `_ +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 `_ +- `OpenAPI Common PyPI `_ +- `OpenAPI Common GitHub `_ -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 `_. +For more information about Ansys products, visit the `Ansys web site `_.