Convenience helper that clears all selections and selects the given cases. Args: model: SAP2000 SapModel object case_nam

Select supported points Args: model: SAP2000 SapModel object dof: List of 6 booleans representing the DOFs [

Use the full 3D DOF preset.

Set modifier values for an area object. Args: model: SAP2000 SapModel object area_name: Area object name modifie

Set a body constraint. Args: name: Constraint name dof: Boolean list `[UX, UY, UZ, RX, RY, RZ]`, defaults to all `True`

Set whether a combination is selected for output. Args: model: SAP2000 SapModel object combo_name: Combination name

Set an equal-displacement constraint. Args: name: Constraint name dof: Boolean list `[UX, UY, UZ, RX, RY, RZ]`, defaults

Set frame distributed load. Args: model: SapModel object frame_name: Frame name load_pattern: Load pattern name

Set frame point load. Args: model: SapModel object frame_name: Frame name load_pattern: Load pattern name va

Set isotropic mechanical properties Args: model: SapModel object e: Elastic modulus [F/L²]

Set a single project info field. API: SetProjectInfo(Item, Data) -> Long Args: model: SAP2000 SapModel object

Set the load pattern type. Args: model: SAP2000 SapModel object load_type: Load pattern type

Set the reporting location for base reactions. Args: model: SAP2000 SapModel object gx: Global X coordinate gy:

Set both ends to pinned

Set point displacement load (ground displacement / support settlement). Args: model: SapModel object point_name: Point name

Set point force load. Args: model: SapModel object point_name: Point name load_pattern: Load pattern name (must alre

Assign custom restraints to a point. Args: model: `SapModel` object point_name: Point name restraints: Restraint

Set a project information item. Args: item: Project info item name, for example `"Company Name"` dat

Set run flag for all cases Args: model: SAP2000 SapModel object run: Whether to run Returns: `0` on

Set the self-weight multiplier. Args: model: SAP2000 SapModel object multiplier: Self-weight multipl

Set solver options Args: model: SAP2000 SapModel object option: `SolverOption` instance Returns: `0

Set the design section for frame objects Args: model: SAP2000 SapModel object name: Object name, group name, or ignored depen

Set editable table data from a CSV file Args: model: SapModel object table_key: table key

Set a specific cell value Args: row_index: row index (0-based) field_name: field name va

Convert to pandas DataFrame Returns: pandas.DataFrame object Raises: ImportError: i

Convert the config object into a dictionary.

Convert to dictionary

Convert to the list format required by the API

Convert to the list format required by the API

Return modifiers as the list format expected by the API.

Return modifier values as a list.

Return modifiers as a list.

Convert to the list format required by the API.

Return a 6-tuple of booleans.

Unlock the model.

Verify steel design acceptance Frames that failed design checks or are not yet checked. Args: model: SAP2000 SapModel object

Verify analysis vs. design section assignments Frames whose analysis section differs from the design section. Args: model: S

Destructor safety net for resource cleanup. This helps when the user forgets to call `disconnect()`.

Context manager entry point.

Context manager exit handler. Ensures that: 1. modification mode is finished 2. COM handles are released 3.

Initialize the SAP2000 connection. Args: attach_to_instance: If True, attach to a running instance; otherwise

Args: sap_model: SAP2000 `SapModel` object unit_scale: Unit scale factor (default `0.001 = mm -> m`)

Load values from environment variables.

Load values from environment variables.

Load values from environment variables.

Load values from environment variables.

Create or update the named modifier Args: model: SAP2000 SapModel object Returns:

Create or update the named modifier Args: model: SAP2000 SapModel object Returns:

Create the object in SAP2000.

Create link object in SAP2000. Returns: `0` on success

Create cable object in SAP2000. API (point names): AddByPoint(Point1, Point2, Name, PropName, UserName) API (coordin

Create material in SAP2000.

Create an area object in SAP2000. Returns: `0` on success, nonzero on failure

Create the link property in SAP2000.

Create a load pattern. Args: model: SAP2000 SapModel object Returns: `0` if suc

Create or update a mass source. If a mass source with the same name already exists, it is overwritten. Args:

Delete the named modifier Args: model: SAP2000 SapModel object Returns: `0` on

Delete the named modifier Args: model: SAP2000 SapModel object Returns: `0` on

Delete the object from SAP2000.

Delete a special point in SAP2000. Note: SAP2000 does not provide `PointObj.Delete()`. SAP2000 point deletion r

Delete link object from SAP2000

Delete cable object from SAP2000

Delete material.

Delete area object from SAP2000. Returns: `0` on success, nonzero on failure

Delete the frame from SAP2000.

Delete the area property.

Delete the cable section.

Delete the section.

Delete a load pattern. Note: A load pattern cannot be deleted if it is referenced by a load case or if it is the only remain

Delete the load case. Args: model: SAP2000 SapModel object Returns: `0` if succ

Delete a mass source. Note: The default mass source cannot be deleted. Args: model: SAP2000 SapModel ob

Fetch object data from SAP2000.

Update the object in SAP2000.

Update cable-object properties

Update properties of an existing material. Updates only mechanical and physical properties; it does not create a new materia

Update area-object properties to SAP2000

Update the assigned frame section.

Update the area property.

Update the cable section.

Update the section.

Add multiple area objects to a group. Args: model: SAP2000 SapModel object area_names: List of area object names

Add a load combination. Args: model: SAP2000 SapModel object name: Combination name combo_type: Combination type

Add default design combinations. Args: model: SAP2000 SapModel object design_steel: Whether to add steel design combinat

Add multiple frames to a group. Args: model: SAP2000 SapModel object frame_names: List of frame object names gro

Add a material from the built-in library. Args: model: `SapModel` object mat_type: Material type

Create grounded link object (single-joint) Args: model: SapModel object no: Link object ID

Add multiple link objects to a group.

Add a load pattern to the mass source. Args: load_pattern: Load pattern name scale_factor: Scale fac

Add a point to an area object Args: model: SAP2000 SapModel object name: Area object name point_name: Point name