Skip to content

refactored name from legacy to dotnet #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 18, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/source/api/ComponentsEdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The main component object is called directly from main application using the pro
...


.. currentmodule:: pyedb.legacy.edb_core.components
.. currentmodule:: pyedb.dotnet.edb_core.components

.. autosummary::
:toctree: _autosummary
Expand All @@ -28,7 +28,7 @@ Instances and definitions
These classes are the containers of data management for components reference designator and definitions.


.. currentmodule:: pyedb.legacy.edb_core.edb_data.components_data
.. currentmodule:: pyedb.dotnet.edb_core.edb_data.components_data

.. autosummary::
:toctree: _autosummary
Expand All @@ -41,9 +41,9 @@ These classes are the containers of data management for components reference des

.. code:: python

from pyedb.legacy.edb import EdbLegacy
from pyedb.dotnet import Edb

edb = EdbLegacy(myedb, edbversion="2023.1")
edb = Edb(myedb, edbversion="2023.1")

comp = edb.components["C1"]

Expand Down
16 changes: 8 additions & 8 deletions doc/source/api/CoreEdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ It can be opened and edited using the ``Edb`` class.
.. autosummary::
:toctree: _autosummary

pyedb.legacy.edb.EdbLegacy
pyedb.legacy.edb_core.edb_data.variables.Variable
pyedb.legacy.edb_core.edb_data.edbvalue.EdbValue
pyedb.dotnet.edb.Edb
pyedb.dotnet.edb_core.edb_data.variables.Variable
pyedb.dotnet.edb_core.edb_data.edbvalue.EdbValue


.. code:: python

from pyedb.legacy.edb import EdbLegacy
from pyedb.dotnet import Edb

# this call returns the Edb class initialized on 2023 R1
edb = EdbLegacy(myedb, edbversion="2023.1")
edb = Edb(myedb, edbversion="2023.1")

...

Expand All @@ -33,7 +33,7 @@ This section lists the core EDB modules for reading and writing information
to AEDB files.


.. currentmodule:: pyedb.legacy.edb_core
.. currentmodule:: pyedb.dotnet.edb_core

.. autosummary::
:toctree: _autosummary
Expand All @@ -46,7 +46,7 @@ to AEDB files.



.. currentmodule:: pyedb.legacy.edb_core.edb_data.edbvalue
.. currentmodule:: pyedb.dotnet.edb_core.edb_data.edbvalue

.. autosummary::
:toctree: _autosummary
Expand All @@ -58,7 +58,7 @@ to AEDB files.

.. code:: python

from pyedb.legacy.edb_core.edb import Edb
from pyedb.dotnet import Edb

edb = Edb(myedb, edbversion="2023.1")

Expand Down
6 changes: 3 additions & 3 deletions doc/source/api/LayerData.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ These classes are the containers of the layer and stackup manager of the EDB API

.. code:: python

from pyedb.legacy.edb_core.edb import Edb
from pyedb.dotnet import Edb

edb = Edb(myedb, edbversion="2023.1")

Expand All @@ -17,7 +17,7 @@ These classes are the containers of the layer and stackup manager of the EDB API
...


.. currentmodule:: pyedb.legacy.edb_core.stackup
.. currentmodule:: pyedb.dotnet.edb_core.stackup

.. autosummary::
:toctree: _autosummary
Expand All @@ -26,7 +26,7 @@ These classes are the containers of the layer and stackup manager of the EDB API
Stackup


.. currentmodule:: pyedb.legacy.edb_core.edb_data.layer_data
.. currentmodule:: pyedb.dotnet.edb_core.edb_data.layer_data

.. autosummary::
:toctree: _autosummary
Expand Down
8 changes: 4 additions & 4 deletions doc/source/api/NetsEdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The main component object is called directly from main application using the pro

.. code:: python

from pyedb.legacy.edb_core.edb import Edb
from pyedb.dotnet import Edb

edb = Edb(myedb, edbversion="2023.1")

Expand All @@ -14,7 +14,7 @@ The main component object is called directly from main application using the pro
...


.. currentmodule:: pyedb.legacy.edb_core.nets
.. currentmodule:: pyedb.dotnet.edb_core.nets

.. autosummary::
:toctree: _autosummary
Expand All @@ -28,7 +28,7 @@ Net properties
The following class is the container of data management for nets, extended nets and differential pairs.


.. currentmodule:: pyedb.legacy.edb_core.edb_data.nets_data
.. currentmodule:: pyedb.dotnet.edb_core.edb_data.nets_data

.. autosummary::
:toctree: _autosummary
Expand All @@ -41,7 +41,7 @@ The following class is the container of data management for nets, extended nets

.. code:: python

from pyedb.legacy.edb_core.edb import Edb
from pyedb.dotnet import Edb

