Merge branch 'main' into zhanqun/dyna-prev4

Author: wenhuiuy

.github/workflows/ci_cd.yml

@@ -25,7 +25,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks
-        uses: pyansys/actions/doc-style@v3
+        uses: pyansys/actions/doc-style@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -45,7 +45,7 @@ jobs:
 
       - name: Install packages for documentation build
         run: |
-          sudo apt-get install xvfb pandoc
+          sudo apt-get install xvfb pandoc texlive-latex-extra latexmk
           pip install --upgrade build
           pip install .[doc]
 
@@ -56,17 +56,28 @@ jobs:
           sleep 10
           cd -
 
-      - name: Build the documentation
+      - name: Build the documentation (HTML)
         run: |
           xvfb-run make -C doc html
 
+      - name: Build the documentation (PDF)
+        run: |
+          make -C doc pdf
+
       - name: Upload HTML documentation
         uses: actions/upload-artifact@v3
         with:
           name: documentation-html
           path: doc/_build/html
           retention-days: 7
 
+      - name: Upload PDF documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: documentation-pdf
+          path: doc/_build/latex/*.pdf
+          retention-days: 7
+
       - name: Upload the server logs
         if: always()
         uses: actions/upload-artifact@v3
@@ -79,7 +90,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys code style checks
-        uses: pyansys/actions/code-style@v3
+        uses: pyansys/actions/code-style@v4
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
@@ -95,7 +106,7 @@ jobs:
 
     steps:
       - name: Build wheelhouse and perform smoke test
-        uses: pyansys/actions/build-wheelhouse@v3
+        uses: pyansys/actions/build-wheelhouse@v4
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           library-namespace: ${{ env.PACKAGE_NAMESPACE }}
@@ -163,7 +174,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Build library source and wheel artifacts
-        uses: pyansys/actions/build-library@v3
+        uses: pyansys/actions/build-library@v4
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
@@ -174,8 +185,15 @@ jobs:
     needs: [package]
     runs-on: ubuntu-latest
     steps:
+      - name: Release to the private PyPI repository
+        uses: pyansys/actions/release-pypi-private@v4
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          twine-username: "__token__"
+          twine-token: ${{ secrets.PYANSYS_PYPI_PRIVATE_PAT }}
+
       - name: Release to GitHub
-        uses: pyansys/actions/release-github@v3
+        uses: pyansys/actions/release-github@v4
         with:
           library-name: ${{ env.PACKAGE_NAME }}
 
@@ -186,7 +204,7 @@ jobs:
     needs: [package]
     steps:
       - name: Deploy the latest documentation
-        uses: pyansys/actions/doc-deploy-dev@v3
+        uses: pyansys/actions/doc-deploy-dev@v4
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -198,8 +216,8 @@ jobs:
     needs: [release]
     steps:
       - name: Deploy the stable documentation
-        uses: pyansys/actions/doc-deploy-stable@v3
+        uses: pyansys/actions/doc-deploy-stable@v4
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
-          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}

.github/workflows/label.yml

@@ -76,7 +76,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Suggest to add labels
-      uses: peter-evans/create-or-update-comment@v2
+      uses: peter-evans/create-or-update-comment@v3
       # Execute only when no labels have been applied to the pull request
       if: toJSON(github.event.pull_request.labels.*.name) == '{}'
       with:

README.rst

@@ -1,5 +1,5 @@
-PyDyna
-#############
+PyDyna
+######
 
 PyDyna is a pythonic dyna package that aims to provide user a more convenient and complete way to
 build up ansys-dyna input deck, submit to solver and finally post processing their results. 
@@ -37,14 +37,82 @@ detailed description of the package.
 
 Installation
 ------------
-This package is not yet available on PyPI, so for now the only real
-option is for you to download the code from GitHub:
+
+PyDyna has three installation modes: user, developer, and offline.
+
+Install in user mode
+^^^^^^^^^^^^^^^^^^^^
+
+Before installing PyDyna in user mode, make sure you have the latest version of
+`pip`_ with:
+
+.. code:: bash
+
+   python -m pip install -U pip
+
+Then, install PyDyna with:
+
+.. code:: bash
+
+   python -m pip install ansys-dyna-core
+
+.. caution::
+
+    PyDyna is currently hosted in a private PyPI repository. You must provide the index
+    URL to the private PyPI repository:
+
+    * Index URL: ``https://pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/``
+
+    If access to this package registry is needed, email `[email protected] <mailto:[email protected]>`_
+    to request access. The PyAnsys team can provide you a read-only token to be inserted in ``${PRIVATE_PYPI_ACCESS_TOKEN}``.
+    Once you have it, run the following command:
+
+    .. code:: bash
+
+        pip install ansys-dyna-core --index-url=https://${PRIVATE_PYPI_ACCESS_TOKEN}@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/
+
+Install in developer mode
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Installing PyDyna in developer mode allows you to modify the source and enhance it.
+
+.. note::
+   
+    Before contributing to the project, ensure that you are thoroughly familiar
+    with the `PyAnsys Developer's Guide`_.
+
+Start by cloning the repository
 
 .. code::
 
    git clone https://github.com/pyansys/pyDyna
 
-and copy the required files
+and copy the required files.
+
+Install in offline mode
+^^^^^^^^^^^^^^^^^^^^^^^
+
+If you lack an internet connection on your installation machine (or you do not have access to the
+private Ansys PyPI packages repository), you should install PyDyna by downloading the wheelhouse
+archive from the `Releases Page <https://github.com/pyansys/pydyna/releases>`_ for your
+corresponding machine architecture.
+
+Each wheelhouse archive contains all the Python wheels necessary to install PyDyna from scratch on Windows
+and Linux, 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.7, unzip the wheelhouse archive and install it with:
+
+.. code:: bash
+
+    unzip ansys-dyna-core-v0.3.dev0-wheelhouse-Linux-3.7.zip wheelhouse
+    pip install ansys-dyna-core -f wheelhouse --no-index --upgrade --ignore-installed
+
+If you are on Windows with Python 3.9, unzip the corresponding wheelhouse to a wheelhouse directory
+and install using the preceding command.
+
+Consider installing using a `virtual environment <https://docs.python.org/3/library/venv.html>`_.
+
 
 Documentation
 -------------
@@ -115,3 +183,7 @@ License
 -------
 Distributed under the MIT license.  See LICENSE in the root directory
 of the repository for details.
+
+.. LINKS AND REFERENCES
+.. _pip: https://pypi.org/project/pip/
+.. _PyAnsys Developer's Guide: https://dev.docs.pyansys.com/

doc/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    = -j auto -W --color
+SPHINXOPTS    = -j auto
 SPHINXBUILD   = sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = _build
@@ -27,4 +27,4 @@ clean:
 pdf:
 	@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	cd $(BUILDDIR)/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
-	(test -f $(BUILDDIR)/latex/*.pdf && echo pdf exists) || exit 1
+	(test -f $(BUILDDIR)/latex/*.pdf && echo pdf exists) || exit 1

doc/source/_templates/sidebar-nav-bs.html

@@ -4,21 +4,14 @@
 import os
 
 import pyvista
-from ansys_sphinx_theme import pyansys_logo_black, ansys_favicon
+from ansys_sphinx_theme import get_version_match, pyansys_logo_black, ansys_favicon
 from sphinx.builders.latex import LaTeXBuilder
 from sphinx_gallery.sorting import FileNameSortKey
 
 from ansys.dyna.core import __version__
 
 LaTeXBuilder.supported_image_types = ["image/png", "image/pdf", "image/svg+xml"]
 
-def get_version_match(semver):
-    """Evaluate the version match for the multi-documentation."""
-    if semver.endswith("dev0"):
-        return "dev"
-    major, minor, _ = semver.split(".")
-    return ".".join([major, minor])
-
 
 # Project information
 project = 'ansys-dyna-core'
@@ -102,9 +95,6 @@ def get_version_match(semver):
 # Favicon
 html_favicon = ansys_favicon
 
-# We have our own custom templates
-templates_path = ['_templates']
-
 # The suffix(es) of source filenames.
 source_suffix = '.rst'
 
@@ -142,9 +132,10 @@ def get_version_match(semver):
 }
 html_theme_options = {
     "switcher": {
-        "json_url": f"https://{cname}/release/versions.json",
+        "json_url": f"https://{cname}/versions.json",
         "version_match": get_version_match(__version__),
     },
+    "check_switcher": False,
     "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
     "github_url": "https://github.com/pyansys/pydyna",
     "show_prev_next": False,
@@ -160,4 +151,4 @@ def get_version_match(semver):
 html_static_path = ['_static']
 
 # necessary for pyvista when building the sphinx gallery
-pyvista.BUILDING_GALLERY = True
+pyvista.BUILDING_GALLERY = True

doc/source/conf.py

@@ -1,5 +1,5 @@
-PyDyna documentation  0.0.1
-===========================
+PyDyna documentation  |version|
+===============================
 
 .. include:: ../../README.rst
 

doc/source/index.rst

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "ansys-dyna-core"
-version = "0.2.dev0"
+version = "0.3.dev0"
 description = "Python interface to LS-DYNA Service"
 readme = "README.rst"
 requires-python = ">=3.7,<4"
@@ -34,42 +34,42 @@ dependencies = [
 
 [project.optional-dependencies]
 tests = [
-    "pyvista==0.38.2",
-    "matplotlib==3.7.0",
+    "pyvista==0.38.5",
+    "matplotlib==3.7.1",
     "numpy==1.24.2",
-    "pytest==7.2.1",
+    "pytest==7.2.2",
     "pytest-cov==4.0.0",
     "codecov==2.1.12",
     "joblib==1.2.0",
-    "pandas==1.5.3",
-    "openpyxl==3.1.1",
-    "scikit-learn==1.2.1",
-    "pytest-xdist==3.2.0",
-    "ipython==8.10.0",
+    "pandas==2.0.0",
+    "openpyxl==3.1.2",
+    "scikit-learn==1.2.2",
+    "pytest-xdist==3.2.1",
+    "ipython==8.12.0",
 ]
 doc = [
     "recommonmark==0.7.1",
-    "matplotlib==3.7.0",
-    "imageio==2.25.1",
+    "matplotlib==3.7.1",
+    "imageio==2.27.0",
     "imageio-ffmpeg==0.4.8",
-    "pyvista==0.38.2",
+    "pyvista==0.38.5",
     "numpydoc==1.5.0",
     "Sphinx==5.3.0",
     "sphinx-autobuild==2021.3.14",
     "sphinxcontrib-websupport==1.2.4",
     "pytest-sphinx==0.5.0",
     "sphinx-notfound-page==0.8.3",
     "sphinx-copybutton==0.5.1",
-    "sphinx-gallery==0.11.1",
+    "sphinx-gallery==0.12.2",
     "sphinx-autodoc-typehints==1.22",
-    "ansys-sphinx-theme==0.8.2",
-    "pypandoc==1.10",
-    "nbsphinx==0.8.12",
-    "ipywidgets==8.0.4",
+    "ansys-sphinx-theme==0.9.6",
+    "pypandoc==1.11",
+    "nbsphinx==0.9.1",
+    "ipywidgets==8.0.6",
     "joblib==1.2.0",
-    "scikit-learn==1.2.1",
-    "ipython==8.10.0",
-    "jupyterlab==3.6.1",
+    "scikit-learn==1.2.2",
+    "ipython==8.12.0",
+    "jupyterlab==3.6.3",
 ]
 
 [project.urls]