=============
API reference
=============

This section describes EDB functions, classes, and methods
for EDB apps and modules. Use the search feature or click links
to view API documentation.

The PyEDB API includes classes for apps and modules. You must initialize the
``Edb`` class to get access to all modules and methods. All other classes and
methods are inherited into the ``Edb`` class.

If EDB is launched within the ``HfssdLayout`` class, EDB is accessible in read-only mode.


.. image:: ../resources/edb_intro.png
  :width: 800
  :alt: EDB apps
  :target: https://www.ansys.com/applications/pcbs-ics-ic-packages


**Example**

.. code:: python

    from pyedb import Edb

    edb = Edb("my_project.aedb", edbversion="2023.1")
    edb.core_components.components["R1"].r_value = 40
    edb.close_edb()


.. toctree::
   :maxdepth: 2

   CoreEdb
   LayerData
   PrimitivesEdb
   ComponentsEdb
   NetsEdb
   PadstackEdb
   SourcesEdb
   SimulationConfigurationEdb
   SiWave
   PortsEdb