ak_safe 0.0.1

Python wrapper for SAFE API

ak_safe

Python wrapper for SAFE. 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. Install from Pypi release
    • 2.2.2. Development
• 3. Usage
• 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. CSI SAFE v21 or higher

2.2. Installation

2.2.1. Production

2.2.1.1. Install from Pypi release

pip install ak_safe

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_safe.git
cd  ak_sap
pip install flit
flit install --pth-file

3. Usage

Initialize the module as below

from ak_safe import debug, SAFEWrapper
debug(status=False)

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

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

Parent level methods and attributes

safe.hide(status=True)                       #Hide the SAFE window
safe.unhide(status=False)                    #Unhides SAFE window
safe.version                                 #Returns SAFE version number
safe.api_version                             #Returns SAFE version number

safe.save(r'\Path\to\save\file.FDB')

4. Roadmap

• Generate Load Patterns
• Generate Load Cases
• Apply Loads
  • Points
  • Area
  • Line
• Export joint reactions to Hilti-Profis file

5. License

See LICENSE for more information.

6. Contact

Arun Kishore - @rpakishore

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

7. Acknowledgements