Welcome to ModularBuildingPy’s Documentation!

ModularBuildingPy is a Python module designed to create linear or nonlinear numerical models for volumetric modular steel buildings using the finite element method (FEM). It leverages the power of OpenSeesPy, a Python library for the Open System for Earthquake Engineering Simulation (OpenSees).

The documentation for ModularBuildingPy is still a work in progress. Please check back later for more information.

User Guide

Information about installing and using this module.

• User Guide
  • Getting Started
  • Usage
  • Troubleshooting
  • FAQ
  • Getting Help
  • Contributing

Examples

There are two examples to demonstrate the functionality of this tool.

• The first example is a nonlinear model of a low-rise (4-story) modular steel building.

• The second example is a linear model of a high-rise (32-story) modular steel building.

• Examples
  • High-rise Modular Steel Building
  • Mid-rise Modular Steel Building with Resilient Slip Friction Joints
  • Low-rise Modular Steel Building

API

The content of the ModularBuildingPy API.

• API
  • Analyze
  • Design
  • Generate
  • Material
  • Model
  • OpenSees
  • PostProcess

Limitations

Limitations of ModularBuildingPy.

• Limitations

References

References for ModularBuildingPy.

• References

Contributing

Contributions to ModularBuildingPy are welcome! We appreciate any help, whether it’s fixing bugs, improving documentation, or suggesting new features. See the contributing guide for more information.

To get started with contributing:

1. Fork the repository on GitHub.

2. Clone your fork to your local machine.

3. Make your changes and commit them to your fork.

4. Submit a pull request with your changes.

License

ModularBuildingPy is licensed under the MIT license. This means you can freely use, modify, and distribute the software, as long as you include the original copyright and license notice in any copy of the software or substantial portions of it. See the license for more information.