Commit files edited through late Thursday

Author: PipKat

doc/source/_autoapi_templates/index.rst

@@ -1,7 +1,8 @@
 API reference
 =============
 
-This page contains the ``ansys-dyna-core`` API reference.
+This section provides descriptions of PyDYNA subpackages, submodules, classes,
+methods, and attributes. Use the search feature or click links to view API documentation.
 
 .. toctree::
    :titlesonly:

doc/source/conf.py

@@ -93,7 +93,7 @@
 inheritance_node_attrs = dict(shape="ellipse", fontsize=14, height=0.75, color="dodgerblue1", style="filled")
 
 # -- Options for HTML output -------------------------------------------------
-html_short_title = html_title = "PyDyna"
+html_short_title = html_title = "PyDYNA"
 html_show_sourcelink = True
 html_theme = "ansys_sphinx_theme"
 html_logo = pyansys_logo_black

doc/source/contributing.rst

@@ -1,18 +1,16 @@
-Contributing
-============
+Contribute
+==========
 
 Overall guidance on contributing to a PyAnsys repository appears in the
-`Contributing <https://dev.docs.pyansys.com/overview/contributing.html>`_ topic
-in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
-with it and all `Guidelines and Best Practices <https://dev.docs.pyansys.com/guidelines/index.html>`_
-before attempting to contribute to PyDyna.
+`PyAnsys Developer's Guide <https://dev.docs.pyansys.com/>`_. Ensure that you
+are thoroughly familiar with this guide before attempting to contribute to PyDYNA.
 
-The following contribution information is specific to PyDyna.
+The following contribution information is specific to PyDYNA.
 
 Clone the repository
 --------------------
 
-To clone and install the latest PyDyna release in development mode, run:
+To clone and install the latest PyDYNA release in development mode, run this code:
 
 .. code::
 
@@ -25,44 +23,44 @@ To clone and install the latest PyDyna release in development mode, run:
 Post issues
 -----------
 
-Use the `PyDyna Issues <https://github.com/pyansys/pydyna/issues>`_
-page to submit questions, report bugs, and request new features. When possible, you
-should use these issue templates:
+Use the `PyDYNA Issues <https://github.com/pyansys/pydyna/issues>`_
+page to submit questions, report bugs, and request new features. When possible,
+use these issue templates:
 
 * Bug report template
 * Feature request template
 
-If your issue does not fit into these categories, create your own issue.
+If your issue does not fit into one of these template categories, create your own issue.
 
-To reach the PyAnsys team, email `[email protected] <[email protected]>`_.
+To reach the project support team, email `[email protected] <[email protected]>`_.
 
 View documentation
 ------------------
 
-Documentation for the latest stable release of PyDyna is hosted at
-`PyDyna Documentation <https://dyna.docs.pyansys.com>`_.
+Documentation for the latest stable release of PyDYNA is hosted at
+`PyDYNA documentation <https://dyna.docs.pyansys.com>`_.
 
-Documentation for the latest development version, which tracks the
-``main`` branch, is hosted at `Development PyDyna Documentation <https://dyna.docs.pyansys.com/dev/>`_.
-This version is automatically kept up to date via GitHub actions.
+In the upper right corner of the documentation’s title bar, there is an option
+for switching from viewing the documentation for the latest stable release to
+viewing the documentation for the development version or previously released versions.
 
-Code style
-----------
+Adhere to code style
+--------------------
 
-PyDyna follows the PEP8 standard as outlined in the `PyAnsys Development Guide
+PyDYNA follows the PEP8 standard as outlined in the `PyAnsys Developer's Guide
 <https://dev.docs.pyansys.com>`_ and implements style checking using
 `pre-commit <https://pre-commit.com/>`_.
 
-To ensure your code meets minimum code styling standards, run::
+To ensure your code meets minimum code styling standards, run these commands::
 
   pip install pre-commit
   pre-commit run --all-files
 
-You can also install this as a pre-commit hook by running::
+You can also install this as a pre-commit hook by running this command::
 
   pre-commit install
 
-This way, it is not possible for you to push code that fails the style checks. For example::
+This way, it is not possible for you to push code that fails the style checks::
 
   $ pre-commit install
   $ git commit -am "added my cool feature"
@@ -73,4 +71,4 @@ This way, it is not possible for you to push code that fails the style checks. F
   isort....................................................................Passed
   check for merge conflicts................................................Passed
   debug statements (python)................................................Passed
-  Validate GitHub Workflows................................................Passed
+  Validate GitHub Workflows................................................Passed

doc/source/getting-started/index.rst

@@ -1,63 +1,71 @@
 Getting started
 ===============
+To run PyDYNA, you must have an installation of Ansys LS-DYNA.
+PyDYNA supports LS-DYNA 2023 R2 and later.
+
+For more information on getting a licensed copy of LS-DYNA, visit
+the `LS-DYNA <https://www.ansys.com/products/structures/ansys-ls-dyna>`_
+page on the Ansys website.
 
-************
 Installation
-************
+------------
 
-Python module
-~~~~~~~~~~~~~
+The ``ansys.dyna.core`` package supports Python 3.8 through
+Python 3.11 on Windows, Linux, and MacOS.
 
-The ``ansys.dyna.core`` package currently supports Python 3.8 through
-Python 3.10 on Windows, Mac OS, and Linux.
+You should consider installing PyDYNA in a virtual environment.
+For more information, see Python's
+`venv -- Creation of virtual environments <https://docs.python.org/3/library/venv.html>`_.
 
-Install the latest release from 
-`PyPI <pydyna_pypi_>`_ with:
+Install the latest release from `PyPI <pydyna_pypi_>`_ with this
+command:
 
 .. code:: console
 
    pip install ansys-dyna-core
 