edb = Edb(myedb, edbversion="2023.1")

Expand Down
6 changes: 3 additions & 3 deletions doc/source/api/PadstackEdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The main padstack object is called directly from main application using the prop

.. code:: python

from pyedb.legacy.edb_core.edb import Edb
from pyedb.dotnet import Edb

edb = Edb(myedb, edbversion="2023.1")

Expand All @@ -20,7 +20,7 @@ The main padstack object is called directly from main application using the prop
...


.. currentmodule:: pyedb.legacy.edb_core.padstack
.. currentmodule:: pyedb.dotnet.edb_core.padstack

.. autosummary::
:toctree: _autosummary
Expand All @@ -34,7 +34,7 @@ Instances and definitions
These classes are the containers of data management for padstacks instances and padstack definitions.


.. currentmodule:: pyedb.legacy.edb_core.edb_data.padstacks_data
.. currentmodule:: pyedb.dotnet.edb_core.edb_data.padstacks_data

.. autosummary::
:toctree: _autosummary
Expand Down
4 changes: 2 additions & 2 deletions doc/source/api/PortsEdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ These classes are the containers of ports methods of the EDB for both HFSS and S

.. code:: python

from pyedb.legacy.edb_core.edb import Edb
from pyedb.dotnet import Edb

edb = Edb(myedb, edbversion="2023.1")

Expand All @@ -16,7 +16,7 @@ These classes are the containers of ports methods of the EDB for both HFSS and S
...


.. currentmodule:: pyedb.legacy.edb_core.edb_data.ports
.. currentmodule:: pyedb.dotnet.edb_core.edb_data.ports

.. autosummary::
:toctree: _autosummary
Expand Down
8 changes: 4 additions & 4 deletions doc/source/api/PrimitivesEdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Primitives are planes, lines, rectangles, and circles.

.. code:: python

from pyedb.legacy.edb_core.edb import Edb
from pyedb.dotnet import Edb

edb = Edb(myedb, edbversion="2023.1")

Expand All @@ -16,7 +16,7 @@ Primitives are planes, lines, rectangles, and circles.

...

.. currentmodule:: pyedb.legacy.edb_core.layout
.. currentmodule:: pyedb.dotnet.edb_core.layout

.. autosummary::
:toctree: _autosummary
Expand All @@ -30,7 +30,7 @@ Primitives properties
---------------------
These classes are the containers of data management for primitives and arcs.

.. currentmodule:: pyedb.legacy.edb_core.edb_data.primitives_data
.. currentmodule:: pyedb.dotnet.edb_core.edb_data.primitives_data

.. autosummary::
:toctree: _autosummary
Expand All @@ -43,7 +43,7 @@ These classes are the containers of data management for primitives and arcs.

.. code:: python

from pyedb.legacy.edb_core.edb import Edb
from pyedb.dotnet import Edb

edb = Edb(myedb, edbversion="2023.1")

Expand Down
4 changes: 2 additions & 2 deletions doc/source/api/SiWave.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ accessed from PyEDB in Windows only. All setups can be implemented through EDB A
:target: https://www.ansys.com/products/electronics/ansys-siwave


.. currentmodule:: pyedb.legacy.edb_core
.. currentmodule:: pyedb.dotnet.edb_core

.. autosummary::
:toctree: _autosummary
Expand All @@ -21,7 +21,7 @@ accessed from PyEDB in Windows only. All setups can be implemented through EDB A

.. code:: python

from pyedb.legacy.edb_core.siwave import EdbSiwave
from pyedb.dotnet.edb_core.siwave import EdbSiwave

# this call returns the Edb class initialized on 2023 R1
siwave = EdbSiwave(specified_version="2023.1")
Expand Down
4 changes: 2 additions & 2 deletions doc/source/api/SimulationConfigurationEdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Simulation configuration
These classes are the containers of simulation configuration constructors for the EDB.


.. currentmodule:: pyedb.legacy.edb_core.edb_data.simulation_configuration
.. currentmodule:: pyedb.dotnet.edb_core.edb_data.simulation_configuration

.. autosummary::
:toctree: _autosummary
Expand All @@ -18,7 +18,7 @@ These classes are the containers of simulation configuration constructors for th

.. code:: python

from pyedb.legacy.edb_core.edb import Edb
from pyedb.dotnet import Edb

edbapp = Edb(myedb, edbversion="2023.1")

Expand Down
4 changes: 2 additions & 2 deletions doc/source/api/SimulationEdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ These classes are the containers of ``setup`` classes in EDB for both HFSS and S

.. code:: python

from pyedb.legacy.edb_core.edb import Edb
from pyedb.dotnet import Edb

edb = Edb(myedb, edbversion="2023.1")

Expand All @@ -20,7 +20,7 @@ These classes are the containers of ``setup`` classes in EDB for both HFSS and S



