ansys-api-edb 0.2.dev0__tar.gz

ansys_api_edb-0.2.dev0/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ANSYS, Inc. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ansys_api_edb-0.2.dev0/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.2
+Name: ansys-api-edb
+Version: 0.2.dev0
+Summary: Autogenerated Python gRPC interface package for ansys-api-edb, built on 19:16:10 on 28 February 2025
+Home-page: https://github.com/ansys/ansys-api-edb
+Author: ANSYS, Inc.
+Author-email: pyansys.core@ansys.com
+Maintainer: ANSYS, Inc.
+Maintainer-email: pyansys.core@ansys.com
+License: MIT
+Project-URL: Documentation, https://github.com/ansys/ansys-api-edb/#readme
+Project-URL: Source, https://github.com/ansys/ansys-api-edb/
+Project-URL: Tracker, https://github.com/ansys/ansys-api-edb/issues/
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENCE
+Requires-Dist: grpcio>=1.44
+Requires-Dist: protobuf<5,>=3.19.3
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+### ansys-api-edb gRPC Interface Package
+
+This repository provides the auto-generated gRPC Python interface files for
+the Ansys Edb Service.
+
+
+#### Installation
+
+Provided that these wheels have been published to public PyPI, they can be
+installed with:
+
+```
+pip install ansys-api-edb
+```
+
+#### Build
+
+To build the gRPC packages, run:
+
+```
+pip install build
+python -m build
+```
+
+This will create both the source distribution containing just the protofiles
+along with the wheel containing the protofiles and build Python interface
+files.

ansys_api_edb-0.2.dev0/README.md

@@ -0,0 +1,27 @@
+### ansys-api-edb gRPC Interface Package
+
+This repository provides the auto-generated gRPC Python interface files for
+the Ansys Edb Service.
+
+
+#### Installation
+
+Provided that these wheels have been published to public PyPI, they can be
+installed with:
+
+```
+pip install ansys-api-edb
+```
+
+#### Build
+
+To build the gRPC packages, run:
+
+```
+pip install build
+python -m build
+```
+
+This will create both the source distribution containing just the protofiles
+along with the wheel containing the protofiles and build Python interface
+files.

ansys_api_edb-0.2.dev0/ansys/api/edb/VERSION

@@ -0,0 +1 @@
+0.2.dev0

ansys_api_edb-0.2.dev0/ansys/api/edb/__init__.py

@@ -0,0 +1,8 @@
+"""Autogenerated Python gRPC interface package for ansys-api-edb."""
+
+import pathlib
+
+__all__ = ["__version__"]
+
+with open(pathlib.Path(__file__).parent / "VERSION", encoding="utf-8") as f:
+    __version__ = f.read().strip()

ansys_api_edb-0.2.dev0/ansys/api/edb/v1/arc_data.proto

