SURGroup / UQpy

UQpy (Uncertainty Quantification with python) is a general purpose Python toolbox for modeling uncertainty in physical and mathematical systems.
MIT License
267 stars 76 forks source link

Add a new feature - KLE 2 dimensional fields #177

Closed lohitv96 closed 2 years ago

lohitv96 commented 2 years ago

Karhunen-Loeve Expansion 2 dimensional fields

This Pull Request adds a new feature to extend the functionality of the stochasticprocess submodule to simulate a 2 dimensional random field by the Karhunen Loeve Expansion.

Description

The code implements the methodology described in https://www.sciencedirect.com/science/article/abs/pii/S0045782516318692 for the simulation of a 2 dimensional random field. Although the journal article describes the simulation of a general multi-dimensional field, this implementation is for 2 dimensional fields only.

Related Issue

This project only accepts pull requests related to open issues If suggesting a new feature or change, please discuss it in an issue first If fixing a bug, there should be an issue describing it with steps to reproduce Please link to the issue here:

Motivation and Context

This Pull request adds a new feature to the package.

How Has This Been Tested?

Two tests have been added to the test the functionality of the code. The tests are added under the tests folder. The tests pass successfully in the CI/CD pipeline.

Screenshots (if appropriate):

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

Checklist:

Go over all the following points, and put an x in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help!

dimtsap commented 2 years ago

@lohitv96 Code of KLE2D & unit tests seem fine. Please add the respective documentation and if posible an example before merging!

sonarcloud[bot] commented 2 years ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 1 Code Smell

90.3% 90.3% Coverage
0.0% 0.0% Duplication