Skip to content

Commit 66afb93

Browse files
doc port type (#410)
Co-authored-by: Samuel Lopez <[email protected]>
1 parent 9f8cb35 commit 66afb93

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

examples/edb/use_configuration/import_ports.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,11 @@
5050
#
5151
# - **name**. Name of the port.
5252
# - **Reference_designator**. Reference designator of the component.
53-
# - **type**. Type of the port. Supported types are 'circuit', 'coax'
54-
# - **positive_terminal**. Positive terminal of the port. Supported types are 'net', 'pin', 'pin_group', 'coordinates'
53+
# - **type**. Type of the port. Supported types are 'circuit', 'coax', 'gap_port', 'wave_port', 'diff_wave_port'.
54+
# - **impedance**. Impedance of the port. Default is 50 Ohm.
55+
# - **positive_terminal**. Positive terminal of the port. Supported types are 'net', 'pin', 'pin_group', 'coordinates'.
5556
# - **negative_terminal**. Negative terminal of the port. Supported types are 'net', 'pin', 'pin_group', 'coordinates',
56-
# 'nearest_pin'
57+
# 'nearest_pin'.
5758

5859
port_1 = {
5960
"name": "port_1",

examples/edb/use_configuration/import_sources.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,10 @@
5050
# - **name**. Name of the voltage source.
5151
# - **Reference_designator**. Reference designator of the component.
5252
# - **type**. Type of the source. Supported types are 'voltage', 'current'
53+
# - **impedance**. Impedance of the port. Default is 5e7 Ohm for current sources, 1e-6 Ohm for voltage sources.
5354
# - **positive_terminal**. Supported types are 'net', 'pin', 'pin_group', 'coordinates'
5455
# - **contact_radius**. Optional. Set circular equipotential region.
55-
# - **inline**. Optional. When True, contact points are place in a row.
56+
# - **inline**. Optional. When True, contact points are placed in a row.
5657
# - **num_of_contact**. Optional. Number of contact points. Default is 1. Applicable only when inline is True.
5758
# - **negative_terminal**. Supported types are 'net', 'pin', 'pin_group', 'coordinates'
5859
# - **equipotential**. Set equipotential region on pins when True.
@@ -150,7 +151,7 @@
150151
sources_distributed,
151152
]
152153

153-
# ## Write configuration into as json file
154+
# ## Write configuration into as JSON file
154155

155156
file_json = Path(temp_folder.name) / "edb_configuration.json"
156157
with open(file_json, "w") as f:
@@ -169,7 +170,7 @@
169170

170171
# ## Review
171172

172-
edbapp.siwave.sources
173+
print(edbapp.siwave.sources)
173174

174175
# ## Save and close Edb
175176
# The temporary folder will be deleted once the execution of this script is finished. Replace **edbapp.save()** with

0 commit comments

Comments
 (0)