@@ -0,0 +1,67 @@
+// Proto file representing the EDB Arc Data class
+
+syntax = "proto3";
+
+package ansys.api.edb.v1;
+
+import "ansys/api/edb/v1/edb_messages.proto";
+import "ansys/api/edb/v1/point_data.proto";
+
+enum RotationDirection {
+  ROTATION_DIRECTION_CCW = 0;
+  ROTATION_DIRECTION_CW = 1;
+  ROTATION_DIRECTION_COLINEAR = 2;
+}
+
+service ArcDataService {
+  // Get height of an arc
+  rpc GetHeight (ArcMessage) returns (google.protobuf.FloatValue) {}
+
+  // Get center point of an arc
+  rpc GetCenter (ArcMessage) returns (PointMessage) {}
+
+  // Get midpoint of an arc
+  rpc GetMidpoint (ArcMessage) returns (PointMessage) {}
+
+  // Get radius of an arc
+  rpc GetRadius (ArcMessage) returns (google.protobuf.FloatValue) {}
+
+  // Get bounding box of an arc
+  rpc GetBoundingBox (ArcMessage) returns (BoxMessage) {}
+
+  // Get angle between two arcs.
+  rpc GetAngle (ArcMessage) returns (google.protobuf.FloatValue) {}
+
+  // Get closest points between two arcs.
+  rpc ClosestPoints (ArcDataTwoArcsMessage) returns (BoxMessage) {}
+}
+
+message ArcMessage {
+  message RadiusMessage {
+    double radius = 1;
+	RotationDirection dir = 2;
+	bool is_big = 3;
+  }
+  message CenterMessage {
+    PointMessage point = 1;
+	RotationDirection dir = 2;
+  }
+
+  PointMessage start = 1;
+  PointMessage end = 2;
+  oneof option {
+    google.protobuf.FloatValue height = 3;
+    PointMessage thru = 4;
+	RadiusMessage radius = 5;
+	CenterMessage center = 6;
+  }
+}
+
+message ArcDataTwoArcsMessage {
+  ArcMessage arc1 = 1;
+  ArcMessage arc2 = 2;
+}
+
+message ArcsMessage {
+  repeated ArcMessage items = 1;
+}

ansys_api_edb-0.2.dev0/ansys/api/edb/v1/board_bend_def.proto

@@ -0,0 +1,37 @@
+// Proto file representing the BoardBendDef class
+
+syntax = "proto3";
+
+package ansys.api.edb.v1;
+
+import "ansys/api/edb/v1/edb_messages.proto";
+import "ansys/api/edb/v1/point_data.proto";
+import "ansys/api/edb/v1/polygon_data.proto";
+
+service BoardBendDefService {
+  rpc Create (BoardBendDefCreateMessage) returns (EDBObjMessage) {}
+
+  rpc GetBoundaryPrim (EDBObjMessage) returns (EDBObjMessage) {}
+
+  rpc GetBendMiddle (EDBObjMessage) returns (PointPairMessage) {}
+
+  rpc SetBendMiddle (PointPairPropertyMessage) returns (google.protobuf.Empty) {}
+
+  rpc GetRadius (EDBObjMessage) returns (ValueMessage) {}
+
+  rpc SetRadius (ValuePropertyMessage) returns (google.protobuf.Empty) {}
+
+  rpc GetAngle (EDBObjMessage) returns (ValueMessage) {}
+
+  rpc SetAngle (ValuePropertyMessage) returns (google.protobuf.Empty) {}
+
+  rpc GetBentRegions (EDBObjMessage) returns (PolygonDataListMessage) {}
+}
+
+message BoardBendDefCreateMessage {
+  EDBObjMessage layout = 1;
+  EDBObjMessage zone_prim = 2;
+  PointPairMessage middle = 3;
+  ValueMessage radius = 4;
+  ValueMessage angle = 5;
+}

ansys_api_edb-0.2.dev0/ansys/api/edb/v1/bondwire.proto

