:class:`Siwave`
===============


.. py:class:: pyedb.siwave.Siwave(specified_version=None)

   Bases: :py:obj:`object`


   
   Initializes SIwave based on the inputs provided and manages SIwave release and closing.


   :Parameters:

       **specified_version** : :class:`python:str`, :class:`python:int`, :class:`python:float`, :obj:`optional`
           Version of AEDT to use. The default is ``None``, in which case
           the active setup is used or the latest installed version is used.














   ..
       !! processed by numpydoc !!


.. py:currentmodule:: Siwave

Overview
--------

.. tab-set::



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~open_project`
            - Open a project.
          * - :py:attr:`~save_project`
            - Save the project.
          * - :py:attr:`~save`
            - Save the project.
          * - :py:attr:`~close_project`
            - Close the project.
          * - :py:attr:`~quit_application`
            - Quit the application.
          * - :py:attr:`~export_element_data`
            - Export element data.
          * - :py:attr:`~export_siwave_report`
            - Export the Siwave report.
          * - :py:attr:`~export_dc_simulation_report`
            - Export the Siwave DC simulation report.
          * - :py:attr:`~run_dc_simulation`
            - Run DC simulation.
          * - :py:attr:`~export_icepak_project`
            - Exports an Icepak project for standalone use.
          * - :py:attr:`~run_icepak_simulation`
            - Runs an Icepak simulation.
          * - :py:attr:`~export_edb`
            - Export the layout as EDB.
          * - :py:attr:`~import_edb`
            - Import layout from EDB.
          * - :py:attr:`~load_configuration`
            - Load configuration settings from a configure file.Import
          * - :py:attr:`~export_configuration`
            - Export layout information into a configuration file.


   .. tab-item:: Properties

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~version`
            - 
          * - :py:attr:`~version_keys`
            - Version keys for AEDT.
          * - :py:attr:`~current_version`
            - Current version of AEDT.
          * - :py:attr:`~project_name`
            - Project name.
          * - :py:attr:`~project_path`
            - Project path.
          * - :py:attr:`~project_file`
            - Project file.
          * - :py:attr:`~lock_file`
            - Lock file.
          * - :py:attr:`~results_directory`
            - Results directory.
          * - :py:attr:`~src_dir`
            - Source directory.
          * - :py:attr:`~pyaedt_dir`
            - PyAEDT directory.
          * - :py:attr:`~oproject`
            - Project.
          * - :py:attr:`~icepak`
            - 
          * - :py:attr:`~file_dir`
            - Directory path of the open project.
          * - :py:attr:`~file_path`
            - Path of the open project file.







Import detail
-------------

.. code-block:: python

    from pyedb.siwave import Siwave

Property detail
---------------

.. py:property:: version

.. py:property:: version_keys

   
   Version keys for AEDT.
















   ..
       !! processed by numpydoc !!

.. py:property:: current_version

   
   Current version of AEDT.
















   ..
       !! processed by numpydoc !!

.. py:property:: project_name

   
   Project name.



   :Returns:

       :class:`python:str`
           Name of the project.













   ..
       !! processed by numpydoc !!

.. py:property:: project_path

   
   Project path.



   :Returns:

       :class:`python:str`
           Full absolute path for the project.













   ..
       !! processed by numpydoc !!

.. py:property:: project_file

   
   Project file.



   :Returns:

       :class:`python:str`
           Full absolute path and name for the project file.













   ..
       !! processed by numpydoc !!

.. py:property:: lock_file

   
   Lock file.



   :Returns:

       :class:`python:str`
           Full absolute path and name for the project lock file.













   ..
       !! processed by numpydoc !!

.. py:property:: results_directory

   
   Results directory.



   :Returns:

       :class:`python:str`
           Full absolute path to the ``aedtresults`` directory.













   ..
       !! processed by numpydoc !!

.. py:property:: src_dir

   
   Source directory.



   :Returns:

       :class:`python:str`
           Full absolute path to the ``python`` directory.













   ..
       !! processed by numpydoc !!

.. py:property:: pyaedt_dir

   
   PyAEDT directory.



   :Returns:

       :class:`python:str`
           Full absolute path to the ``pyaedt`` directory.













   ..
       !! processed by numpydoc !!

.. py:property:: oproject

   
   Project.
















   ..
       !! processed by numpydoc !!

.. py:property:: icepak

.. py:property:: file_dir
   :type: str


   
   Directory path of the open project.
















   ..
       !! processed by numpydoc !!

.. py:property:: file_path
   :type: str


   
   Path of the open project file.
















   ..
       !! processed by numpydoc !!




Method detail
-------------

