Merge branch 'main' into release/0.6

.github/labeler.yml

@@ -1,6 +1,7 @@
 documentation:
 - doc/source/**/*
-- README.rst
+- README.md
+- README_CN.md
 maintenance:
 - .github/**/*
 - .flake8

.github/workflows/ironpython.yml

@@ -31,6 +31,7 @@ jobs:
           Set-Item -Path env:ANSYSEM_FEATURE_SF159726_SCRIPTOBJECT_ENABLE -Value "1"
           Set-Item -Path env:ANSYSEM_FEATURE_SF222134_CABLE_MODELING_ENHANCEMENTS_ENABLE -Value "1"
           Set-Item -Path env:ANSYSEM_FEATURE_F395486_RIGID_FLEX_BENDING_ENABLE -Value "1"
+          Set-Item -Path env:ANSYSEM_FEATURE_S432616_LAYOUT_COMPONENT_IN_3D_ENABLE -Value "1"
           $processA = start-process 'cmd' -ArgumentList '/c .\_unittest_ironpython\run_unittests_batchmode.cmd --test-filter test_0*.py' -PassThru
           $processB = start-process 'cmd' -ArgumentList '/c .\_unittest_ironpython\run_unittests_batchmode.cmd --test-filter test_1*.py' -PassThru
           $processC = start-process 'cmd' -ArgumentList '/c .\_unittest_ironpython\run_unittests_batchmode.cmd --test-filter test_2*.py' -PassThru

.pre-commit-config.yaml

@@ -69,4 +69,4 @@ repos:
 #     additional_dependencies: [toml]
 #     files: ^pyaedt/
 #     args:
-#     - --ignore=D412,D413,D213,D101,D107,D203,D102
+#     - --ignore=D412,D413,D213,D101,D107,D203,D102, D205

README.md