@@ -0,0 +1,165 @@
+// Proto file representing the EDB Circle class
+
+syntax = "proto3";
+
+package ansys.api.edb.v1;
+
+import "ansys/api/edb/v1/edb_messages.proto";
+import "ansys/api/edb/v1/refs.proto";
+
+enum BondwireType {
+  APD_BONDWIRE = 0;
+  JEDEC4_BONDWIRE = 1;
+  JEDEC5_BONDWIRE = 2;
+  NUM_OF_BONDWIRE_TYPE = 3;
+  INVALID_BONDWIRE_TYPE = -1;
+}
+
+enum BondwireCrossSectionType {
+  BONDWIRE_ROUND = 0;
+  BONDWIRE_RECTANGLE = 1;
+  INVALID_BONDWIRE_CROSS_SECTION_TYPE = -1;
+}
+
+// Bondwire service definition
+service BondwireService {
+  // Create Bondwire
+  rpc Create (BondwireCreateMessage) returns (EDBObjMessage) {}
+
+  // Get Material
+  rpc GetMaterial (BondwireBoolMessage) returns (google.protobuf.StringValue) {}
+
+  // Set Material
+  rpc SetMaterial (SetMaterialMessage) returns (google.protobuf.Empty) {}
+
+  // Get Bondwire Type
+  rpc GetType (EDBObjMessage) returns (BondwireTypeMessage) {}
+
+  // Set Bondwire Type
+  rpc SetType (SetBondwireTypeMessage) returns (google.protobuf.Empty) {}
+
+  // Get Cross Section Type
+  rpc GetCrossSectionType (EDBObjMessage) returns (GetCrossSectionTypeMessage) {}
+
+  // Set Type
+  rpc SetCrossSectionType (SetCrossSectionTypeMessage) returns (google.protobuf.Empty) {}
+
+  // Get Cross Section Type
+  rpc GetCrossSectionHeight (EDBObjMessage) returns (ValueMessage) {}
+
+  // Set Type
+  rpc SetCrossSectionHeight (SetCrossSectionHeightMessage) returns (google.protobuf.Empty) {}
+
+  // Get Bondwire Definition Name
+  rpc GetDefinitionName (BondwireBoolMessage) returns (google.protobuf.StringValue) {}
+  
+  // Set Bondwire Definition Name
+  rpc SetDefinitionName (SetDefinitionNameMessage) returns (google.protobuf.Empty) {}
+  
+  // Get Start Elevation Layer
+  rpc GetStartElevation (GetElevationMessage) returns (EDBObjMessage) {}
+  
+  // Set Start Elevation Layer
+  rpc SetStartElevation (SetElevationMessage) returns (google.protobuf.Empty) {}
+  
+  // Get End Elevation Layer
+  rpc GetEndElevation (GetElevationMessage) returns (EDBObjMessage) {}
+  
+  // Set End Elevation Layer
+  rpc SetEndElevation (SetElevationMessage) returns (google.protobuf.Empty) {}
+  
+  // Get Trajectory Values
+  rpc GetTraj (EDBObjMessage) returns (BondwireTrajMessage) {}
+  
+  // Set Trajectory Values
+  rpc SetTraj (SetBondwireTrajMessage) returns (google.protobuf.Empty) {}
+  
+  // Get Width Value
+  rpc GetWidthValue (EDBObjMessage) returns (ValueMessage) {}
+  
+  // Get Width Value
+  rpc SetWidthValue (BondwireValueMessage) returns (google.protobuf.Empty) {} 
+}
+
+message BondwireCreateMessage {
+  EDBObjMessage layout = 1;
+  NetRefMessage net = 2;
+  BondwireType bondwire_type = 3;
+  string definition_name = 4;
+  string placement_layer = 5;
+  ValueMessage width = 6;
+  string material = 7;
+  EDBObjMessage start_context = 8;
+  string start_layer_name = 9;
+  ValueMessage start_x = 10;
+  ValueMessage start_y = 11;
+  EDBObjMessage end_context = 12;
+  string end_layer_name = 13;
+  ValueMessage end_x = 14;
+  ValueMessage end_y = 15;
+}
+
+message BondwireBoolMessage {
+  EDBObjMessage target = 1;
+  bool evaluated = 2;
+}
+
+message SetMaterialMessage {
+  EDBObjMessage target = 1;
+  string material = 2;
+}
+
+message BondwireTypeMessage {
+  BondwireType type = 1;
+}
+
+message SetBondwireTypeMessage {
+  EDBObjMessage target = 1;
+  BondwireType type = 2;
+}
+
+message GetCrossSectionTypeMessage {
+  BondwireCrossSectionType type = 1;
+}
+
+message SetCrossSectionTypeMessage {
+  EDBObjMessage target = 1;
+  BondwireCrossSectionType type = 2;
+}
+
+message SetCrossSectionHeightMessage {
+  EDBObjMessage target = 1;
+  ValueMessage height = 2;
+}
+
+message SetDefinitionNameMessage {
+  EDBObjMessage target = 1;
+  string definition_name = 2;
+}
+
+message GetElevationMessage {
+  EDBObjMessage bw = 1;
+  EDBObjMessage cell_instance = 2;
+}
+
+message SetElevationMessage {
+  GetElevationMessage target = 1;
+  string lyrname = 2;
+}
+
+message BondwireValueMessage {
+  EDBObjMessage target = 1;
+  ValueMessage value = 2;
+}
+
+message BondwireTrajMessage {
+  ValueMessage x1 = 1;
+  ValueMessage y1 = 2;
+  ValueMessage x2 = 3;
+  ValueMessage y2 = 4;
+}
+
+message SetBondwireTrajMessage {
+  EDBObjMessage target = 1;
+  BondwireTrajMessage traj = 2;
+}

