Sap2000py 0.1.6

Sap2000 API python interface

Sap2000py

Sap2000py is a python module to interact with Sap2000 API

This Demo below shows how to interact with SAP2000 using the Sap2000py library. The project includes complete examples of creating and manipulating SAP2000 models, running analyses, and exporting results to Excel.

Documents

You can find the latest documentation here

Or you can find documents for all versions here.

Contents

• Installation
• Usage
  • Setting the Model Path
  • Creating and Opening a SAP2000 Project
  • Model Information
  • Adding Materials and Elements
  • Analysis
  • Post-processing
  • Saving and Closing
• Dependencies

Installation

Using pip:

pip install Sap2000py

Usage

Below are detailed instructions for using Sap2000pyDemo.py.

Setting the Model Path

At the beginning of the script, set the path to your model file:

from pathlib import Path
#full path to the model
ModelPath = Path('.\Test\Test.sdb')

Creating and Opening a SAP2000 Project

Create a Sap2000py object and open the SAP2000 program:

from Sap2000py import Saproject

Sap = Saproject()
Sap.openSap()
Sap.File.Open(ModelPath)

Model Information

Get basic information about your SAP2000 project:

Sap.getSapVersion()
Sap.getProjectInfo()
Sap.getUnits()

Make changes to the model:

# Set the project information with field and value
Sap.setProjectInfo("Author","Gou Lingyun")
Sap.setProjectInfo("Description","This is a test model")

# or you can set project information with a dictionary
Sap.setProjectInfo(info_dict={"Author":"Gou Lingyun","Description":"This is a test model"})

# Set the units of the model
Sap.setUnits("KN_m_C")

Adding Materials and Elements

Add materials and elements to the model:

# Add China Common Material Set·
Sap.Scripts.AddCommonMaterialSet(standard = "JTG")

# Add Joints and Elements
joint_coord = np.array([[0,0,0], [10,0,0], [20,0,0], [30,0,0]])
Sap.Scripts.AddJoints(joint_coord)
Sap.Scripts.AddElements([[1,2], [2,3], [3,4]])

Analysis

Run a modal analysis:

Sap.Scripts.Analyze.RemoveCases("All")
Sap.Scripts.Analyze.AddCases(Casename = ['DEAD', 'MODAL'])
Sap.Scripts.Analyze.RunAll()

Post-processing

Export analysis results to an Excel file:

note: the following code is just an example, you can modify it according to your needs.

filename = 'F:\\python\\Sap2000\\Models\\Test.xlsx'
wb = openpyxl.load_workbook(filename)
ws = wb.worksheets[0]

Sap.Scripts.SelectCombo_Case(["DEAD"])
Name, EleAbsForce, __, __ = Sap.Scripts.GetResults.ElementJointForce_by_Group("PierBottom")
Sap.Scripts.writecell(ws, EleAbsForce[:,[2]], "D22")

wb.save(filename)

Saving and Closing

Save the project and close the SAP2000 program:

Sap.File.Save()
Sap.closeSap()

Dependencies

• python>=3.9

This project requires the following Python libraries:

• numpy
• os
• openpyxl
• comtypes>=1.1.11
• itertools
• rich
• loguru
• pathlib
• json
• sectionproperties>=3.3.0

For more information, please check Sap2000py Demo and Build Continuous Bridge Demo.