.. py:method:: open_project(proj_path=None)

   
   Open a project.


   :Parameters:

       **proj_path** : :class:`python:str`, :obj:`optional`
           Full path to the project. The default is ``None``.

   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` when successful, ``False`` when failed.













   ..
       !! processed by numpydoc !!

.. py:method:: save_project(projectpath=None, projectName=None)

   
   Save the project.


   :Parameters:

       **proj_path** : :class:`python:str`, :obj:`optional`
           Full path to the project. The default is ``None``.

       **projectName** : :class:`python:str`, :obj:`optional`
           Name of the project. The default is ``None``.

   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` when successful, ``False`` when failed.













   ..
       !! processed by numpydoc !!

.. py:method:: save(file_path: Optional[Union[str, pathlib.Path]])

   
   Save the project.


   :Parameters:

       **file_path** : :class:`python:str`, :obj:`optional`
           Full path to the project. The default is ``None``.














   ..
       !! processed by numpydoc !!

.. py:method:: close_project(save_project=False)

   
   Close the project.


   :Parameters:

       **save_project** : :ref:`bool <python:bltin-boolean-values>`, :obj:`optional`
           Whether to save the current project before closing it. The default is ``False``.

   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` when successful, ``False`` when failed.













   ..
       !! processed by numpydoc !!

.. py:method:: quit_application()

   
   Quit the application.



   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` when successful, ``False`` when failed.













   ..
       !! processed by numpydoc !!

.. py:method:: export_element_data(simulation_name, file_path, data_type='Vias')

   
   Export element data.


   :Parameters:

       **simulation_name** : :class:`python:str`
           Name of the setup.

       **file_path** : :class:`python:str`
           Path to the exported report.

       **data_type** : :class:`python:str`, :obj:`optional`
           Type of the data. The default is ``"Vias"``.

   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` when successful, ``False`` when failed.













   ..
       !! processed by numpydoc !!

.. py:method:: export_siwave_report(simulation_name, file_path, bkground_color='White')

   
   Export the Siwave report.


   :Parameters:

       **simulation_name** : :class:`python:str`
           Name of the setup.

       **file_path** : :class:`python:str`
           Path to the exported report.

       **bkground_color** : :class:`python:str`, :obj:`optional`
           Color of the report's background. The default is ``"White"``.

   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` when successful, ``False`` when failed.













   ..
       !! processed by numpydoc !!

.. py:method:: export_dc_simulation_report(simulation_name, file_path, background_color='White')

   
   Export the Siwave DC simulation report.


   :Parameters:

       **simulation_name** : :class:`python:str`
           Name of the setup.

       **file_path** : :class:`python:str`
           Path to the exported report.

       **background_color** : :class:`python:str`, :obj:`optional`
           Color of the report's background. The default is ``"White"``.

   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` when successful, ``False`` when failed.













   ..
       !! processed by numpydoc !!

.. py:method:: run_dc_simulation(export_dc_power_data_to_icepak=False)

   
   Run DC simulation.
















   ..
       !! processed by numpydoc !!

.. py:method:: export_icepak_project(file_path, dc_simulation_name)

   
   Exports an Icepak project for standalone use.


   :Parameters:

       **file_path** : str,
           Path of the Icepak project.

       **dc_simulation_name** : :class:`python:str`
           Name of the DC simulation.

   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` when successful, ``False`` when failed.













   ..
       !! processed by numpydoc !!

.. py:method:: run_icepak_simulation(icepak_simulation_name, dc_simulation_name)

   
   Runs an Icepak simulation.


   :Parameters:

       **icepak_simulation_name** : :class:`python:str`
           Name of the Icepak simulation.

       **dc_simulation_name** : :class:`python:str`
           Name of the DC simulation.

   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` when successful, ``False`` when failed.













   ..
       !! processed by numpydoc !!

.. py:method:: export_edb(file_path: str)

   
   Export the layout as EDB.


   :Parameters:

       **file_path** : :class:`python:str`
           Path to the EDB.

   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ..













   ..
       !! processed by numpydoc !!

.. py:method:: import_edb(file_path: str)

   
   Import layout from EDB.


   :Parameters:

       **file_path** : :obj:`Str`
           Path to the EDB file.

       **Returns**
           ..

       **-------**
           ..

       **bool**
           ..














   ..
       !! processed by numpydoc !!

.. py:method:: load_configuration(file_path: str)

   
   Load configuration settings from a configure file.Import


   :Parameters:

       **file_path** : :class:`python:str`
           Path to the configuration file.














   ..
       !! processed by numpydoc !!

.. py:method:: export_configuration(file_path: str, fix_padstack_names: bool = False)

   
   Export layout information into a configuration file.


   :Parameters:

       **file_path** : :class:`python:str`
           Path to the configuration file.

       **fix_padstack_names** : :ref:`bool <python:bltin-boolean-values>`
           Name all the padstacks in edb.














   ..
       !! processed by numpydoc !!