ansys_api_edb-0.2.dev0/ansys/api/edb/v1/bondwire_def.proto

@@ -0,0 +1,89 @@
+// Proto file representing the EDB Circle class
+
+syntax = "proto3";
+
+package ansys.api.edb.v1;
+
+import "ansys/api/edb/v1/edb_messages.proto";
+
+enum BondwireDefType {
+  APD_BONDWIRE_DEF = 0;
+  JEDEC4_BONDWIRE_DEF = 1;
+  JEDEC5_BONDWIRE_DEF = 2;
+}
+
+// BondwireDef service definition
+service BondwireDefService {
+  // Delete BondwireDef.
+  rpc Delete (EDBObjMessage) returns (google.protobuf.Empty) {}
+
+  // Get the name of the BondwireDef.
+  rpc GetName (EDBObjMessage) returns (google.protobuf.StringValue) {}
+}
+
+message BondwireDefStrMessage{
+  EDBObjMessage object = 1;
+  string name = 2;
+}
+
+// Apd BondwireDef service definition
+service ApdBondwireDefService {
+  // Creates an Apd BondwireDef.
+  rpc Create (BondwireDefStrMessage) returns (EDBObjMessage) {}
+
+  // Loads Definitions From File.
+  rpc LoadDefinitionsFromFile (BondwireDefStrMessage) returns (google.protobuf.Empty) {}
+
+  // Find Apd BondwireDef By Name.
+  rpc FindByName (BondwireDefStrMessage) returns (EDBObjMessage) {}
+  
+  // Get Apd BondwireDef parameters in cblock string format.
+  rpc GetParameters (EDBObjMessage) returns (google.protobuf.StringValue) {}
+
+  // Set Apd BondwireDef parameters by passing cblock string.
+  rpc SetParameters (BondwireDefStrMessage) returns (google.protobuf.Empty) {}
+}
+
+service Jedec4BondwireDefService {
+  // Creates an Jedec4BondwireDef.
+  rpc Create (BondwireDefStrMessage) returns (EDBObjMessage) {}
+  
+  // Find Jedec4BondwireDef By Name.
+  rpc FindByName (BondwireDefStrMessage) returns (EDBObjMessage) {}
+  
+  // Get Jedec4BondwireDef parameters in cblock string format.
+  rpc GetParameters (EDBObjMessage) returns (ValueMessage) {}
+  
+  // Set Jedec4BondwireDef parameters by passing cblock string.
+  rpc SetParameters (Jedec4BondwireDefSetParametersMessage) returns (google.protobuf.Empty) {}
+}
+
+message Jedec4BondwireDefSetParametersMessage{
+  EDBObjMessage target = 1;
+  ValueMessage top_to_die_distance = 2;
+}
+
+service Jedec5BondwireDefService {
+  // Creates an Jedec5BondwireDef.
+  rpc Create (BondwireDefStrMessage) returns (EDBObjMessage) {}
+  
+  // Find Jedec5BondwireDef By Name.
+  rpc FindByName (BondwireDefStrMessage) returns (EDBObjMessage) {}
+  
+  // Get Jedec5BondwireDef parameters in cblock string format.
+  rpc GetParameters (EDBObjMessage) returns (Jedec5BondwireDefParametersMessage) {}
+  
+  // Set Jedec5BondwireDef parameters by passing cblock string.
+  rpc SetParameters (Jedec5BondwireDefSetParametersMessage) returns (google.protobuf.Empty) {}
+}
+
+message Jedec5BondwireDefParametersMessage{
+  ValueMessage top_to_die_distance = 1;
+  ValueMessage die_pad_angle = 2;
+  ValueMessage lead_pad_angle = 3;
+}
+
+message Jedec5BondwireDefSetParametersMessage{
+  EDBObjMessage target = 1;
+  Jedec5BondwireDefParametersMessage parameters = 2;
+}