@@ -0,0 +1,229 @@
+<!-- -->
+<a name="readme-top"></a>
+<!--
+*** PyAEDT README
+-->
+
+
+# PyAEDT
+
+<p style="text-align: center;">
+    <br> English | <a href="README_CN.md">中文</a>
+</p>
+
+[![PyAnsys](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)](https://docs.pyansys.com/)[![pypi](https://img.shields.io/pypi/v/pyaedt.svg?logo=python&logoColor=white)](https://pypi.org/project/pyaedt/)[![PyPIact](https://pepy.tech/badge/pyaedt/month)](https://pypi.org/project/pyaedt/)[![PythonVersion](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)[![GH-CI](https://github.com/pyansys/pyaedt/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/pyansys/pyaedt/actions/workflows/unit_tests.yml)[![codecov](https://codecov.io/gh/pyansys/pyaedt/branch/main/graph/badge.svg)](https://codecov.io/gh/pyansys/pyaedt)[![MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)[![black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat)](https://github.com/psf/black)[![Anaconda](https://anaconda.org/conda-forge/pyaedt/badges/version.svg)](https://anaconda.org/conda-forge/pyaedt)[![pre-commit](https://results.pre-commit.ci/badge/github/pyansys/pyaedt/main.svg)](https://results.pre-commit.ci/latest/github/pyansys/pyaedt/main)
+
+## What is PyAEDT?
+
+`PyAEDT` is a Python library that interacts directly with the API for
+Ansys Electronics Desktop (AEDT) to make scripting simpler. The architecture
+for PyAEDT can be reused for all AEDT 3D products (HFSS, Icepak, Maxwell 3D,
+and Q3D Extractor), 2D tools, and Ansys Mechanical. PyAEDT also provides
+support for circuit tools like Nexxim and system simulation tools like
+Twin Builder. Finally, PyAEDT provides scripting capabilities in Ansys layout
+tools like HFSS 3D Layout and EDB. The PyAEDT class and method structures
+simplify operation while reusing information as much as possible across
+the API.
+
+## Install on CPython from PyPI
+
+You can install PyAEDT on CPython 3.7 through 3.10 from PyPI with this command:
+
+```sh
+  pip install pyaedt
+```
+
+Install `PyAEDT` with all extra packages (matplotlib, numpy, pandas, pyvista):
+
+```sh
+  pip install pyaedt[full]
+```
+
+You can also install PyAEDT from Conda-Forge with this command:
+
+```sh
+  conda install -c conda-forge pyaedt
+```
+PyAEDT remains compatible with IronPython and can be still used in the AEDT Framework.
+
+## About PyAnsys
+
+`PyAEDT` is part of the larger [PyAnsys](https://docs.pyansys.com "PyAnsys") effort to facilitate the use of Ansys technologies directly from Python.
+
+PyAEDT is intended to consolidate and extend all existing
+functionalities around scripting for AEDT to allow reuse of existing code,
+sharing of best practices, and increased collaboration.
+
+## About AEDT
+
+[AEDT](https://www.ansys.com/products/electronics) is a platform that enables true
+electronics system design. AEDT provides access to the Ansys gold-standard
+electro-magnetics simulation solutions, such as Ansys HFSS, Ansys Maxwell,
+Ansys Q3D Extractor, Ansys Siwave, and Ansys Icepak using electrical CAD (ECAD) and
+Mechanical CAD (MCAD) workflows.
+
+In addition, AEDT includes direct links to the complete Ansys portfolio of thermal, fluid,
+and mechanical solvers for comprehensive multiphysics analysis.
+Tight integration among these solutions provides unprecedented ease of use for setup and
+faster resolution of complex simulations for design and optimization.
+
+<p align="center">
+  <img width="100%" src="https://images.ansys.com/is/image/ansys/ansys-electronics-technology-collage?wid=941&op_usm=0.9,1.0,20,0&fit=constrain,0" title="AEDT Applications" herf="https://www.ansys.com/products/electronics"
+  />
+</p>
+
+`PyAEDT` is licensed under the [MIT License](https://github.com/pyansys/PyAEDT/blob/main/LICENSE)
+
+`PyAEDT` includes functionality for interacting with the following `AEDT tools` and `Ansys products`:
+
+  - HFSS and HFSS 3D Layout
+  - Icepak
+  - Maxwell 2D, Maxwell 3D, and RMXprt
+  - 2D Extractor and Q3D Extractor
+  - Mechanical
+  - Nexxim
+  - EDB
+  - Twin Builder
+
+## Documentation and issues
+
+In addition to installation and usage information, the `PyAEDT` documentation provides [API reference](https://aedt.docs.pyansys.com/version/stable), [Examples](https://aedt.docs.pyansys.com/version/stable/examples/index.html), and [Contribute](https://aedt.docs.pyansys.com/version/stable/Contributing.html) sections.
+
+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.
+
+On the [PyAEDT Issues](https://github.com/pyansys/PyAEDT/issues) page, you can
+create issues to submit questions, report bugs, and request new features.
+
+To reach the project support team, email `[email protected] <[email protected]>`_.
+
+## Dependencies
+
+To run `PyAEDT`, you must have a local licenced copy of AEDT.
+`PyAEDT` supports AEDT versions 2022 R1 or newer.
+
+## Student version
+
+`PyAEDT` supports `AEDT Student version 2022 R1` and later. For more information, see [Student Version page](https://www.ansys.com/academic/students/ansys-electronics-desktop-student).
+
+## Why PyAEDT?
+
+A quick and easy approach for automating a simple operation in the AEDT UI is to record and reuse a script. However, disadvantages of this approach are:
+
+  - Recorded code is dirty and difficult to read and understand.
+  - Recorded scripts are difficult to reuse and adapt.
+  - Complex coding is required by many global users of `AEDT`.
+
+The main advantages of `PyAEDT` are:
+
+  - Automatic initialization of all `AEDT` objects, such as desktop objects like the editor, boundaries, and so on
+  - Error management
+  - Log management
+  - Variable management
+  - Compatibility with IronPython and CPython
+  - Simplification of complex API syntax using data objects while maintaining PEP8 compliance.
+  - Code reusability across different solvers
+  - Clear documentation on functions and API
+  - Unit tests of code to increase quality across different AEDT versions
+
+## Example workflow
+
+ 1. Initialize the ``Desktop`` class with the version of `AEDT` to use.
+ 2. Initialize the application to use within `AEDT`.
+
+## Connect to AEDT from Python IDE
+
+``PyAEDT`` works both inside AEDT and as a standalone application. This Python library automatically detects whether it is running in an IronPython or CPython environment and initializes AEDT accordingly.
+``PyAEDT`` also provides advanced error management. Usage examples follow.
+
+## Explicit AEDT declaration and error management
+
+``` python
+    # Launch AEDT 2022 R2 in non-graphical mode
+
+    from pyaedt import Desktop, Circuit
+    with Desktop(specified_version="2022.2",
+                 non_graphical=False, new_desktop_session=True,
+                 close_on_exit=True, student_version=False):
+        circuit = Circuit()
+        ...
+        # Any error here will be caught by Desktop.
+        ...
+
+    # Desktop is automatically released here.
+```
+
+## Implicit AEDT declaration and error management
+
+``` python
+    # Launch the latest installed version of AEDT in graphical mode
+
+    from pyaedt import Circuit
+    with Circuit(specified_version="2022.2",
+                 non_graphical=False) as circuit:
+        ...
+        # Any error here will be caught by Desktop.
+        ...
+
+    # Desktop is automatically released here.
+```
+
+## Remote application call
+
+You can make a remote application call on a CPython server
+or any Windows client machine.
+
+On a CPython Server:
+
+``` python
+    # Launch PyAEDT remote server on CPython
+
+    from pyaedt.common_rpc import pyaedt_service_manager
+    pyaedt_service_manager()
+```
+
+On any Windows client machine:
+
+``` python
+    from pyaedt.common_rpc import create_session
+    cl1 = create_session("server_name")
+    cl1.aedt(port=50000, non_graphical=False)
+    hfss = Hfss(machine="server_name", port=50000)
+    # your code here
+```
+
+## Variables
+
+``` python
+    from pyaedt.HFSS import HFSS
+    with HFSS as hfss:
+         hfss["dim"] = "1mm"   # design variable
+         hfss["$dim"] = "1mm"  # project variable
+```
+
+## Modeler
+
+``` python
+    # Create a box, assign variables, and assign materials.
+
+    from pyaedt.hfss import Hfss
+    with Hfss as hfss:
+         hfss.modeler.create_box([0, 0, 0], [10, "dim", 10],
+                                 "mybox", "aluminum")
+```
+
+## License
+
+`PyAEDT` is licensed under the `MIT` license.
+
+This module makes no commercial claim over Ansys whatsoever. `PyAEDT` extends the functionality of `AEDT` by adding an additional Python interface to `AEDT` without changing the core behavior or license of the original software. The use of the interactive control of `PyAEDT` requires a legally licensed local copy of `AEDT`. For more information about `AEDT`, visit the [AEDT page](https://www.ansys.com/products/electronics) on the `Ansys` website.
+
+<p style="text-align: right;"> <a href="#readme-top">back to top</a> </p>
+
+## Indices and tables
+
+-  [Index](https://aedt.docs.pyansys.com/version/stable/genindex.html)
+-  [Module Index](https://aedt.docs.pyansys.com/version/stable/py-modindex.html)
+-  [Search Page](https://aedt.docs.pyansys.com/version/stable/search.html)