Merge branch 'main' of https://github.com/ansys/pydpf-composites into…

… maint/release_0.6.2
ansys · Dec 4, 2024 · 4200332 · 4200332
2 parents 3ae71d1 + 92aadc5
commit 4200332
Show file tree

Hide file tree

Showing 50 changed files with 2,582 additions and 2,090 deletions.
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
@@ -12,7 +12,7 @@ on:
     inputs:
 
 env:
-  MAIN_PYTHON_VERSION: '3.12'
+  MAIN_PYTHON_VERSION: '3.13'
   CONTAINER_TAG: 'latest'
   PACKAGE_NAME: 'ansys-dpf-composites'
   DOCUMENTATION_CNAME: 'composites.dpf.docs.pyansys.com'
@@ -45,7 +45,7 @@ jobs:
     name: "Documentation style"
     runs-on: ubuntu-latest
     steps:
-      - uses: ansys/actions/doc-style@v7
+      - uses: ansys/actions/doc-style@v8
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -58,7 +58,7 @@ jobs:
         # docker images on the windows agents. See the issue
         # https://github.com/actions/runner-images/issues/1143
         os: [ubuntu-latest]
-        python-version: ['3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
       fail-fast: false
     steps:
       - name: "Login in Github Container registry"
@@ -134,7 +134,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: '3.10'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip tox tox-gh-actions
@@ -212,7 +212,7 @@ jobs:
     needs: [doc-style, doc-build, code-style, tests, tests_minimal_version]
     steps:
       - name: "Build library source and wheel artifacts"
-        uses: ansys/actions/build-library@v7
+        uses: ansys/actions/build-library@v8
         with:
           library-name: ${{ env.PACKAGE_NAME }}
 
@@ -223,10 +223,10 @@ jobs:
     strategy:
       matrix:
           os: [ubuntu-latest, windows-latest]
-          python-version: ['3.9', '3.10', '3.11', '3.12']
+          python-version: ['3.10', '3.11', '3.12', '3.13']
     steps:
       - name: "Build a wheelhouse of the Python library"
-        uses: ansys/actions/build-wheelhouse@v7
+        uses: ansys/actions/build-wheelhouse@v8
         with:
           library-name: "ansys-dpf-composites"
           operating-system: ${{ matrix.os }}
@@ -238,11 +238,13 @@ jobs:
     runs-on: ubuntu-latest
     needs: [build-library, build-wheelhouse]
     steps:
-      - uses: ansys/actions/doc-deploy-dev@v7
+      - uses: ansys/actions/doc-deploy-dev@v8
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
-          token: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
           force-orphan: false
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
 
   release:
     name: "Release project"
@@ -252,14 +254,14 @@ jobs:
     steps:
 
       - name: "Release to the public PyPI repository"
-        uses: ansys/actions/release-pypi-public@v7
+        uses: ansys/actions/release-pypi-public@v8
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           twine-username: "__token__"
           twine-token: ${{ secrets.PYPI_TOKEN }}
 
       - name: "Release to GitHub"
-        uses: ansys/actions/release-github@v7
+        uses: ansys/actions/release-github@v8
         with:
           library-name: ${{ env.PACKAGE_NAME }}
 
@@ -269,8 +271,10 @@ jobs:
     needs: [release]
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags/v')
     steps:
-      - uses: ansys/actions/doc-deploy-stable@v7
+      - uses: ansys/actions/doc-deploy-stable@v8
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
-          token: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
           force-orphan: false
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
diff --git a/.github/workflows/package_cleanup.yml b/.github/workflows/package_cleanup.yml
@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "Delete untagged package versions"
-        uses: ansys/actions/hk-package-clean-untagged@v7
+        uses: ansys/actions/hk-package-clean-untagged@v8
         with:
           package-name: 'pydpf-composites'
           allow-last-days: '14'

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -21,7 +21,7 @@ repos:
   rev: v3.15.2
   hooks:
   - id: pyupgrade
-    args: [--py39-plus]
+    args: [--py310-plus]
 
 - repo: https://github.com/PyCQA/flake8
   rev: 7.0.0

diff --git a/AUTHORS b/AUTHORS
@@ -5,8 +5,8 @@
 # For contributions made under a Corporate CLA, the organization is
 # added to this file.
 #
-# If you have contributed to the repository and wish to be added to this file
-# please submit a request.
+# If you have contributed to the repository and want to be added to this file,
+# submit a request.
 #
 #
 ANSYS, Inc.
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -1,6 +1,6 @@
 # Contributors
 
-## Project Lead or Owner
+## Project Lead
 
 * [Jan von Rickenbach](https://github.com/janvonrickenbach)
 

diff --git a/README.rst b/README.rst
@@ -8,7 +8,7 @@ PyDPF Composites
    :target: https://docs.pyansys.com/
    :alt: PyAnsys
 
-.. |python| image:: https://img.shields.io/badge/Python-%3E%3D3.9-blue
+.. |python| image:: https://img.shields.io/badge/Python-%3E%3D3.10-blue
    :target: https://pypi.org/project/ansys-dpf-composites/
    :alt: Python
 

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -74,6 +74,7 @@ Here are some key features of PyDPF Composites:
 Limitations
 '''''''''''
 - Only the Mechanical APDL solver is supported.
+- The post-processing of expanded cyclic symmetry models is not implemented.
 - The following operators and features are only supported if the model was
   preprocessed with ACP and if the corresponding lay-up definition file is passed to the :class:`.CompositeModel` class.
 

diff --git a/doc/source/intro.rst b/doc/source/intro.rst
@@ -13,7 +13,14 @@ Install the ``ansys-dpf-composites`` package with ``pip``:
 
     pip install ansys-dpf-composites
 
-Specific versions can be installed by specifying the version in the pip command. For example: Ansys 2023 R1 requires ansys-dpf-composites version 0.1.0:
+
+To install the optional dependencies used in the examples, add the ``[examples]`` suffix when installing the package:
+
+.. code::
+
+    pip install ansys-dpf-composites[examples]
+
+Specific versions can be installed by specifying the version in the pip command. For example, Ansys 2023 R1 requires ansys-dpf-composites version 0.1.0:
 
 .. code::
 

diff --git a/examples/001_failure_operator_example.py b/examples/001_failure_operator_example.py
@@ -38,6 +38,13 @@
 allows you to assess different type of materials and failure modes at once.
 The scoping enables you to evaluate the minimum and maximum failures per element
 or select a list of materials or plies.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.get_composite_files_from_workbench_result_folder`
+    method to obtain the input files.
+
 """
 # %%
 # Set up analysis

diff --git a/examples/002_sampling_point_example.py b/examples/002_sampling_point_example.py
@@ -36,6 +36,12 @@
 This example uses the :class:`Composite Model <.CompositeModel>` to scope a
 Sampling Point to a certain element and to visualize the laminate.
 
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.get_composite_files_from_workbench_result_folder`
+    method to obtain the input files.
+
 """
 
 # %%

diff --git a/examples/004_get_material_properties_example.py b/examples/004_get_material_properties_example.py
@@ -30,7 +30,15 @@
 implement a custom failure criterion. The failure criterion is computed for
 all layers and integration points. Finally, the elemental maximum is computed and shown.
 
-Note: Only constant material properties are currently supported.
+.. note::
+
+    Only constant material properties are currently supported.
+
+.. note::
+    When using a Workbench project,
+    use the :func:`.get_composite_files_from_workbench_result_folder`
+    method to obtain the input files.
+
 """
 
 # %%

diff --git a/examples/005_get_layup_properties_example.py b/examples/005_get_layup_properties_example.py
@@ -32,6 +32,13 @@
 
 To get the full layer information of an element, including results,
 consider using the :class:`SamplingPoint <.SamplingPoint>` class.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 # %%
 # Set up analysis

diff --git a/examples/006_filter_composite_data_example.py b/examples/006_filter_composite_data_example.py
@@ -37,6 +37,13 @@
 The examples show filtering data by layer, spot, and node, as well as material
 or analysis ply ID. To learn more about how layered result data is organized,
 see :ref:`select_indices`.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 
 # %%

diff --git a/examples/007_interlaminar_normal_stress_example.py b/examples/007_interlaminar_normal_stress_example.py
@@ -46,6 +46,12 @@
     :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py`
     shows how helper functions can be used to obtain composite result data.
 
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 
 # %%

diff --git a/examples/008_assembly_example.py b/examples/008_assembly_example.py
@@ -31,6 +31,12 @@
 :class:`Composite Model <.CompositeModel>` class is used to access
 the data of the different parts.
 
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 # %%
 # Set up analysis

diff --git a/examples/010_harmonic_example.py b/examples/010_harmonic_example.py
@@ -26,16 +26,16 @@
 Postprocess a harmonic analysis
 -------------------------------
 
+This example shows how to evaluate failure criteria for a harmonic simulation.
+It shows how to create a phase sweep to compute the maximum IRF in the frequency-phase
+space and shows how to identify the critical failure mode and the critical layer.
+
 .. note::
 
     When using a Workbench project,
     use the :func:`.composite_files_from_workbench_harmonic_analysis`
     method to obtain the input files.
 
-This example shows how to evaluate failure criteria for a harmonic simulation.
-It shows how to create a phase sweep to compute the maximum IRF in the frequency-phase
-space and shows how to identify the critical failure mode and the critical layer.
-
 """
 
 

diff --git a/examples/011_rst_workflow.py b/examples/011_rst_workflow.py
@@ -45,6 +45,13 @@
 The postprocessing of MAPDL models is supported in 2024 R2 (DPF Server version 8.0)
 and later. A few advanced features are not supported with the RST only workflow.
 For more information, see :ref:`limitations`.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 # %%
 # Set up analysis

diff --git a/examples/012_fatigue_example.py b/examples/012_fatigue_example.py
@@ -40,6 +40,13 @@
 of the user to verify that it works as expected. For more information, see the
 `fatpack package <https://pypi.org/project/fatpack/>`_,
 
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
+
 """