DOC: update development documentation bb18386

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 45e39a5b5da4c2d4745bdeba1d6aa964
+tags: 645f666f9bcd5a90fca523b33c5a78b7

CNAME

@@ -0,0 +1 @@
+docs.pyansys.com

dev/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: f100295ff53df0ae22635fbeb7315834
+tags: 645f666f9bcd5a90fca523b33c5a78b7

dev/_sources/api.rst.txt

@@ -0,0 +1,111 @@
+API reference
+=============
+
+The ``pyansys`` metapackage on its own does not have a specific API. The only information specific-only
+to this package that can be provided is its version. This can be looked up as follows:
+
+.. code-block:: pycon
+
+    >>> from pyansys import __version__
+    >>> __version__
+
+    '2023.1.0'
+
+However, each of the PyAnsys packages that shape the ``pyansys`` metapackage have their own specific API
+reference section. In order to navigate through them, please refer to their documentation.
+
+******************************
+PyAnsys packages API reference
+******************************
+
+.. grid:: 3
+
+    .. grid-item-card:: PyAEDT
+      :img-top: _static/thumbnails/pyaedt.png
+      :link: https://aedt.docs.pyansys.com/dev/API/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyDPF-Core
+      :img-top: _static/thumbnails/pydpf-core.png
+      :link: https://dpf.docs.pyansys.com/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyDPF-Post
+      :img-top: _static/thumbnails/pydpf-core.png
+      :link: https://post.docs.pyansys.com/dev/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyDPF Composites
+      :img-top: _static/thumbnails/pydpf-composites.png
+      :link: https://composites.dpf.docs.pyansys.com/dev/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyFluent
+      :img-top: _static/thumbnails/pyfluent.png
+      :link: https://fluent.docs.pyansys.com/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyFluent-Parametric
+      :img-top: _static/thumbnails/pyfluent-parametric.png
+      :link: https://parametric.fluent.docs.pyansys.com/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyFluent-Visualization
+      :img-top: _static/thumbnails/pyfluent-visualization.png
+      :link: https://visualization.fluent.docs.pyansys.com/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyMAPDL
+      :img-top: _static/thumbnails/pymapdl.png
+      :link: https://mapdl.docs.pyansys.com/dev/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyMAPDL Reader
+      :img-top: _static/thumbnails/pymapdl.png
+      :link: https://reader.docs.pyansys.com/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyPIM
+      :img-top: _static/thumbnails/intro.png
+      :link: https://pypim.docs.pyansys.com/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyPrimeMesh
+      :img-top: _static/thumbnails/intro.png
+      :link: https://prime.docs.pyansys.com/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PySeascape
+      :img-top: _static/thumbnails/intro.png
+      :link: https://seascape.docs.pyansys.com/dev/#usage
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyTwin
+      :img-top: _static/thumbnails/pytwin.png
+      :link: https://twin.docs.pyansys.com/dev/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: Granta MI BoM Analytics
+      :img-top: _static/thumbnails/intro.png
+      :link: https://grantami.docs.pyansys.com/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: Shared Components - OpenAPI Common
+      :img-top: _static/thumbnails/intro.png
+      :link: https://openapi.docs.pyansys.com/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title

dev/_sources/examples.rst.txt

@@ -0,0 +1,100 @@
+Examples
+========
+
+Examples for the different ``pyansys`` packages can be found in their specific documentation.
+
+*************************
+PyAnsys packages examples
+*************************
+
+.. grid:: 3
+
+    .. grid-item-card:: PyAEDT
+      :img-top: _static/thumbnails/pyaedt.png
+      :link: https://aedt.docs.pyansys.com/dev/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyDPF-Core
+      :img-top: _static/thumbnails/pydpf-core.png
+      :link: https://dpf.docs.pyansys.com/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyDPF-Post
+      :img-top: _static/thumbnails/pydpf-core.png
+      :link: https://post.docs.pyansys.com/dev/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyDPF Composites
+      :img-top: _static/thumbnails/pydpf-composites.png
+      :link: https://composites.dpf.docs.pyansys.com/dev/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyFluent
+      :img-top: _static/thumbnails/pyfluent.png
+      :link: https://fluent.docs.pyansys.com/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyFluent-Parametric
+      :img-top: _static/thumbnails/pyfluent-parametric.png
+      :link: https://parametric.fluent.docs.pyansys.com/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyFluent-Visualization
+      :img-top: _static/thumbnails/pyfluent-visualization.png
+      :link: https://visualization.fluent.docs.pyansys.com/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyMAPDL
+      :img-top: _static/thumbnails/pymapdl.png
+      :link: https://mapdl.docs.pyansys.com/dev/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyMAPDL Reader
+      :img-top: _static/thumbnails/pymapdl.png
+      :link: https://reader.docs.pyansys.com/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyPIM
+      :img-top: _static/thumbnails/intro.png
+      :link: https://pypim.docs.pyansys.com/integration.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyPrimeMesh
+      :img-top: _static/thumbnails/intro.png
+      :link: https://prime.docs.pyansys.com/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PySeascape
+      :img-top: _static/thumbnails/intro.png
+      :link: https://seascape.docs.pyansys.com/dev/#examples
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: PyTwin
+      :img-top: _static/thumbnails/pytwin.png
+      :link: https://twin.docs.pyansys.com/dev/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: Granta MI BoM Analytics
+      :img-top: _static/thumbnails/intro.png
+      :link: https://grantami.docs.pyansys.com/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: Shared Components - OpenAPI Common
+      :img-top: _static/thumbnails/intro.png
+      :link: https://openapi.docs.pyansys.com/index.html#brief-example
+      :text-align: center
+      :class-title: pyansys-card-title