-Alternatively, install the latest from 
-`PyDyna GitHub <pydyna_issues_>`_ via:
+Alternatively, install the latest release from the
+`GitHub repository <pydyna_repo_>`_ with this command:
 
 .. code:: console
    
    pip install git+https://github.com/pyansys/pydyna.git
    
-
-For a local *development* version, install with:
+If you plan on doing local *development* of PyDYNA with Git,
+install the latest ``ansys-dyna.core`` package with these
+commands:
 
 .. code:: console
 
    git clone https://github.com/pyansys/pydyna.git
    cd pydyna
    pip install -e .
 
-This allows you to install the ``ansys-dyna-core`` module
-and modify it locally and have the changes reflected in your setup
-after restarting the Python kernel.
+The preceding commands install the package and allow you to modify it locally,
+with your changes reflected in your Python setup after restarting the
+Python kernel.
 
 Offline installation
 ~~~~~~~~~~~~~~~~~~~~
-If you lack an internet connection on your install machine, the recommended way
-of installing PyDyna is downloading the wheelhouse archive from the 
-`Releases Page <pydyna_releases_>`_ for your corresponding
-machine architecture.
+If you lack an internet connection on your installation machine, the
+recommended way of installing PyDYNA is to download the wheelhouse archive
+for your corresponding machine architecture from the GitHub repository's
+`Releases <pydyna_releases_>`_ page.
 
 Each wheelhouse archive contains all the Python wheels necessary to install
-PyDyna from scratch on Windows and Linux for Python 3.8 through 3.11. You can install
-this on an isolated system with a fresh Python or on a virtual environment.
+PyDYNA from scratch on Windows and Linux for Python 3.8 through 3.11. You can install
+PyDYNA on an isolated system with a fresh Python installation or on a virtual environment.
 
-For example, on Linux with Python 3.8, unzip it and install it with the following:
+For example, on Linux with Python 3.8, unzip the wheelhouse archive and install PyDYNA
+with these commands:
 
 .. code:: console
 
    unzip ansys-dyna-core-v0.3.1-wheelhouse-ubuntu-latest-3.8.zip wheelhouse
    pip install ansys-dyna-core -f wheelhouse --no-index --upgrade --ignore-installed
 
-If you're on Windows with Python 3.8, unzip to a ``wheelhouse`` directory and
-install using the preceding command.
+If you're on Windows with Python 3.8, unzip thw wheelhouse archive to a ``wheelhouse``
+directory and install PyDYNA using the preceding command.
 
 Consider installing using a `virtual environment <using_venv_>`_.
 
@@ -66,6 +74,6 @@ Consider installing using a `virtual environment <using_venv_>`_.
 
 .. LINKS
 .. _pydyna_pypi: https://pypi.org/projects/ansys-dyna-core/
+.. _pydyna_repo: https://github.com/ansys/pydyna/
 .. _pydyna_releases: https://github.com/ansys/pydyna/releases
 .. _pydyna_issues: https://github.com/ansys/pydyna/issues
-.. _using_venv: https://docs.python.org/3/library/venv.html

doc/source/user-guide/index.rst

@@ -1,28 +1,27 @@
 User guide
 ----------
 
-There are 3 related packages here, all under the ``ansys/dyna`` directory.
+In the PyDYNA installation, the ``docker`` directory has two child
+directories:
 
-PyDyna-pre provides interface to create DYNA input deck.
+- ``pre``: Provides the interface for creating DYNA input decks.
+- ``solver``: Contains the code for interfacing directly with
+  the Ansys LS-DYNA solver. Because LS-DYNA is primarily a batch
+  solver with very limited interactive capabilities, the code here in
+  this directory is similarly limited. The target use case is that
+  LS-DYNA is running in a container environment such as Docker or
+  Kubernetes. The code in the ``solver`` directory allows you to push
+  input files to the container, start LS-DYNA and monitor its progress,
+  and then retrieve results (RST) files.
 
-PyDyna-solver contains code for interfacing with the LS-DYNA solver directly.
-As LS-DYNA is primarily a batch solver with very limited interactive
-capabilities, the code here is similarly limited. The target
-use case is that LS-DYNA is running in a container environment
-such as Docker or Kubernetes. The code here then allows for pushing
-input files to the container, starting LS-DYNA and monitoring its
-progress, and retrieving results files.
+Once you have results, you can use the Data Processing Framework (DPF),
+which is designed to provide numerical simulation users and engineers
+with a toolbox for accessing and transforming simulation data. DPF
+can access data from Ansys solver result files and from several
+files with neutral formats, including CSV, HDF5, and VTK. Using DPF's
+various operators, you can manipulate and transform this data.
 
-The Data Processing Framework (DPF) is designed to provide numerical
-simulation users/engineers with a toolbox for accessing and
-transforming simulation data. DPF can access data from solver result
-files as well as several neutral formats (``.csv``, ``.hdf5``, ``.vtk``,
-etc.). Various operators are available allowing the manipulation and
-the transformation of this data.
-
-The Python `ansys-dpf-post` package provides a simplified Python
-interface to DPF, thus enabling rapid postprocessing without ever
-leaving a Python environment.
-
-Visit the `DPF-Post Documentation <https://post.docs.pyansys.com>`_ for a
-detailed description of the package
+The `ansys-dpf-post package <https://github.com/ansys/pydpf-post>`_ provides
+a simplified Python interface to DPF, thus enabling rapid postprocessing
+without ever leaving a Python environment. For more information on DPF-Post,
+see the `DPF-Post documentation <https://post.docs.pyansys.com>`_.