Merge pull request #23 from ansys-internal/doc_refactoring

doc refactoring

_unittest/conftest.py

@@ -10,7 +10,7 @@
 The default configuration can be changed by placing a file called local_config.json in the same
 directory as this module. An example of the contents of local_config.json
 {
-  "desktopVersion": "2022.2",
+  "desktopVersion": "2024.1",
   "NonGraphical": false,
   "NewThread": false,
   "skip_desktop_test": false

doc/source/Getting_started/About.rst

@@ -1,86 +1,65 @@
-About PyAnsys and AEDT
-======================
+About PyEDB
+===========
 
-PyAnsys
+PyEDB
 -------
 
-PyAEDT is part of the larger `PyAnsys <https://docs.pyansys.com>`_
+PyEDB is part of the larger `PyAnsys <https://docs.pyansys.com>`_
 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,
+PyEDB is intended to consolidate and extend all existing
+functionalities around scripting for ANSYS Electronic DataBase (EDB) to allow reuse of existing code,
 sharing of best practices, and increased collaboration.
 
 
-About AEDT
+About AEDB
 ----------
 
-`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.
+`ANSYS EDB (AEDB) <https://www.ansys.com/products/electronics>`_ is a database allowing efficient and fast
+layout design handling and processing for building ready to solve projects. EDB is addressing Signal
+Integrity (SI), Power Integrity (PI-DC) and also Electro-Thermal work flows. The EDB can be
+imported into Electromagnetic Desktop which enables a user to modify layout,
+assign materials, define ports, simulations and constraints and then launch any of
+the various electromagnetic simulators: HFSS, HFSS3Dlayout, SIwave, Icepak, Maxwell, Q3D.
 
-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.
+AEDB is running as stand alone API and opens aedb folder for directly querying and manipulating
+layout design in memory and does not require to open any User Interface (UI). Hence AEDB is the fastest
+and most efficient way to handle large and complex layout.
+
+AEDB can also been parsed with and Electromagnetic simulator command line like HFSS or SIwave in bacth.
+Therefore completely non graphical flows can be deployed from layout translation up to simulatiom results.
+AEDB can also be imported in ANSYS AEDT with PyAEDT for example to display the project, combining 3D design
+or performing simulation post-processing. AEDB also supports 3D component models.
 
 .. image:: https://images.ansys.com/is/image/ansys/ansys-electronics-technology-collage?wid=941&op_usm=0.9,1.0,20,0&fit=constrain,0
   :width: 800
   :alt: AEDT Applications
   :target: https://www.ansys.com/products/electronics
 
 
-PyAEDT is licensed under the `MIT License
+PyEDB is licensed under the `MIT License
 <https://github.com/ansys/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
-
 
 Dependencies
 ------------
-To run PyAEDT, you must have a local licensed copy of AEDT.
-PyAEDT supports AEDT versions 2022 R2 and later.
+To run PyEDB, you must have a local licensed copy of AEDT.
 
 Student version
 ---------------
 
-PyAEDT supports AEDT Student versions 2022 R2 and later. For more information, see the
+PyEDB supports AEDT Student versions 2022 R2 and later. For more information, see the
 `Ansys Electronics Desktop Student  - Free Software Download <https://www.ansys.com/academic/students/ansys-e
 lectronics-desktop-student>`_ page on the Ansys website.
 
 
-Why PyAEDT?
+Why PyEDB?
 -----------
-A quick and easy approach for automating a simple operation in the
-AEDT UI is to record and reuse a script. However, here are some disadvantages of
-this approach:
-
-- 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.
-
-Here are the main advantages that PyAEDT provides:
-
-- Automatic initialization of all AEDT objects, such as desktop
-  objects like the editor, boundaries, and more
-- Error management
-- Log management
-- Variable management
-- Compatibility with IronPython (limited) 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
+ANSYS EDB is very powerful for processing complex and large layout design. EDB-core native API
+can be used to automate workflows. However it requires a deep comprehension of the architecture and
+classes inheritances, resulting with a learning curve not always compatible with daily work load.
+
+PyEDB was developed to provide high level classes calling EDB-core API to speed up EDB adoption
+and improve user experience. Thanks to its application oriented architecture PyEDB, users can
+start using EDB faster and easier.