REFACTOR!: Architecture to match pyansys guide lines (#4849)

Co-authored-by: Samuel Lopez <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Matthew Young <[email protected]>

Author: 4 people

.github/CODEOWNERS

@@ -1,7 +1,7 @@
 .github/* @MaxJPRey @maxcapodi78 @Samuelopez-ansys
 
 /_unittest/test_26_emit.py @jsalant22 @myoung301
-/pyaedt/emit.py @jsalant22 @myoung301
-/pyaedt/emit_core/ @jsalant22 @myoung301
-/pyaedt/modeler/circuits/PrimitivesEmit.py @jsalant22 @myoung301
+/src/ansys/aedt/core/emit.py @jsalant22 @myoung301
+/src/ansys/aedt/core/emit_core/ @jsalant22 @myoung301
+/src/ansys/aedt/core/modeler/circuits/PrimitivesEmit.py @jsalant22 @myoung301
 /examples/07-EMIT/ @jsalant22 @myoung301

.github/workflows/ci_cd.yml

@@ -66,7 +66,7 @@ jobs:
 
       - name: Import python package
         run: |
-          python -c "import pyaedt; from pyaedt import __version__"
+          python -c "import ansys.aedt.core; from ansys.aedt.core import __version__"
 
   # TODO: Update to ansys/actions/doc-build@v6 once we remove examples
   doc-build:
@@ -93,8 +93,8 @@ jobs:
       - name: Retrieve PyAEDT version
         id: version
         run: |
-          echo "PYAEDT_VERSION=$(python -c 'from pyaedt import __version__; print(__version__)')" >> $GITHUB_OUTPUT
-          echo "PyAEDT version is: $(python -c "from pyaedt import __version__; print(__version__)")"
+          echo "PYAEDT_VERSION=$(python -c 'from ansys.aedt.core import __version__; print(__version__)')" >> $GITHUB_OUTPUT
+          echo "PyAEDT version is: $(python -c "from ansys.aedt.core import __version__; print(__version__)")"
 
       - name: Install doc build requirements
         run: |
@@ -166,8 +166,8 @@ jobs:
         id: version
         run: |
           .venv\Scripts\Activate.ps1
-          echo "PYAEDT_VERSION=$(python -c 'from pyaedt import __version__; print(__version__)')" >> $GITHUB_OUTPUT
-          echo "PyAEDT version is: $(python -c "from pyaedt import __version__; print(__version__)")"
+          echo "PYAEDT_VERSION=$(python -c 'from ansys.aedt.core import __version__; print(__version__)')" >> $GITHUB_OUTPUT
+          echo "PyAEDT version is: $(python -c "from ansys.aedt.core import __version__; print(__version__)")"
 
       - name: Install CI dependencies (e.g. vtk-osmesa)
         run: |
@@ -264,7 +264,7 @@ jobs:
           PYTHONMALLOC: malloc
         run: |
           .venv\Scripts\Activate.ps1
-          pytest --durations=50 -v --cov=pyaedt --cov-report=xml --cov-report=html --junitxml=junit/test-results.xml _unittest_solvers
+          pytest --durations=50 -v --cov=ansys.aedt.core --cov-report=xml --cov-report=html --junitxml=junit/test-results.xml _unittest_solvers
 
       - uses: codecov/codecov-action@v4
         with:
@@ -321,7 +321,7 @@ jobs:
         run: |
           export LD_LIBRARY_PATH=${{ env.ANSYSEM_ROOT242 }}/common/mono/Linux64/lib64:${{ env.ANSYSEM_ROOT242 }}/Delcross:$LD_LIBRARY_PATH
           source .venv/bin/activate
-          pytest --durations=50 -v --cov=pyaedt --cov-report=xml --cov-report=html --junitxml=junit/test-results.xml _unittest_solvers
+          pytest --durations=50 -v --cov=ansys.aedt.core --cov-report=xml --cov-report=html --junitxml=junit/test-results.xml _unittest_solvers
 
       - uses: codecov/codecov-action@v4
         with:
@@ -385,7 +385,7 @@ jobs:
           timeout_minutes: 50
           command: |
             .venv\Scripts\Activate.ps1
-            pytest -n 4 --dist loadfile --durations=50 -v --cov=pyaedt --cov-report=xml --cov-report=html --junitxml=junit/test-results.xml _unittest
+            pytest -n 4 --dist loadfile --durations=50 -v --cov=ansys.aedt.core --cov-report=xml --cov-report=html --junitxml=junit/test-results.xml _unittest
 
       - uses: codecov/codecov-action@v4
         with:
@@ -454,7 +454,7 @@ jobs:
           command: |
             export LD_LIBRARY_PATH=${{ env.ANSYSEM_ROOT242 }}/common/mono/Linux64/lib64:${{ env.ANSYSEM_ROOT242 }}/Delcross:$LD_LIBRARY_PATH
             source .venv/bin/activate
-            pytest -n 2 --dist loadfile --durations=50 -v --cov=pyaedt --cov-report=xml --cov-report=html --junitxml=junit/test-results.xml _unittest
+            pytest -n 2 --dist loadfile --durations=50 -v --cov=ansys.aedt.core --cov-report=xml --cov-report=html --junitxml=junit/test-results.xml _unittest
 
       - uses: codecov/codecov-action@v4
         with:
@@ -470,38 +470,9 @@ jobs:
           path: junit/test-results.xml
         if: ${{ always() }}
 
-# # =================================================================================================
-# # vvvvvvvvvvvvvvvvvvvvvvvvvvvvvv    RUNNING ON SELF-HOSTED RUNNER    vvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
-# # =================================================================================================
-
-  test-ironpython-windows:
-    name: Testing IronPython and coverage (Windows)
-    needs: [smoke-tests]
-    runs-on: [ self-hosted, Windows, pyaedt ]
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Run Ironpython tests
-        timeout-minutes: 5
-        run: |
-          $processA = start-process 'cmd' -ArgumentList '/c .\_unittest_ironpython\run_unittests_batchmode.cmd' -PassThru
-          $processA.WaitForExit()
-
-      - name: Get log content
-        run: |
-          get-content .\_unittest_ironpython\pyaedt_unit_test_ironpython.log
-
-      - name: Check for errors
-        run: |
-          $test_errors_failures = Select-String -Path .\_unittest_ironpython\pyaedt_unit_test_ironpython.log -Pattern "TextTestResult errors="
-          if ($test_errors_failures -ne $null)
-          {
-            exit 1
-          }
-
   package:
     name: Package library
-    needs: [test-windows, test-solvers-windows, test-ironpython-windows, test-linux, test-solvers-linux, doc-build]
+    needs: [test-windows, test-solvers-windows, test-linux, test-solvers-linux, doc-build]
     runs-on: ubuntu-latest
     steps:
       - name: Build library source and wheel artifacts
@@ -556,8 +527,8 @@ jobs:
 
       - name: Get the version to PyMeilisearch
         run: |
-          VERSION=$(python -c "from pyaedt import __version__; print('.'.join(__version__.split('.')[:2]))")
-          VERSION_MEILI=$(python -c "from pyaedt import __version__; print('-'.join(__version__.split('.')[:2]))")
+          VERSION=$(python -c "from ansys.aedt.core import __version__; print('.'.join(__version__.split('.')[:2]))")
+          VERSION_MEILI=$(python -c "from ansys.aedt.core import __version__; print('-'.join(__version__.split('.')[:2]))")
           echo "Calculated VERSION: $VERSION"
           echo "Calculated VERSION_MEILI: $VERSION_MEILI"
           echo "VERSION=$VERSION" >> $GITHUB_ENV

.github/workflows/nightly-docs.yml

@@ -49,8 +49,8 @@ jobs:
         id: version
         run: |
           .venv\Scripts\Activate.ps1
-          echo "PYAEDT_VERSION=$(python -c 'from pyaedt import __version__; print(__version__)')" >> $GITHUB_OUTPUT
-          echo "PyAEDT version is: $(python -c "from pyaedt import __version__; print(__version__)")"
+          echo "PYAEDT_VERSION=$(python -c 'from ansys.aedt.core import __version__; print(__version__)')" >> $GITHUB_OUTPUT
+          echo "PyAEDT version is: $(python -c "from ansys.aedt.core import __version__; print(__version__)")"
 
       - name: Install CI dependencies (e.g. vtk-osmesa)
         run: |

.github/workflows/unit_test_prerelease.yml

@@ -61,7 +61,7 @@ jobs:
           Copy-Item -Path "C:\actions-runner\local_config.json" -Destination "_unittest" -Force
           mkdir tmp
           cd tmp
-          python -c "import pyaedt; print('Imported pyaedt')"
+          python -c "import ansys.aedt.core; print('Imported pyaedt')"
 
       # - name: "Check licences of packages"
       #   uses: pyansys/pydpf-actions/[email protected]
@@ -71,7 +71,7 @@ jobs:
         run: |
           testenv\Scripts\Activate.ps1
           Set-Item -Path env:PYTHONMALLOC -Value "malloc"
-          pytest --tx 6*popen --durations=50 --dist loadfile -v --cov=pyaedt  --cov-report=xml --junitxml=junit/test-results.xml --cov-report=html _unittest
+          pytest --tx 6*popen --durations=50 --dist loadfile -v --cov=ansys.aedt.core  --cov-report=xml --junitxml=junit/test-results.xml --cov-report=html _unittest
 
       - uses: codecov/codecov-action@v4
         env:

.gitignore

@@ -361,7 +361,7 @@ doc/build_errors.txt
 _autosummary/
 
 # pip files
-*.egg-info/*
+*.egg-info*
 build/
 dist/
 

.pre-commit-config.yaml

@@ -1,13 +1,12 @@
 files: |
     (?x)(
-        ^pyaedt/|
+        ^src/ansys/aedt/core/|
         _unittest/
     )
 exclude: |
     (?x)(
-        ^pyaedt/rpc/|
-        ^pyaedt/sbrplus/matlab/|
-        pyaedt/conftest.py|
+        ^src/ansys/aedt/core/rpc/|
+        ^src/ansys/aedt/core/sbrplus/matlab/|
         _unittest/example_models/
     )
 
@@ -69,7 +68,7 @@ repos:
   rev: v0.4.3
   hooks:
     - id: add-license-headers
-      files: '(pyaedt|examples|_unittest|_unittest_ironpython|_unittest_solvers)/.*\.(py)'
+      files: '(src|examples|_unittest|_unittest_ironpython|_unittest_solvers)/.*\.(py)'
       args:
       - --custom_template=mit_license.jinja2
       - --start_year=2021

MANIFEST.in

@@ -0,0 +1 @@
+global-include ansys.aedt.core *.txt *.md *.toml *.json *.png *.xml *.areg *.joblib *.acf *.m *.ipynb *.py_build

Makefile

@@ -1,7 +1,7 @@
 # Simple makefile to simplify repetitive build env management tasks under posix
 
-CODESPELL_DIRS ?= ./pyaedt
-CODESPELL_SKIP ?= "*.pyc,*.aedt,*.xml,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./docs/build/*,./docs/images/*,./dist/*,*~,.hypothesis*,./pyaedt/third_party,./docs/source/examples/*,*cover,*.dat,*.mac,\#*,PKG-INFO,*.mypy_cache/*,*.xml,*.aedt,*.svg"
+CODESPELL_DIRS ?= ./src/ansys/aedt/core
+CODESPELL_SKIP ?= "*.pyc,*.aedt,*.xml,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./docs/build/*,./docs/images/*,./dist/*,*~,.hypothesis*,./src/ansys/aedt/core/third_party,./docs/source/examples/*,*cover,*.dat,*.mac,\#*,PKG-INFO,*.mypy_cache/*,*.xml,*.aedt,*.svg"
 CODESPELL_IGNORE ?= "ignore_words.txt"
 
 all: doctest flake8

README.md

@@ -203,7 +203,7 @@ Usage examples follow.
 ``` python
     # Launch AEDT 2022 R2 in non-graphical mode
 
-    from pyaedt import Desktop, Circuit
+    from ansys.aedt.core import Desktop, Circuit
     with Desktop(specified_version="2022.2",
                  non_graphical=False, new_desktop_session=True,
                  close_on_exit=True, student_version=False):
@@ -220,7 +220,7 @@ Usage examples follow.
 ``` python
     # Launch the latest installed version of AEDT in graphical mode
 
-    from pyaedt import Circuit
+    from ansys.aedt.core import Circuit
     with Circuit(specified_version="2022.2",
                  non_graphical=False) as circuit:
         ...
@@ -240,14 +240,14 @@ On a CPython Server:
 ``` python
     # Launch PyAEDT remote server on CPython
 
-    from pyaedt.common_rpc import pyaedt_service_manager
+    from ansys.aedt.core.common_rpc import pyaedt_service_manager
     pyaedt_service_manager()
 ```
 
 On any Windows client machine:
 
 ``` python
-    from pyaedt.common_rpc import create_session
+    from ansys.aedt.core.common_rpc import create_session
     cl1 = create_session("server_name")
     cl1.aedt(port=50000, non_graphical=False)
     hfss = Hfss(machine="server_name", port=50000)
@@ -257,7 +257,7 @@ On any Windows client machine:
 ## Variables
 
 ``` python
-    from pyaedt.HFSS import HFSS
+    from ansys.aedt.core.HFSS import HFSS
     with HFSS as hfss:
          hfss["dim"] = "1mm"   # design variable
          hfss["$dim"] = "1mm"  # project variable
@@ -268,7 +268,7 @@ On any Windows client machine:
 ``` python
     # Create a box, assign variables, and assign materials.
 
-    from pyaedt.hfss import Hfss
+    from ansys.aedt.core.hfss import Hfss
     with Hfss as hfss:
          hfss.modeler.create_box([0, 0, 0], [10, "dim", 10],
                                  "mybox", "aluminum")

README_CN.md

@@ -132,7 +132,7 @@ pip install pyaedt[all]
 ``` python
     # 以非图形模式启动 AEDT 2022 R2
 
-    from pyaedt import Desktop, Circuit
+    from ansys.aedt.core import Desktop, Circuit
     with Desktop(specified_version="2022.2",
                  non_graphical=False, new_desktop_session=True,
                  close_on_exit=True, student_version=False):
@@ -149,7 +149,7 @@ pip install pyaedt[all]
 ``` python
     # Launch the latest installed version of AEDT in graphical mode
 
-    from pyaedt import Circuit
+    from ansys.aedt.core import Circuit
     with Circuit(specified_version="2022.2",
                  non_graphical=False) as circuit:
         ...
@@ -168,14 +168,14 @@ CPython 服务器：
 ``` python
     # 在CPython上启动PyAEDT远程服务器
 
-    from pyaedt.common_rpc import pyaedt_service_manager
+    from ansys.aedt.core.common_rpc import pyaedt_service_manager
     pyaedt_service_manager()
 ```
 
 任意的 Windows 客户端：
 
 ``` python
-    from pyaedt.common_rpc import create_session
+    from ansys.aedt.core.common_rpc import create_session
     cl1 = create_session("server_name")
     cl1.aedt(port=50000, non_graphical=False)
     hfss = Hfss(machine="server_name", port=50000)
@@ -185,7 +185,7 @@ CPython 服务器：
 ## 变量 Variables
 
 ``` python
-    from pyaedt.HFSS import HFSS
+    from ansys.aedt.core.HFSS import HFSS
     with HFSS as hfss:
          hfss["dim"] = "1mm"   # design variable
          hfss["$dim"] = "1mm"  # project variable
@@ -196,7 +196,7 @@ CPython 服务器：
 ``` python
     # 创建BOX、分配变量和指定材料。
 
-    from pyaedt.hfss import Hfss
+    from ansys.aedt.core.hfss import Hfss
     with Hfss as hfss:
          hfss.modeler.create_box([0, 0, 0], [10, "dim", 10],
                                  "mybox", "aluminum")