DOC: Update README.rst (#76)

Co-authored-by: Lucas Boucinha <[email protected]> Co-authored-by: Revathy Venugopal <[email protected]> Co-authored-by: chrpetre <[email protected]> Co-authored-by: Kathy Pippert <[email protected]>
ansys · Feb 15, 2023 · 70a48d9 · 70a48d9
1 parent 51af32b
commit 70a48d9
Showing 1 changed file with 28 additions and 18 deletions.
diff --git a/README.rst b/README.rst
@@ -9,7 +9,7 @@ PyTwin
 .. |python| image:: https://img.shields.io/pypi/pyversions/pytwin?logo=pypi
    :target: https://pypi.org/project/pytwin/
    :alt: Python
-   
+
 .. |pypi| image:: https://img.shields.io/pypi/v/pytwin.svg?logo=python&logoColor=white
    :target: https://pypi.org/project/pytwin/
    :alt: PyPI
@@ -36,8 +36,19 @@ PyTwin
 
 Overview
 --------
-PyTwin is a Python package that eases `Ansys Digital Twins`_ consumption workflows.
+PyTwin is a Python package for consuming a digital twin model that has been exported from
+Ansys Twin Builder as a TWIN file. Each TWIN file is a self-contained app (twin runtime)
+that consists of two parts:
+
+- The twin model, which is the simulation model created and compiled in Twin Builder
+- The runtime SDK, which is the shared library for consuming the twin model within
+  the deployment workflow.
+
+Because PyTwin wraps a twin runtime in a Python interface, you do not need a Twin Builder
+installation to deploy it.
 
+For more information on digital twins and Ansys Twin Builder, see
+`Digital Twins`_ and `Ansys Twin Builder`_ on the Ansys website.
 
 Documentation
 -------------
@@ -52,18 +63,18 @@ and its sections:
 
 Installation
 ------------
-The ``pytwin`` package supports Python 3.7 through Python
-3.11 on Windows and Linux.
+The ``pytwin`` package supports Python 3.7 through Python 3.11 on Windows and Linux.
 
-Install the latest release from `PyPI
-<https://pypi.org/project/pytwin/>`_ with:
+Install the latest release from `PyPI <https://pypi.org/project/pytwin/>`_ with this
+command:
 
 .. code:: console
 
     pip install pytwin
 
+
 If you plan on doing local *development* of PyTwin with Git, install
-the latest release with:
+the latest release with this code:
 
 .. code:: console
 
@@ -72,26 +83,25 @@ the latest release with:
     pip install pip -U
     pip install -e .
 
+
 Dependencies
 ------------
 The ``pytwin`` package requires access to an Ansys License Server
-with the ``twin_builder_deployer`` feature available (see the
-`Getting started`_ section).
+with the ``twin_builder_deployer`` feature available. For more information,
+see `Getting started`_.
 
 
 License and acknowledgments
 ---------------------------
 PyTwin is licensed under the MIT license.
 
-For more information on `Ansys Digital Twins`_, see the `Twin Builder`_
-page on the Ansys website.
 
 .. LINKS AND REFERENCES
-.. _Ansys Digital Twins: https://www.ansys.com/products/digital-twin/
-.. _Twin Builder: https://www.ansys.com/products/digital-twin/ansys-twin-builder
+.. _Digital Twins: https://www.ansys.com/products/digital-twin/
+.. _Ansys Twin Builder: https://www.ansys.com/products/digital-twin/ansys-twin-builder
 .. _Documentation: https://twin.docs.pyansys.com/
-.. _Getting started: https://twin.docs.pyansys.com/release/0.1/getting_started/index.html
-.. _User guide: https://twin.docs.pyansys.com/release/0.1/user_guide/index.html
-.. _API reference: https://twin.docs.pyansys.com/release/0.1/api/index.html
-.. _Examples: https://twin.docs.pyansys.com/release/0.1/examples/index.html
-.. _Contributing: https://twin.docs.pyansys.com/release/0.1/contributing.html
+.. _Getting started: https://twin.docs.pyansys.com/release/0.2/getting_started/index.html
+.. _User guide: https://twin.docs.pyansys.com/release/0.2/user_guide/index.html
+.. _API reference: https://twin.docs.pyansys.com/release/0.2/api/index.html
+.. _Examples: https://twin.docs.pyansys.com/release/0.2/examples/index.html
+.. _Contributing: https://twin.docs.pyansys.com/release/0.2/contributing.html