ak_sap 0.0.2

Python wrapper for SAP2000 API

ak_sap

Python wrapper for SAP2000. Generate/Analyze/Extract complex structural models using python.

GUI · Getting Started · Layout Documentation · Report Bug/Request Feature

Table of Contents

• 1. About the Project
• 2. Getting Started
  • 2.1. Prerequisites
  • 2.2. Installation
    • 2.2.1. Production
      • 2.2.1.1. One line command
      • 2.2.1.2. Install directly from repo
      • 2.2.1.3. Install from Pypi release
    • 2.2.2. Development
• 3. Usage
  • 3.1. GUI
  • 3.2. Layout Documentation
• 4. Roadmap
• 5. License
• 6. Contact
• 7. Acknowledgements

1. About the Project

2. Getting Started

2.1. Prerequisites

1. Python 3.11 or above
2. SAP2000 v24 or higher

2.2. Installation

2.2.1. Production

2.2.1.1. One line command

1. Press Win + R to open the Run console

2. Type "cmd" and press enter

3. Type the following and press Enter

    curl -sSL https://links.struct.work/SAP2000 > %USERPROFILE%\Desktop\install.bat
   

4. You should now have a install.bat file in your desktop

5. Move this file to your desired installtion directory and run to install the AK_SAP module

2.2.1.2. Install directly from repo

Clone repo and Install with flit

git clone https://github.com/rpakishore/ak_sap.git
cd  ak_sap
pip install flit

• If you want just the base package:

  flit install --deps production
  

• Alternatively, if you also want to include the optional streamlit gui:

  flit install --deps production --extras gui
  

2.2.1.3. Install from Pypi release

pip install ak_sap

Note: The Pypi version does not ship with the optional streamlit gui

2.2.2. Development

Download the git and install via flit

git clone https://github.com/rpakishore/ak_sap.git
cd  ak_sap
pip install flit
flit install --pth-file

3. Usage

Initialize the module as below

from ak_sap import debug, Sap2000Wrapper
debug(status=False)

#Initialize
sap = Sap2000Wrapper(attach_to_exist=True)      #Attach to existing opened model
sap = Sap2000Wrapper(attach_to_exist=False)     #Create new blank model from latest SAP2000

## Create blank model from a custom version of SAP2000
sap = Sap2000Wrapper(attach_to_exist=False, program_path=r'Path\to\SAP2000.exe')

Parent level methods and attributes

sap.hide()                                  #Hide the SAP2000 window
sap.unhide()                                #Unhides SAP2000 window
sap.version                                 #Returns SAP2000 version number
sap.api_version                             #Returns Sap0API version number

sap.save(r'\Path\to\save\file.sdb')

3.1. GUI

The repo has an optional streamlit GUI for the wrapper. Checkout GUI.md for installation and usage instructions.

3.2. Layout Documentation

To see module level usage, check out the Layout.md or Usage.ipynb

4. Roadmap

• Generate Load Patterns
• Generate Load Cases
• Apply Loads
  • Points
  • Area
  • Line
• Export joint reactions to Hilti-Profis file
• Export Frame/Wall sections to S-Concrete

5. License

See LICENSE for more information.

6. Contact

Arun Kishore - @rpakishore

Project Link: https://github.com/rpakishore/ak_sap

7. Acknowledgements

• Shields.io