Create an instance from a list.

Build modifiers from a list.

Build from the list returned by the API.

Build from an `ActiveDOF` preset.

Fetch all frames using the Database Tables API. Compared with per-object COM calls, this approach dramatically reduces call

Get displacements for all requested points. SAP2000 API: `Results.JointDispl(GroupName, GroupElm, ...)` Args:

Get automatic meshing settings for an area object. Args: model: SAP2000 SapModel object area_name: Area object name

Get the edge-constraint state of an area object. Args: model: SAP2000 SapModel object area_name: Area object name

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

Get area modifiers as a tuple. Args: model: SAP2000 SapModel object area_name: Area object name Returns:

Get offsets assigned to an area object. Args: model: SAP2000 SapModel object area_name: Area object name Re

Get the selection state of an area object. Args: model: SAP2000 SapModel object area_name: Area object name

Get springs assigned to an area object. Args: model: SAP2000 SapModel object area_name: Area object name Re

Get thickness overrides assigned to an area object. Args: model: SAP2000 SapModel object area_name: Area object name

Get all objects assigned to the group Args: model: SAP2000 SapModel object Returns:

Get all objects assigned to the group in raw form Args: model: SAP2000 SapModel object Retu

Get a body constraint definition. Args: name: Constraint name Returns: Tuple `(dof_values, csys)`, or `None

Get a modifier by name

Get a modifier by name

Get an end release by name

Get a modifier by name

Fetch a material by name. Args: model: `SapModel` object name: Material name Re

Get an area property by name.

Get a cable section by name. Args: model: SAP2000 SapModel object name: Section name

Get a link property by name.

Get a load pattern by name. Args: model: SAP2000 SapModel object name: Load pattern name

Get a load case by name. Args: model: SAP2000 SapModel object name: Case name R

Get the selection state of a cable object. Args: model: SAP2000 SapModel object cable_name: Cable object name R

Get all cables in the group

Get whether a case is selected for output. Args: model: SAP2000 SapModel object case_name: Case name Return

Get analysis status for all cases Args: model: SAP2000 SapModel object Returns: List of `CaseStatusInfo`

Return connectivity information for the point. Returns: dict: { 'num_items': int,

Get the number of constraints. Returns: Constraint count.

Get the name of the default mass source. Args: model: SAP2000 SapModel object Returns:

Get a diaphragm constraint definition. Args: name: Constraint name Returns: Tuple `(axis, csys)`, or `None`

Get an equal-displacement constraint definition. Args: name: Constraint name Returns: Tuple `(dof_values, c

Get internal forces for a cable.

Get frame distributed loads. Args: model: SapModel object frame_name: Frame name item_type: Operation scope

Get frame point loads. Args: model: SapModel object frame_name: Frame name item_type: Operation scope Retur

Get the selection state of a frame object. Args: model: SAP2000 SapModel object frame_name: Frame object name R

Get all frames in the group

Get a single project info field by name. Args: model: SAP2000 SapModel object item_name: Field name (SAP2000

Get the groups assigned to a link object. Args: model: SAP2000 SapModel object link_name: Link object name Retu

Return the assigned link property name. Args: model: `SapModel` object link_name: Link object name Returns:

Return the frequency-dependent property name for a link. Args: model: `SapModel` object link_name: Link object name

Get the selection state of a link object. Args: model: SAP2000 SapModel object link_name: Link object name Retu

Get local-axis angle. Returns: (angle, advanced) - angle[deg]and whether advanced settings are used

Get area local-axis angle Returns: (Angle, whether advanced settings exist) tuple, or `None` on failure

Get the number of objects in the group Args: model: SAP2000 SapModel object Returns:

Return the automatic merge tolerance. Returns: Merge tolerance in model length units Raises:

Get automatic merge tolerance (length units). API: GetMergeTol(MergeTol) -> Long Returns: Merge tolerance [L].

Return the model lock state. When the model is locked, most definitions and assignments cannot be edited. Returns:

Get cable section modifiers.

Get all modifier names

Get all modifier names

Get all end-release names

Get all modifier names

Return the list of all point names. Args: model: `SapModel` object Returns: Lis

Return the list of all frame names.

Get the list of load case names. Args: model: SAP2000 SapModel object case_type: Optional case type

Get the names of all mass sources. Args: model: SAP2000 SapModel object Returns:

Get the reporting location for base reactions. Args: model: SAP2000 SapModel object Returns: Tuple `(gx, gy

Return all constraint assignments for a point. Args: model: `SapModel` object point_name: Point name item_type:

Get point displacement loads. Args: model: SapModel object point_name: Point name item_type: Operation scope

Get point force loads. Args: model: SapModel object point_name: Point name item_type: Operation scope Retur

Return panel-zone settings for a point. Args: model: `SapModel` object point_name: Point name Returns:

Infer the support preset from the current restraint state. Args: model: `SapModel` object point_name: Point name

Return project information. Returns: Dictionary of project info items: `{item_name: data}`

Get data for a specific row Args: row_index: row index (0-based) Returns: Data list

Get all cable section names.

Get the list of selected objects Args: model: SAP2000 SapModel object Returns: List of `(object_type, objec

Get the currently selected objects grouped by type Args: model: SAP2000 SapModel object Returns: Dictionary

Get the selected object list in raw form Args: model: SAP2000 SapModel object Returns: List of `(object_typ

Load combinations used for deflection design Args: model: SAP2000 SapModel object Returns: List of load combinat

Load combinations used for strength design Args: model: SAP2000 SapModel object Returns: List of load combinatio

Groups selected for steel design Args: model: SAP2000 SapModel object Returns: List of group names

Get the design section assigned to a frame Args: model: SAP2000 SapModel object name: Frame object name Returns:

Whether steel design results are available Args: model: SAP2000 SapModel object Returns: `True` if results are a

Get display table data and save it as a CSV file Args: model: SapModel object table_key: table key

Get editable table data and save it as a CSV file Args: model: SapModel object table_key: table key

Get transformation matrix Args: model: SapModel object is_global: Whether to use global coordinate s

Get area transformation matrix The transformation matrix maps local coordinates to global (or current) coordinates.

Return a human-readable description of the current unit system. Returns: Description such as `"kN-m-C"` or `"N-m

Return SAP2000 version information. Returns: Tuple `(version_string, version_number)`, for example `("26.3.0", 2

Invert the current selection Deselect currently selected objects and select the unselected ones. Args: model: SAP2000 S

Return whether the model is locked. API: GetModelIsLocked() -> Boolean

Move a point to the intersection of two lines In 3D, two lines are usually not exactly intersecting; this function uses the midpoint of

Project a point onto a line Computes the orthogonal projection of a point onto a line defined by two points, optionally updating coordin

Project multiple points onto a line Uses `N-mm-C` units internally and restores original units after completion. Args:

Read table data (convenience helper) Args: model: SapModel object table_key: table key a

Refresh the model view. Raises: SAPConnectionError: The COM connection is no longer valid

Remove an area object from a group. Args: model: SAP2000 SapModel object area_name: Area object name group_name:

Remove a frame from a group. Args: model: SAP2000 SapModel object frame_name: Frame object name group_name: Grou

Remove a link object from a group.

Reset all steel design overwrites to defaults Args: model: SAP2000 SapModel object Returns: `0` on success, non-

Rotate section profile points about the origin by a specified angle Used to apply SAP2000 local-axis rotation (`local_axis_angle`), rota

Save the current model. Args: model: SapModel object file_path: Target file path. Empty string saves to the current path

Write all non-empty fields and custom fields to the model. Returns: Last SAP2000 return code from a `Set*` call (`0` typ

Save the current model. Args: path: Save path; empty string saves to the current location R

Select by frame section property Args: model: SAP2000 SapModel object section_name: Section name deselect: `Fals