Metadata-Version: 2.1
Name: planesections
Version: 0.3.0
Summary: A light-weight beam analyzer built on OpenSeesPy.
Home-page: https://github.com/cslotboom/planesections
Author: Christian Slotboom
Author-email: cslotboom@yahoo.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: license.txt

# PlaneSections
A lightweight beam bending library built on [OpenSeesPy](https://github.com/zhuminjie/OpenSeesPy).
There was no package for beam bending in python that worked to my satisfaction, hence this package.
Being built on OpenSees, the structural results are reliable, and there is lots of room to build more complex models.
While OpenSees can analyze nearly anything, the emphasis is on providing a quick way to analyze beams.

The core classes and API are complete, but development is still in progress. Expect some sytax changes before final release.


## Simple API
Easily make changes with the beam object

## Basic Plots
Easily make plots and get results for shear force, bending force, deflection or roation.


## Fancy Plots
The PlaneSections can plot representations that can be used in documentation.


<p align="center">
  <img src="doc/img/Beam Image 2.png">
  <img src="doc/img/Beam Image 2 SFD.png">
  <img src="doc/img/Beam Image 2 BMD.png">
</p>

# Work Status
Currently a work in progress. To be compeleted before intial release:

*Analysis and API*:
- [ ] fancy plots (distributed Load)
- [ ] Better deflection plots (distributed Load)

*Infacstructure*:
- [x] pip package
  - [x] setup on pypi: complete, package is installable with "pip install planesections"
  - [ ] Add requirements
- [ ] Document code
  - [ ] Finish all class docstrings.
  - [ ] Add Sphinx docs.
  - [ ] Add read the docs website.
- [ ] Examples
  - [ ] Finish landing page with code examples and figures.
  - [ ] Compare simple cases with analytic equations.
  - [ ] Compare complex cases with sap/rfem/etc.

Future work:
 - 3D beams
 - Timoshenko beams
 - Nonlinear beams analysis
 - One-way Slabs?
 - Two-way Slabs?
 - Orthtropic Slabs?
 - Basic simple frame analysis?
 - Basic Nonlinear frame analysis?



