Get local-axis angle.

Get advanced local-axis settings API: GetLocalAxesAdvanced(Name, Active, Plane2, PlVectOpt, PlCSys, PlDir[], PlPt[], PlVect[])

Get added mass

Get modifiers

Get area section-property name

Get frequency-dependent property.

Fetch the point selection state.

Get selection state

Parse creation result

Print connection info and configure logging in the model directory.

Print an aligned progress bar using block symbols. Args: current: Current progress total: Total count bar_width:

Recursively scale section parameters For standard sections, scales numeric parameters directly. For SD and nonprisma

Set cell text and center it.

Begin batch modification mode. View refreshing is disabled to improve performance.

Rename a constraint. Returns: `True` if successful.

Rename the modifier Args: model: SAP2000 SapModel object new_name: New name Ret

Rename a load pattern. Args: model: SAP2000 SapModel object new_name: New name

Change point coordinates Args: model: SAP2000 SapModel object name: Point name x: X coordinate y: Y coor

Clear all objects from the group Removes all assignments while keeping the group definition. Args:

Explicitly disconnect and release COM resources. This can be called manually when not using a context manager. Repeated call

Create an instance from an API-returned list.

Build from a 6-tuple (or shorter tuple, padded with defaults).

Create an instance from a modifier tuple.

Generate a Word calculation report. Args: output_path: Output `.docx` path frame_names: Frame names; uses al

Get the additional mass assigned to an area object. Args: model: SAP2000 SapModel object area_name: Area object name

Fetch a frame by name. Example: frame = Frame.get_by_name(model, "1") print(f"Section: {frame.sectio

Get a section by name.

Get a mass source by name. Args: model: SAP2000 SapModel object name: Mass source name

Get the list of groups assigned to a cable object. Args: model: SAP2000 SapModel object cable_name: Cable object name

Convenience function to get cable usage Args: model: SapModel object group_by: Grouping mode; `None` returns total, `"se

Get all fields in a table Args: model: SapModel object table_key: table key table_versio

Return the force unit symbol for the given system.

Get the additional mass per unit length of a frame. Args: model: SAP2000 SapModel object frame_name: Frame object name

Get the material override assigned to a frame. Args: model: SAP2000 SapModel object frame_name: Frame object name

Get inner rectangle contour points (for boolean operations)

Return the length unit symbol for the given system.

Get all cable-object names API: GetNameList() -> (NumberNames, MyName[], ret)

Return the list of material names. Args: model: `SapModel` object mat_type: Optional material type f

Get all area-object names Args: model: SapModel object Returns: List of area-ob

Get the list of area property names.

Get the list of cable section names.

Get the list of link property names.

Get the list of section names.

Get the names of all load patterns. Args: model: SAP2000 SapModel object Returns:

Get the names of all cable objects.

Return the point restraint state. Args: model: `SapModel` object point_name: Point name Returns: Restra

Return the current coordinate system name. Returns: Coordinate system name Raises: SAPC

Get all link-property names.

Get run flags for all cases Args: model: SAP2000 SapModel object Returns: List of `RunCaseFlag`

Get the number of selected objects Args: model: SAP2000 SapModel object Returns: Number of selected objects

Get solver options Args: model: SAP2000 SapModel object Returns: `SolverOption` instance, or `None` on fail

Return the temperature unit symbol for the given system.

Return the current unit system. Returns: A `UnitSystem` enum value Raises: SAPC

Return the user comment text. Returns: User comment content Raises: SAPConnecti

Compute element length

Set active model degrees of freedom Args: model: SAP2000 SapModel object dof: `ActiveDOF` instance Returns:

Set the edge-constraint state of an area object. Edge constraints help enforce displacement compatibility between adjacent areas. A

Assign or remove an area object from a group. Args: model: SAP2000 SapModel object area_name: Area object name g

Set a diaphragm constraint. Args: name: Constraint name axis: Axis normal to the diaphragm plane, default is automatic

Assign or remove a frame from a group. Args: model: SAP2000 SapModel object frame_name: Frame object name group_

Assign or remove a link object from a group. Args: model: SAP2000 SapModel object link_name: Link object name gr

Set local-axis angle. Args: model: SapModel object angle: Rotation angle of local-2 and local-3 abou

Set area local-axis angle Args: model: SapModel object angle: Local-axis angle [deg] ite

Set the model lock state. API: SetModelIsLocked(Locked) -> Long

Set the I end to pinned (`R2`, `R3` released)

Set the J end to pinned (`R2`, `R3` released)

Assign a predefined support type to a point. Args: model: `SapModel` object point_name: Point name support_type:

Set run flag for a specific case Args: model: SAP2000 SapModel object case_name: Case name run: Whether to run

Set the steel design code Args: model: SAP2000 SapModel object code: Code enum or code name string Returns:

Set editable table data (recommended). Args: model: SapModel object table_data: `TableData` object

Set the user comment text. Args: comment: Comment text num_lines: Number of blank lines to insert be

Configure the PySap2000 logger. Args: level: Logging level log_file: Optional log file path format_string: Optional

Convert to the list format required by the API

Return the modifier values as a tuple.

Attach to a running SAP2000 instance, retrying up to three times.

Convert element info rows to a DataFrame.

Convert steel design result rows to a DataFrame.

Compute nearest points between two 3D lines (approximate intersection). Line 1: `P1 + t * (P2 - P1)` Line 2: `P3 + s * (P4 - P3)`

Compute point coordinates on line AB using ratio `t` Args: point_a: Start point A `(x, y, z)` point_b: End point B `(x,

Compute cable length.

Compute frame weight in kilograms. weight = weight_per_meter × length If the current unit system is not `N_

Compute unit weight per length in `kg/m`. weight_per_meter = area × density If the current units are not `N

Warn if end points are missing from the model.

Check that the connected SAP2000 version meets the minimum requirement. Raises: SAPConnectionError: Raised when the vers

Create or update a named end release Args: model: SAP2000 SapModel object Returns:

Create the area property in SAP2000.

Create the cable section in SAP2000.

Create the section in SAP2000.

Create an axisymmetric solid property.

Create an area object from coordinates

Create an area object from point names

Create the point using Cartesian coordinates.

Create the point using cylindrical coordinates.