merge with main; bump to v0.51.15

Author: akaszynski

.ci/build_wheels.sh

@@ -6,15 +6,6 @@ set -e -x
 # build based on python version from args
 PYTHON_VERSION="$1"
 case $PYTHON_VERSION in
-2.7)
-  PYBIN="/opt/python/cp27-cp27m/bin"
-  ;;
-3.5)
-  PYBIN="/opt/python/cp35-cp35m/bin"
-  ;;
-3.6)
-  PYBIN="/opt/python/cp36-cp36m/bin"
-  ;;
 3.7)
   PYBIN="/opt/python/cp37-cp37m/bin"
   ;;
@@ -31,8 +22,8 @@ esac
 
 # build, don't install
 cd io
-"${PYBIN}/pip" install -r requirements_build.txt
-"${PYBIN}/python" setup.py bdist_wheel
+"${PYBIN}/pip" install build
+"${PYBIN}/python" -m build --wheel
 auditwheel repair dist/ansys_mapdl_reader*.whl
 rm -f dist/*
 mv wheelhouse/*manylinux* dist/

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+skip = *.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./doc/build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/source/examples/*,*cover,*.dat,*.mac,\#*,build,./docker/mapdl/v*,./factory/*,./ansys/mapdl/core/mapdl_functions.py,PKG-INFO,*.mypy_cache/*,./docker/mapdl/*,./_unused/*
+ignore-words-list = delet,appen,parm,pres,wan,filname,ans,tread,wan,levl,mater,aadd,extrem,imagin,ist,nin,sord,struc,emiss,vise,sur,ect,ther,esy
+quiet-level = 3

.flake8

@@ -0,0 +1,8 @@
+[flake8]
+exclude = venv, __init__.py, build, doc/source/examples
+# To be added after refactoring code to be compliant: E501 
+select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, F401, F403
+count = True
+max-complexity = 10
+max-line-length = 100
+statistics = True

.github/workflows/testing-and-deployment.yml

@@ -18,28 +18,31 @@ on:
     branches:
       - main
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  check_style:
+  stylecheck:
     name: Style Check
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v2
       - name: Setup Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v2.2.2
         with:
-          python-version: 3.9
-      - name: Style
-        run: |
-          pip install -r requirements_style.txt --disable-pip-version-check
-          make
+          python-version: '3.10'
+      - name: Install pre-commit
+        run: pip install pre-commit
+      - name: Run pre-commit
+        run: pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )
 
   doc_build:
     name: Build Documentation
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Setup Python
         uses: actions/setup-python@v2
@@ -55,23 +58,20 @@ jobs:
 
       - name: Install ansys-mapdl-reader
         run: |
-          pip install -r requirements_build.txt --disable-pip-version-check
-          python setup.py bdist_wheel
-          pip install dist/ansys*.whl --disable-pip-version-check
+          pip install -e .
           cd tests/
           xvfb-run python -c "from ansys.mapdl import reader as pymapdl_reader; print(pymapdl_reader.Report())"
 
       - name: Build Documentation
         run: |
-          sudo apt install pandoc -qy
+          sudo apt-get install zip pandoc -qy
           pip install -r requirements_docs.txt --disable-pip-version-check
           xvfb-run make -C doc html
-          sudo apt install zip
           cd doc/build/html/
           zip ../../../${{ env.PACKAGE_NAME }}-HTML.zip ./*
 
       - name: Upload
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: ${{ env.PACKAGE_NAME }}-Documentation
           path: |
@@ -97,15 +97,15 @@ jobs:
         os: [ubuntu-latest, windows-latest]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v1
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Linux pip cache
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         if: ${{ runner.os == 'Linux' }}
         with:
           path: ~/.cache/pip
@@ -114,7 +114,7 @@ jobs:
             Python-${{ runner.os }}-${{ matrix.python-version }}
 
       - name: Window pip cache
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         if: ${{ runner.os == 'Windows' }}
         with:
           path: ~\AppData\Local\pip\Cache
@@ -136,10 +136,6 @@ jobs:
                quay.io/pypa/manylinux2014_x86_64 \
                /io/.ci/build_wheels.sh ${{ matrix.python-version }}
 
-      - name: Install VTK on Python 3.10
-        if: matrix.python-version == '3.10'
-        run: pip install --find-links https://wheels.pyvista.org/ vtk
-
       - name: Build wheel on Windows
         if: ${{ runner.os == 'Windows' }}
         run: |
@@ -167,7 +163,7 @@ jobs:
 
       - name: Get PyVista tools
         if: ${{ runner.os == 'Windows' }}
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: pyvista/gl-ci-helpers
           path: pyvista-tools
@@ -199,60 +195,35 @@ jobs:
         if: ${{ runner.os == 'Windows' }}
         run: pytest -v tests/ --durations=0
 
+      - uses: codecov/codecov-action@v2
+        if: ${{ runner.os == 'Linux' && matrix.python-version == '3.9' }}
+        name: 'Upload coverage to Codecov'
+
       - name: Upload wheel
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: ${{ env.PACKAGE_NAME }}-${{ runner.os }}-${{ matrix.python-version }}
           path: dist/
           retention-days: 7
 
-  # mac_build:
-  #   runs-on: macos-latest
-  #   name: Mac OS Unit Testing
-  #   strategy:
-  #     matrix:
-  #       python-version: ['3.8']
-
-  #   steps:
-  #     - uses: actions/checkout@v2
-
-  #     - name: Set up Python ${{ matrix.python-version }}
-  #       uses: actions/setup-python@v1
-  #       with:
-  #         python-version: ${{ matrix.python-version }}
-
-  #     - name: Build wheels
-  #       uses: joerick/[email protected]
-  #       env:
-  #         CIBW_BEFORE_BUILD: pip install -r requirements_build.txt
-  #         CIBW_BUILD: cp38-macosx_x86_64
-
-  #     - name: Build wheels
-  #       if: startsWith(github.event.ref, 'refs/tags')
-  #       uses: joerick/[email protected]
-  #       env:
-  #         CIBW_BEFORE_BUILD: pip install -r requirements_build.txt
-  #         CIBW_SKIP: pp* cp38-macosx_x86_64
-
-  #     - name: Show files
-  #       run: ls -lh wheelhouse
-  #       shell: bash
-
-  #     - name: Upload wheels
-  #       uses: actions/upload-artifact@v2
-  #       with:
-  #         path: wheelhouse/*.whl
-
-  #     - name: Install wheel
-  #       run: |
-  #         pip install wheelhouse/*38*
-
-  #     - name: Test
-  #       run: |
-  #         pip install -r requirements_test.txt
-  #         cd tests
-  #         pytest -v
+  mac_build:
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    name: Build wheels on MacOS
+    runs-on: macos-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Build wheels
+        uses: pypa/[email protected]
+
+      - name: List generated wheels
+        run: |
+          ls ./wheelhouse/*
 
+      - uses: actions/upload-artifact@v3
+        with:
+          path: ./wheelhouse/*.whl
 
   pymapdl_tests:
     name: PyMAPDL Unit Testing
@@ -289,7 +260,7 @@ jobs:
           sudo apt install libgl1-mesa-glx xvfb
 
       - name: Linux pip cache
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.cache/pip
           key: Python-${{ runner.os }}-3.8-${{ hashFiles('setup.py') }}-${{ hashFiles('requirements_*.txt') }}
@@ -336,7 +307,7 @@ jobs:
 
   Release:
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-    needs: [check_style, doc_build, build, pymapdl_tests] # , mac_build
+    needs: [stylecheck, doc_build, build, pymapdl_tests, mac_build]
     runs-on: ubuntu-latest
     steps:
       - name: Set up Python

.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+repos:
+- repo: https://github.com/psf/black
+  rev: 22.3.0
+  hooks:
+  - id: black
+
+- repo: https://github.com/pycqa/isort
+  rev: 5.10.1
+  hooks:
+  - id: isort
+    args: [
+    "--profile", "black",
+    "--force-sort-within-sections",
+    "--skip-glob", "*__init__.py",
+    ]
+- repo: https://gitlab.com/PyCQA/flake8
+  rev: 3.9.2
+  hooks:
+  - id: flake8
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.1.0
+  hooks:
+  - id: codespell
+
+# add this eventually
+# - repo: https://github.com/pycqa/pydocstyle
+#   rev: 6.1.1
+#   hooks:
+#   - id: pydocstyle
+#     additional_dependencies: [toml]
+#     exclude: "tests/"
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.1.0
+  hooks:
+  - id: check-merge-conflict
+  - id: debug-statements
+
+# this validates our github workflow files
+- repo: https://github.com/python-jsonschema/check-jsonschema
+  rev: 0.14.0
+  hooks:
+    - id: check-github-workflows

README.rst

@@ -1,12 +1,32 @@
 ======================================================
 PyMAPDL Reader - Legacy Binary and Archive File Reader
 ======================================================
-.. image:: https://badge.fury.io/py/ansys-mapdl-reader.svg
-    :target: https://badge.fury.io/py/ansys-mapdl-reader
+|pyansys| |pypi| |PyPIact| |GH-CI| |codecov| |MIT| |black|
 
-.. image:: https://github.com/pyansys/pymapdl-reader/actions/workflows/testing-and-deployment.yml/badge.svg
+.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
+   :target: https://docs.pyansys.com/
+   :alt: PyAnsys
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-mapdl-reader.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-mapdl-reader/
+
+.. |PyPIact| image:: https://img.shields.io/pypi/dm/ansys-mapdl-reader.svg?label=PyPI%20downloads
+   :target: https://pypi.org/project/ansys-mapdl-reader/
+
+.. |codecov| image:: https://codecov.io/gh/pyansys/pymapdl-reader/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/pyansys/pymapdl-reader
+
+.. |GH-CI| image:: https://github.com/pyansys/pymapdl-reader/actions/workflows/testing-and-deployment.yml/badge.svg
    :target: https://github.com/pyansys/pymapdl-reader/actions/workflows/testing-and-deployment.yml
 
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/licenses/MIT
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+  :target: https://github.com/psf/black
+  :alt: black
+
+
 This is the legacy module for reading in binary and ASCII files
 generated from MAPDL.
 
@@ -29,13 +49,13 @@ Please see the `PyMAPDL-Reader Documentation
 
 .. note::
 
-   This module will likely change or be depreciated in the future.
+   This module may be depreciated in the future.
 
    You are encouraged to use the new Data Processing Framework (DPF)
-   modules at `DPF-Core <https://github.com/pyansys/DPF-Core>`_ and
-   `DPF-Post <https://github.com/pyansys/DPF-Post>`_ as they provide a
-   modern interface to ANSYS result files using a client/server
-   interface using the same software used within ANSYS Workbench, but
+   modules at `PyDPF-Core <https://github.com/pyansys/pydpf-core>`_ and
+   `PyDPF-Post <https://github.com/pyansys/pydpf-post>`_ as they provide a
+   modern interface to Ansys result files using a client/server
+   interface using the same software used within Ansys Workbench, but
    via a Python client.
 
 
@@ -48,6 +68,7 @@ Installation through pip::
 You can also visit `pymapdl-reader <https://github.com/pyansys/pymapdl-reader>`_
 to download the source or releases from GitHub.
 
+
 Python 3.10 Extra Instructions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -294,8 +315,6 @@ you will need to install your own C++ compiler. We recommend:
        a. Navigate to the project's top level (the same directory as this README)
        b. run ``pip install -e .``
 
-To get the package up and running.
-
 
 License and Acknowledgments
 ---------------------------