Metadata-Version: 2.4
Name: IBB_Helper
Version: 0.3.0
Summary: Helper functions for symbolic math, matrix visualization, and plotting
Author-email: "University of Stuttgart, Institute for Structural Mechanics (IBB)" <mvs@ibb.uni-stuttgart.de>
License: BSD3
Project-URL: repository, https://www.ibb.uni-stuttgart.de/en/
Classifier: Programming Language :: Python :: 3
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.19
Requires-Dist: sympy>=1.8
Requires-Dist: matplotlib>=3.3
Requires-Dist: plotly>=5.0
Requires-Dist: ipython>=7.0
Requires-Dist: setuptools>=42
Requires-Dist: wheel
Dynamic: license-file

## Helper functions for symbolic math, matrix visualization, and plotting

**Author:** University of Stuttgart, Institute for Structural Mechanics (IBB)    
**License:** BSD3  
**Version:** 0.3.0  
**Date:** October 22, 2025  

### Description

This helper module currently provides 11 specialized functions for symbolic mathematics, matrix visualization, and plotting operations. Designed for SymPy, NumPy, Matplotlib, and Plotly integration in Jupyter Notebooks and Python environments.

### Helper Functions

1. **display_matrix** - Display truncated matrices with optional numerical evaluation
2. **display** - Format scalars, vectors, or matrices in LaTeX for display
3. **display_eigen** - Compute and display eigenvalues/eigenvectors with LaTeX formatting
4. **plot_2d** - Plot symbolic expressions or datasets in 2D using Matplotlib
5. **plot_3d** - Plot symbolic 3D surfaces using Plotly for interactive visualization
6. **extend_plot** - Merge multiple plots side-by-side with horizontal offsets
7. **combine_plots** - Stack multiple Matplotlib/Plotly plots into combined figures
8. **plot_param_grid** - Plot 2D parametric surface grids with control points
9. **symbolic_BSpline** - Generate symbolic B-spline basis functions with plotting
10. **num_int** - Numerically integrate symbolic expressions over 1D domains
11. **minimize** - General optimization wrapper for symbolic expressions with constraints

### Dependencies

- Python 3.8+
- numpy, sympy, matplotlib, plotly
- IPython (for LaTeX rendering)


### Quick Start

```python
import IBB_Helper as ibb

# Display matrix
ibb.display_matrix(np.array([[1, 2], [3, 4]]), name="A")

# Show symbolic expression  
ibb.display(sp.sin(x)**2 + sp.cos(x)**2, name="Identity")

# Plot 2D curves
ibb.plot_2d([sp.sin(x), sp.cos(x)], var=(x, (-np.pi, np.pi)))

# Plot 3D surface
ibb.plot_3d(sp.sin(x*y), var=(x, (-2, 2), y, (-2, 2)))
```


### Development Status

This is an **ongoing project** with regular enhancements. Updates might include:

- New helper functions
- Performance optimizations
- Extended compatibility
- Bug fixes and stability improvements


### Notes

- Optimized for education, research, and technical documentation
- Seamless SymPy/NumPy integration
- Enhanced LaTeX formatting for presentations
