PODImodels 0.0.3__py3-none-any.whl

podimodels-0.0.3.dist-info/METADATA

@@ -0,0 +1,211 @@
+Metadata-Version: 2.4
+Name: PODImodels
+Version: 0.0.3
+Summary: A py package to create ROM utilizing PODI method
+Author-email: Shenhui_Ruan <shenhui.ruan@kit.edu>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scikit-learn
+Requires-Dist: scipy
+Requires-Dist: pyvista
+Requires-Dist: torch
+Dynamic: license-file
+
+# PODImodels
+
+[![PyPI version](https://badge.fury.io/py/PODImodels.svg)](https://badge.fury.io/py/PODImodels)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**PODImodels** (Proper Orthogonal Decomposition-based Interpolation Models) is a Python package for creating Reduced-Order Models (ROM) using POD combined with various machine learning techniques. It provides a unified framework for reduced-order modeling of high-dimensional field data, particularly useful for computational fluid dynamics and other physics-based simulations.
+
+## Features
+
+- **Multiple Interpolation Methods**: Support for Linear Regression, Ridge Regression, Gaussian Process Regression (GPR), Radial Basis Functions (RBF), and Artificial Neural Networks (ANN)
+- **Flexible Modeling Approaches**: Choose between direct field prediction or POD coefficient interpolation
+- **Easy-to-Use API**: Scikit-learn-inspired interface with `fit()` and `predict()` methods
+- **Built-in Scaling**: Optional data normalization for improved model performance
+- **Extensible Architecture**: Abstract base class for implementing custom interpolation models
+
+## Installation
+
+Install PODImodels using pip:
+
+```bash
+pip install PODImodels
+```
+
+For development installation:
+
+```bash
+git clone https://github.com/Ruansh233/PODImodels.git
+cd PODImodels
+pip install -e .
+```
+
+## Requirements
+
+- Python >= 3.8
+- numpy
+- scikit-learn
+- scipy
+- pyvista
+- torch
+
+All dependencies will be automatically installed with the package.
+
+## Quick Start
+
+```python
+import numpy as np
+from PODImodels import PODGPR, fieldsRBF
+
+# Prepare your data
+# parameters: (n_samples, n_parameters)
+# field_snapshots: (n_samples, n_field_points)
+parameters = np.random.rand(100, 3)
+field_snapshots = np.random.rand(100, 10000)
+
+# Example 1: POD with Gaussian Process Regression
+model = PODGPR(rank=15, with_scaler_x=True, with_scaler_y=True)
+model.fit(parameters, field_snapshots)
+predictions = model.predict(new_parameters)
+
+# Example 2: Direct field prediction with Radial Basis Functions
+model = fieldsRBF(kernel='thin_plate_spline', degree=2)
+model.fit(parameters, field_snapshots)
+field_prediction = model.predict(test_parameters)
+```
+
+## Available Models
+
+PODImodels provides two categories of models:
+
+1. **Direct Field Models** (`fields*`): Learn direct mapping from parameters to field values
+2. **POD Coefficient Models** (`POD*`): Learn mapping from parameters to POD coefficients (more efficient for large fields)
+
+### Linear Regression Models
+- `fieldsLinear`: Direct field prediction using linear regression
+- `PODLinear`: POD coefficient prediction using linear regression
+- `fieldsRidge`: Direct field prediction using Ridge regression
+- `PODRidge`: POD coefficient prediction using Ridge regression
+
+### Gaussian Process Regression Models
+- `fieldsGPR`: Direct field prediction using Gaussian Process Regression
+- `PODGPR`: POD coefficient prediction using Gaussian Process Regression
+- `fieldsRidgeGPR`: Field prediction with Ridge regularization and GPR
+- `PODRidgeGPR`: POD coefficient prediction with Ridge regularization and GPR
+
+### Radial Basis Function Models
+- `fieldsRBF`: Direct field prediction using Radial Basis Function interpolation
+- `PODRBF`: POD coefficient prediction using Radial Basis Function interpolation
+- `fieldsRidgeRBF`: Field prediction with Ridge regularization and RBF
+- `PODRidgeRBF`: POD coefficient prediction with Ridge regularization and RBF
+
+### Neural Network Models
+- `PODANN`: POD coefficient prediction using Artificial Neural Networks
+
+## Usage Examples
+
+### Example 1: POD-GPR for CFD Field Reconstruction
+
+```python
+from PODImodels import PODGPR
+import numpy as np
+
+# Load your simulation data
+# X: Design parameters (e.g., Reynolds number, geometry params)
+# Y: Field snapshots (e.g., velocity, pressure fields)
+X_train = np.load('parameters.npy')  # shape: (n_samples, n_params)
+Y_train = np.load('fields.npy')      # shape: (n_samples, n_points)
+
+# Initialize model with 20 POD modes
+model = PODGPR(rank=20, with_scaler_x=True, with_scaler_y=True)
+
+# Train the model
+model.fit(X_train, Y_train)
+
+# Predict new fields
+X_test = np.array([[100, 0.5, 1.2]])  # New parameter set
+Y_pred = model.predict(X_test)
+```
+
+### Example 2: Direct Field Interpolation with RBF
+
+```python
+from PODImodels import fieldsRBF
+
+# Initialize RBF model
+model = fieldsRBF(
+    kernel='thin_plate_spline',
+    degree=2,
+    with_scaler_x=True
+)
+
+# Train and predict
+model.fit(X_train, Y_train)
+Y_pred = model.predict(X_test)
+```
+
+### Example 3: Using Neural Networks
+
+```python
+from PODImodels import PODANN
+
+# Initialize ANN model
+model = PODANN(
+    rank=15,
+    hidden_layers=[64, 32],
+    activation='relu',
+    epochs=100
+)
+
+model.fit(X_train, Y_train)
+Y_pred = model.predict(X_test)
+```
+
+## Model Selection Guide
+
+- **Linear/Ridge**: Fast, interpretable, works well for linear relationships
+- **GPR**: Best for smooth, continuous fields with uncertainty quantification
+- **RBF**: Excellent for scattered data interpolation
+- **ANN**: Powerful for complex nonlinear relationships, requires more data
+
+Choose **POD*** models when dealing with large field dimensions (>1000 points) for better computational efficiency.
+
+## Documentation
+
+For detailed documentation and API reference, visit the [GitHub repository](https://github.com/Ruansh233/PODImodels).
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+## Citation
+
+If you use PODImodels in your research, please cite:
+
+```bibtex
+@software{PODImodels2024,
+  author = {Ruan, Shenhui},
+  title = {PODImodels: POD-based Interpolation Models for Reduced-Order Modeling},
+  year = {2024},
+  url = {https://github.com/Ruansh233/PODImodels}
+}
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Author
+
+**Shenhui Ruan**  
+Email: shenhui.ruan@kit.edu  
+GitHub: [@Ruansh233](https://github.com/Ruansh233)
+
+## Acknowledgments
+
+This package was developed for reduced-order modeling in computational physics applications, with a focus on CFD simulations.

podimodels-0.0.3.dist-info/RECORD

@@ -0,0 +1,9 @@
+PODImodels/PODImodels.py,sha256=EPl12pkpV6KPN2BFj-oIgCA8D8VGEbysKlugG3FGZHk,37728
+PODImodels/PODdata.py,sha256=2N0yZM6P_BpxvUaDYMPZGGuOmXia0dI3C1TrJJj6D18,19293
+PODImodels/__init__.py,sha256=JuwBq06BHcl4KBm9ifoNEKzFgSllET50pgqaQRjLURc,2182
+PODImodels/podImodelabstract.py,sha256=PfP-JjyKoEAXFL-AxC0zjJzUKOudh-LrHeG-Iqj5iEk,30896
+podimodels-0.0.3.dist-info/licenses/LICENSE,sha256=maqixz01QZKwAgUjSbn6diLezFvqA5X3wmzr2ADn8AQ,1071
+podimodels-0.0.3.dist-info/METADATA,sha256=x0NPFmbXqIEjPQgKQsl_FGBlDRYoDj4iKq5PZN4fw2c,6708
+podimodels-0.0.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+podimodels-0.0.3.dist-info/top_level.txt,sha256=JiLLSU7WbowDs0wA3Voldy0E0Rn_TTugXTwMpx6kUZ0,11
+podimodels-0.0.3.dist-info/RECORD,,

podimodels-0.0.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

podimodels-0.0.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 RUAN, SHENHUI 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

podimodels-0.0.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+PODImodels