ansys_api_edb-0.2.dev0/ansys/api/edb/v1/bundle_term.proto

@@ -0,0 +1,15 @@
+// Proto file representing the EDB BundleTerminal class
+
+syntax = "proto3";
+package ansys.api.edb.v1;
+
+import "ansys/api/edb/v1/edb_messages.proto";
+
+service BundleTerminalService {
+  rpc Create (EDBObjCollectionMessage) returns (EDBObjMessage) {}
+
+  rpc Ungroup (EDBObjMessage) returns (google.protobuf.Empty) {}
+
+  rpc GetTerminals (EDBObjMessage) returns (EDBObjCollectionMessage) {}
+  rpc StreamTerminals (EDBObjMessage) returns (stream EDBObjCollectionMessage) {}
+}

ansys_api_edb-0.2.dev0/ansys/api/edb/v1/cell.proto

@@ -0,0 +1,142 @@
+// Proto file representing the EDB Cell class
+
+syntax = "proto3";
+
+package ansys.api.edb.v1;
+
+import "ansys/api/edb/v1/edb_defs.proto";
+import "ansys/api/edb/v1/edb_messages.proto";
+import "ansys/api/edb/v1/polygon_data.proto";
+
+
+service CellService {
+  // Creates a cell
+  rpc Create (CellCreationMessage) returns (EDBObjMessage) {}
+
+  // Gets the layout of the provided cell
+  rpc GetLayout (EDBObjMessage) returns (EDBObjMessage) {}
+
+  // Get the flattened layout
+  rpc GetFlattenedLayout (EDBObjMessage) returns (EDBObjMessage) {}
+
+  // Find cell by name or id
+  rpc Find (CellFindMessage) returns (EDBObjMessage) {}
+
+  // Delete a cell
+  rpc Delete (EDBObjMessage) returns (google.protobuf.Empty) {}
+
+  // Get the database
+  rpc GetDatabase (EDBObjMessage) returns (EDBObjMessage) {}
+
+  // Get whether the cell is of type footprint
+  rpc IsFootprint (EDBObjMessage) returns (google.protobuf.BoolValue) {}
+
+  // Get whether the cell is a black box
+  rpc IsBlackBox (EDBObjMessage) returns (google.protobuf.BoolValue) {}
+
+  // Set whether the cell is a black box
+  rpc SetBlackBox (BoolPropertyMessage) returns (google.protobuf.Empty) {}
+
+  // Get whether the cell supresses pads
+  rpc GetSuppressPads (EDBObjMessage) returns (google.protobuf.BoolValue) {}
+
+  // Set whether the cell supresses pads
+  rpc SetSuppressPads (BoolPropertyMessage) returns (google.protobuf.Empty) {}
+
+  // Get whether the anti pads is always on
+  rpc GetAntiPadsAlwaysOn (EDBObjMessage) returns (google.protobuf.BoolValue) {}
+
+  // Set whether the anti pads is always on
+  rpc SetAntiPadsAlwaysOn (BoolPropertyMessage) returns (google.protobuf.Empty) {}
+
+  // Get the option for anti pads
+  rpc GetAntiPadsOption (EDBObjMessage) returns (google.protobuf.Int64Value) {}
+
+  // Set the option for anti pads
+  rpc SetAntiPadsOption (IntPropertyMessage) returns (google.protobuf.Empty) {}
+
+  // Get whether the cell is a symbolic footprint
+  rpc IsSymbolicFootprint (EDBObjMessage) returns (google.protobuf.BoolValue) {}
+
+  // Get the name of the cell
+  rpc GetName (EDBObjMessage) returns (google.protobuf.StringValue) {}
+
+  // Set the name of the cell
+  rpc SetName (StringPropertyMessage) returns (google.protobuf.Empty) {}
+
+  // Get the cell's design mode
+  rpc GetDesignMode (EDBObjMessage) returns (DesignModeMessage) {}
+
+  // Set the cell's design mode
+  rpc SetDesignMode (DesignModePropertyMessage) returns (google.protobuf.Empty) {}
+
+  // Get HFSS extent info
+  rpc GetHfssExtentInfo (EDBObjMessage) returns (HfssExtentInfoMessage) {}
+
+  // Set HFSS extent info
+  rpc SetHfssExtentInfo (CellSetHfssExtentsMessage) returns (google.protobuf.Empty) {}
+
+  // Get temperature settings
+  rpc GetTemperatureSettings (EDBObjMessage) returns (TemperatureSettingsMessage) {}
+
+  // Set temperature settings
+  rpc SetTemperatureSettings (CellSetTemperatureSettingsMessage) returns (google.protobuf.Empty) {}
+
+  // Cut out a polygon
+  rpc CutOut (CellCutOutMessage) returns (EDBObjMessage) {}
+
+  // Get a list of property ids.
+  rpc GetProductPropertyIds (GetProductPropertyIdsMessage) returns (ProductPropertyIdsMessage) {}
+
+  // Get product properies
+  rpc GetProductProperty (GetProductPropertyMessage) returns (google.protobuf.StringValue) {}
+
+  // Set a product property value
+  rpc SetProductProperty (SetProductPropertyMessage) returns (google.protobuf.Empty) {}
+
+  // Delete a simulation setup by name
+  rpc DeleteSimulationSetup (StringPropertyMessage) returns (google.protobuf.Empty) {}
+
+  // Get simulation setups
+  rpc GetSimulationSetups (EDBObjMessage) returns (EDBObjCollectionMessage) {}
+  rpc StreamSimulationSetups (EDBObjMessage) returns (stream EDBObjCollectionMessage) {}
+
+  // Generate auto HFSS regions
+  rpc GenerateAutoHFSSRegions (EDBObjMessage) returns (google.protobuf.Empty) {}
+
+  // Generate via smart box
+  rpc GenerateViaSmartBox (StringPropertyMessage) returns (PolygonDataListMessage) {}
+}
+
+message CellCreationMessage {
+  EDBObjMessage database = 1;
+  CellType type = 2;
+  string name = 3;
+}
+
+message CellSetHfssExtentsMessage {
+  EDBObjMessage cell = 1;
+  HfssExtentInfoMessage info = 2;
+}
+
+message CellCutOutMessage {
+  EDBObjMessage cell = 1;
+  EDBObjCollectionMessage included_nets = 2;
+  EDBObjCollectionMessage clipped_nets = 3;
+  PolygonDataMessage clipping_polygon = 4;
+  bool clean_clipping = 5;
+}
+
+message CellFindMessage {
+  EDBObjMessage database = 1;
+  CellType type = 2;
+  oneof query {
+    string name = 3;
+	sint64 id = 4;
+  }
+}
+
+message CellSetTemperatureSettingsMessage {
+  EDBObjMessage cell = 1;
+  TemperatureSettingsMessage temp_settings = 2;
+}