-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #30 from ansys-internal/doc
first init edb. Waiting for pyedb bug fix
- Loading branch information
Showing
46 changed files
with
85 additions
and
617 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -31,7 +31,7 @@ page to submit questions, report bugs, and request new features. | |
|
||
To reach the product support team, email `[email protected] <[email protected]>`_. | ||
|
||
View PyAEDT documentation | ||
View PyEDB documentation | ||
------------------------- | ||
Documentation for the latest stable release of PyAEDT is hosted at | ||
`PyAEDT Documentation <https://aedt.docs.pyansys.com>`_. | ||
|
@@ -73,7 +73,7 @@ For example:: | |
|
||
Log errors | ||
~~~~~~~~~~ | ||
PyAEDT has an internal logging tool named ``Messenger`` | ||
PyEDB has an internal logging tool named ``Messenger`` | ||
and a log file that is automatically generated in the project | ||
folder. | ||
|
||
|
@@ -120,7 +120,7 @@ Here is an example of an error: | |
.. code:: | ||
---------------------------------------------------------------------------------- | ||
PyAEDT error on method create_box: General or AEDT error. Check again | ||
PyEDB error on method create_box: General or EDB error. Check again | ||
the arguments provided: | ||
position = [0, 0, 0] | ||
dimensions_list = [0, 10, 10] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,8 +3,8 @@ Quick Code | |
|
||
Documentation and issues | ||
------------------------ | ||
Documentation for the latest stable release of PyAEDT is hosted at | ||
`PyAEDT documentation <https://aedt.docs.pyansys.com/version/stable/>`_. | ||
Documentation for the latest stable release of PyEDB is hosted at | ||
`PyEDB documentation <https://aedt.docs.pyansys.com/version/stable/>`_. | ||
|
||
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 | ||
|
@@ -14,33 +14,27 @@ released versions. | |
You can also view or download PyAEDT cheat sheets, which are one-page references | ||
providing syntax rules and commands for using the PyAEDT API and PyEDB API: | ||
|
||
- `View PyAEDT cheat sheet <https://cheatsheets.docs.pyansys.com/pyaedt_API_cheat_sheet.png>`_ or | ||
`download PyAEDT cheat sheet <https://cheatsheets.docs.pyansys.com/pyaedt_API_cheat_sheet.pdf>`_ the | ||
PyAEDT API cheat sheet. | ||
|
||
- `View EDB cheat sheet <https://cheatsheets.docs.pyansys.com/pyedb_API_cheat_sheet.png>`_ or | ||
`download EDB cheat sheet <https://cheatsheets.docs.pyansys.com/pyedb_API_cheat_sheet.pdf>`_ the | ||
- `View PyEDB cheat sheet <https://cheatsheets.docs.pyansys.com/pyedb_API_cheat_sheet.png>`_ or | ||
`download PyEDB cheat sheet <https://cheatsheets.docs.pyansys.com/pyedb_API_cheat_sheet.pdf>`_ the | ||
PyAEDT API cheat sheet. | ||
|
||
|
||
On the `PyAEDT Issues <https://github.com/ansys/PyAEDT/issues>`_ page, you can | ||
create issues to report bugs and request new features. On the `PyAEDT Discussions | ||
<https://github.com/ansys/pyaedt/discussions>`_ page or the `Discussions <https://discuss.ansys.com/>`_ | ||
On the `PyEDB Issues <https://github.com/ansys/Pansys-edb/issues>`_ page, you can | ||
create issues to report bugs and request new features. On the `PyEDB Discussions | ||
<https://github.com/ansys/pyansys-edb/discussions>`_ page or the `Discussions <https://discuss.ansys.com/>`_ | ||
page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback. | ||
|
||
To reach the project support team, email `[email protected] <[email protected]>`_. | ||
|
||
|
||
Example workflow | ||
---------------- | ||
Here’s a brief example of how PyAEDT works: | ||
Here’s a brief example of how PyEDB works: | ||
|
||
Connect to AEDT from a Python IDE | ||
--------------------------------- | ||
PyAEDT works both inside AEDT and as a standalone app. | ||
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. | ||
PyEDB works both inside AEDT and as a standalone app. | ||
PyEDB also provides advanced error management. Usage examples follow. | ||
|
||
Explicit AEDT declaration and error management | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.