dev/_sources/getting_started.rst.txt

@@ -0,0 +1,137 @@
+Getting started
+===============
+
+PyAnsys libraries fall into two categories:
+
+- Wrappers over products like `MAPDL <https://www.ansys.com/training-center/course-catalog/structures/ansys-mechanical-advanced-use-of-mapdl-in-mechanical>`_, `Fluent <https://www.ansys.com/products/fluids/ansys-fluent>`_, or `AEDT <https://www.ansys.com/products/electronics/ansys-maxwell>`_
+- Supporting libraries like `DPF <dpf_core_gh>`_
+
+Most PyAnsys packages require a local installation of Ansys. The version
+of Ansys installed dictates the interface and features available to
+you. However, PyAnsys libraries use `grpc`_ to communicate to the
+products, you can have the product installed remotely and connect to that
+remote instance. This still requires that you need a copy of Ansys installed on
+the host machine.
+
+For more information on getting a licensed copy of Ansys, visit `Ansys
+<ansys_>`_. If you are a student, consider installing a student version by
+visiting `Ansys for Students <https://www.ansys.com/academic/students>`_.
+
+
+************
+Installation
+************
+
+There are several ways of installing PyAnsys depending on your use case, but
+the easiest is simply to run:
+
+.. code:: bash
+
+   pip install pyansys
+
+This installs all the PyAnsys libraries for the latest released
+version of Ansys, for example, v2023R1.
+
+You can always install libraries individually by visiting the install page for
+each library. For example, for PyAEDT:
+
+.. code:: bash
+
+   pip install pyaedt
+
+
+User mode installation
+^^^^^^^^^^^^^^^^^^^^^^
+
+Before installing ``pyansys`` in user mode, ensure that you have the latest
+version of `pip <https://pypi.org/project/pip/>`_ with:
+
+.. code:: bash
+   
+    python -m pip install -U pip
+
+Then, install ``pyansys`` with:
+
+.. code:: bash
+
+   python -m pip install pyansys
+
+If you are interested in **installing an extra target** such as ``fluent-all``:
+
+.. code:: bash
+
+   python -m pip install pyansys[fluent-all]
+
+If you are interested in **installing a specific version** such as ``2023.1.0``:
+
+.. code:: bash
+
+   python -m pip install pyansys==2023.1.0
+
+
+Offline mode installation
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you lack an internet connection on your installation machine, the
+recommended way of installing the ``pyansys`` metapackage is downloading the
+wheelhouse archive from the `Releases Page
+<https://github.com/pyansys/pyansys/releases>`_ for your corresponding machine
+architecture.
+
+Each wheelhouse archive contains all the Python wheels necessary to install
+``pyansys`` metapackage from scratch on Windows, Linux, and MacOS from Python
+3.7 to 3.10. You can install this on an isolated system with a fresh Python
+installation or on a virtual environment.
+
+For example, on Linux with Python 3.9, unzip the wheelhouse archive and install
+it with the following:
+
+.. code:: bash
+
+    unzip pyansys-v2023.1.dev0-wheelhouse-Linux-3.9-core.zip wheelhouse
+    pip install pyansys -f wheelhouse --no-index --upgrade --ignore-installed
+
+If you're on Windows with Python 3.9, unzip to a wheelhouse directory and install using the same command as above.
+
+Consider installing using a `virtual environment <https://docs.python.org/3/library/venv.html>`_.
+
+
+Versioning system
+-----------------
+
+The ``pyansys`` metapackage follows a semantic-like versioning system, though
+it has been adapted to the Ansys product release mechanism. In that sense, the
+following kind of versioning system is followed:
+
+.. code:: bash
+
+   XXXX.Y.ZZ
+
+Where:
+
+- ``XXXX`` is the Ansys product release year (for example, 2022)
+- ``Y`` is the Ansys product release within the same year (for example, 1,
+  which relates to R1)
+- ``ZZ`` is the patched versions to the ``pyansys`` metapackage, if any.
+
+Consequently, the first ``pyansys`` metapackage compatible with the 2024 R2
+release would be:
+
+.. code:: bash
+
+   2024.2.0
+
+And any subsequent patched version of that package would be:
+
+.. code:: bash
+
+   2024.2.1
+   2024.2.2
+   2024.2.3
+   ...
+
+You can request for a specific version install when pip installing your package:
+
+.. code:: bash
+
+   python -m pip install pyansys==2024.2.0