.. _quick_code:

Quick code
==========

To help you begin using PyEDB, you can view or download the PyEDB API cheat sheet. This one-page reference
provides syntax rules and commands for using the PyEDB API:

- `View <https://cheatsheets.docs.pyansys.com/pyedb_API_cheat_sheet.png>`_ the PyEDB API cheat sheet.
- `Download <https://cheatsheets.docs.pyansys.com/pyedb_API_cheat_sheet.pdf>`_ the PyEDB API cheat sheet.

Load an AEDB file into memory
-----------------------------

This code shows how to use PyEDB to load an existing AEDB file into memory:

.. code:: python

    from pyedb import Edb
    from pyedb.generic.general_methods import generate_unique_folder_name
    import pyedb.misc.downloads as downloads

    temp_folder = generate_unique_folder_name()
    targetfile = downloads.download_file("edb/ANSYS-HSD_V1.aedb", destination=temp_folder)
    edbapp = Edb(edbpath=targetfile, edbversion="2024.1")

Connect to EDB from a Python IDE
--------------------------------

PyEDB works both inside AEDT and as a standalone app. PyEDB also provides
advanced error management. The following code examples provide a brief
example of how PyEDB works.

Explicit PyEDB declaration and error management
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: python

    # Start EDB

    from pyedb import Edb

    edb_file = pyedb.layout_examples.ANSYS - HSD_V1.aedb
    edb = Edb(edbversion="2024.1", edbpath=edb_file)


Variables
~~~~~~~~~

.. code:: python

    from pyedb import Edb

    edb_file = pyedb.layout_examples.ANSYS - HSD_V1.aedb
    edb = Edb(edbversion="2024.1", edbpath=edb_file)
    edb["dim"] = "1mm"  # design variable
    edb["$dim"] = "1mm"  # project variable