.. currentmodule:: pyedb.legacy.edb_core.edb_data
.. currentmodule:: pyedb.dotnet.edb_core.edb_data

.. autosummary::
:toctree: _autosummary
Expand Down
4 changes: 2 additions & 2 deletions doc/source/api/SourcesEdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ These classes are the containers of sources methods of the EDB for both HFSS and

.. code:: python

from pyedb.legacy.edb_core.edb import Edb
from pyedb.dotnet import Edb

edb = Edb(myedb, edbversion="2023.1")

Expand All @@ -14,7 +14,7 @@ These classes are the containers of sources methods of the EDB for both HFSS and
...


.. currentmodule:: pyedb.legacy.edb_core.edb_data.sources
.. currentmodule:: pyedb.dotnet.edb_core.edb_data.sources

.. autosummary::
:toctree: _autosummary
Expand Down
2 changes: 1 addition & 1 deletion doc/source/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Example:

.. code:: python

from pyedb import Edb
from pyedb.dotnet import Edb

edb = Edb("my_project.aedb", edbversion="2023.1")
edb.core_components.components["R1"].r_value = 40
Expand Down
8 changes: 4 additions & 4 deletions doc/source/getting_started/quickcode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,20 +43,20 @@ Explicit PyEDB declaration and error management

# Start EDB

from pyedb.legacy.edb_core.edb import EdbLegacy
from pyedb.dotnet import Edb

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


Variables
~~~~~~~~~

.. code:: python

from pyedb.legacy.edb_core.edb import EdbLegacy
from pyedb.dotnet import Edb

edb_file = pyedb.layout_examples.ANSYS - HSD_V1.aedb
edb = EdbLegacy(edbversion="2023.2", edbpath=edb_file)
edb = Edb(edbversion="2023.2", edbpath=edb_file)
edb["dim"] = "1mm" # design variable
edb["$dim"] = "1mm" # project variable
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This section describes how to create SYZ simulation setup for Siwave using Simul



from pyedb.legacy.edb_core.edb import EdbLegacy
from pyedb.dotnet import Edb
from pyedb.generic.constants import SolverType
from pyedb.generic.general_methods import generate_unique_folder_name
import pyedb.misc.downloads as downloads
Expand All @@ -24,7 +24,7 @@ This section describes how to create SYZ simulation setup for Siwave using Simul
)

# loading EDB
edbapp = EdbLegacy(edbpath=targetfile, edbversion="2023.2")
edbapp = Edb(edbpath=targetfile, edbversion="2023.2")

simconfig = edbapp.new_simulation_configuration()
simconfig.solver_type = SolverType.SiwaveSYZ
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This section shows a simple example to create HFSS coaxial port on a component.
.. code:: python


from pyedb.legacy.edb import EdbLegacy
from pyedb.dotnet import Edb
from pyedb.generic.general_methods import generate_unique_folder_name
import pyedb.misc.downloads as downloads

Expand All @@ -20,7 +20,7 @@ This section shows a simple example to create HFSS coaxial port on a component.
targetfile = downloads.download_file("edb/ANSYS-HSD_V1.aedb", destination=temp_folder)

# loading EDB
edbapp = EdbLegacy(edbpath=targetfile, edbversion="2023.2")
edbapp = Edb(edbpath=targetfile, edbversion="2023.2")

sim_setup = edbapp.new_simulation_configuration()
sim_setup.signal_nets = [
Expand Down
4 changes: 2 additions & 2 deletions doc/source/user_guide/build_simulation_project/cutout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ how to clip a design based on nets selection.



from pyedb.legacy.edb import EdbLegacy
from pyedb.dotnet import Edb
from pyedb.generic.general_methods import generate_unique_folder_name
import pyedb.misc.downloads as downloads

Expand All @@ -24,7 +24,7 @@ how to clip a design based on nets selection.
targetfile = downloads.download_file("edb/ANSYS-HSD_V1.aedb", destination=temp_folder)

# loading EDB
edbapp = EdbLegacy(edbpath=targetfile, edbversion="2023.2")
edbapp = Edb(edbpath=targetfile, edbversion="2023.2")

# selecting signal nets to evaluate the extent for clipping the layout
signal_nets = [
Expand Down
4 changes: 2 additions & 2 deletions doc/source/user_guide/components/create_resistor_on_pin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ This section describes how to create resistor on pins:



from pyedb.legacy.edb import EdbLegacy
from pyedb.dotnet 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 = EdbLegacy(edbpath=targetfile, edbversion="2023.2")
edbapp = Edb(edbpath=targetfile, edbversion="2023.2")

pins = edbapp.components.get_pin_from_component("U1")
resistor = edbapp.siwave.create_resistor_on_pin(pins[302], pins[10], 40, "RST4000")
Expand Down
Loading