Merge pull request #283 from damar-wicaksono/dev-260

Prepare the release of v0.4.0

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2023-07-07
+
 ### Added
 
 - The two-dimensional convex failure domain problem for reliability
@@ -18,11 +20,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   from an example in Santner et al. (2018).
 - The two-dimensional circular bar RS problem for reliability analysis
   exercises taken from an example in Verma et al. (2015).
-- New instance method for `UnivDist` and `ProbInput` classes
-  called `reset_rng()`. When called (optionally with a seed number),
-  a new instance of NumPy default RNG will be created and attached to the instance.
 - The two-dimensional polynomial function with random inputs
   from Webster et al. (1996) for metamodeling exercises.
+- New instance method for `UnivDist` and `ProbInput` classes
+  called `reset_rng()`. When called (optionally with a seed number), a new
+  instance of NumPy default RNG will be created and attached to the instance.
+- GitHub actions now include testing on Python v3.11 via Tox.
 
 ### Changed
 
@@ -36,7 +39,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- A mistake in one the parameter values of the Sobol'-G function has been fixed. 
+- A mistake in one the parameter values of the Sobol'-G function
+  has been fixed. 
 
 ## [0.3.0] - 2023-07-03
 
@@ -160,6 +164,7 @@ First public release of UQTestFuns.
 - Mirror GitHub action to the [CASUS organization](https://github.com/casus)
 
 [Unreleased]: https://github.com/damar-wicaksono/uqtestfuns/compare/main...dev
+[0.4.0]: https://github.com/damar-wicaksono/uqtestfuns/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/damar-wicaksono/uqtestfuns/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/damar-wicaksono/uqtestfuns/compare/v0.1.1...v0.2.0
 [0.1.1]: https://github.com/damar-wicaksono/uqtestfuns/compare/v0.1.0...v0.1.1

CITATION.cff

@@ -14,26 +14,29 @@ authors:
     orcid: 'https://orcid.org/0000-0001-8587-7730'
 identifiers:
   - type: doi
-    value: 10.5281/zenodo.8109901
-    description: The Zenodo URL of version 0.3.0 of the package
+    value: 10.5281/zenodo.8125015
+    description: The Zenodo URL of version 0.4.0 of the package
 repository-code: 'https://github.com/damar-wicaksono/uqtestfuns'
 url: 'https://uqtestfuns.readthedocs.io/en/latest/'
 repository-artifact: 'https://pypi.org/project/uqtestfuns/'
 abstract: >-
   UQTestFuns is an open-source Python3 library of test
   functions commonly used within the uncertainty
   quantification (UQ) community. The package aims to provide
-  a lightweight implementation (with minimal dependencies)
+  an implementation with minimal dependencies and a common interface
   of many test functions available in the UQ literature,
-  a single entry point (combining models and their
-  probabilistic input specification) to a wide range of test
-  functions, and an opportunity for an open-source contribution
-  where new test functions and reference results are posted.
+  a single entry point collecting test functions and their probabilistic
+  input specifications in a single Python package,
+  and an opportunity for an open-source contribution,
+  supporting the implementation of new test functions
+  or posting reference results.
 keywords:
   - uncertainty-quantification
   - test-functions
   - sensitivity-analysis
   - metamodeling
+  - reliability-analysis
+  - surrogate-modeling
 license: MIT
-version: 0.3.0
-date-released: '2023-07-03'
+version: 0.4.0
+date-released: '2023-07-07'

README.md

@@ -1,5 +1,5 @@
 # UQTestFuns
-[![DOI](http://img.shields.io/badge/DOI-10.5281/zenodo.8109901-blue.svg?style=flat-square)](https://doi.org/10.5281/zenodo.8109901)
+[![DOI](http://img.shields.io/badge/DOI-10.5281/zenodo.8125015-blue.svg?style=flat-square)](https://doi.org/10.5281/zenodo.8125015)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)
 [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg?style=flat-square)](https://www.python.org/downloads/release/python-370/)
 [![License](https://img.shields.io/github/license/damar-wicaksono/uqtestfuns?style=flat-square)](https://choosealicense.com/licenses/mit/)
@@ -12,15 +12,15 @@
 
 <!--One paragraph description-->
 UQTestFuns is an open-source Python3 library of test functions commonly used
-within the uncertainty quantification (UQ) community.
-The package aims to provide:
+within the applied uncertainty quantification (UQ) community.
+Specifically, the package provides:
 
-- a _lightweight implementation_ (with minimal dependencies) of
-  many test functions available in the UQ literature
-- a _single entry point_ (combining models and their probabilistic input
-  specification) to a wide range of test functions
-- an opportunity for an _open-source contribution_ where new test functions and
-  reference results are posted.
+- an implementation _with minimal dependencies_ (i.e., NumPy and SciPy) and
+  _a common interface_ of many test functions available in the UQ literature
+- a _single entry point_ collecting test functions _and_ their probabilistic
+  input specifications in a single Python package
+- an _opportunity for an open-source contribution_, supporting
+  the implementation of new test functions or posting reference results.
 
 In short, UQTestFuns is an homage
 to the [Virtual Library of Simulation Experiments (VLSE)](https://www.sfu.ca/~ssurjano/).
@@ -33,13 +33,16 @@ To list the available functions:
 ```python-repl
 >>> import uqtestfuns as uqtf
 >>> uqtf.list_functions()
- No.      Constructor       Spatial Dimension          Application          Description
------  ------------------  -------------------  --------------------------  ----------------------------------------------------------------------------
-  1         Ackley()                M           optimization, metamodeling  Ackley function from Ackley (1987)
-  2        Borehole()               8           metamodeling, sensitivity   Borehole function from Harper and Gupta (1983)
-  3    DampedOscillator()           8           metamodeling, sensitivity   Damped oscillator model from Igusa and Der Kiureghian (1985)
-  4         Flood()                 8           metamodeling, sensitivity   Flood model from Iooss and Lemaître (2015)
-  5        Ishigami()               3                  sensitivity          Ishigami function from Ishigami and Homma (1991)
+No.            Constructor            Dimension                Application                Description
+-----  -----------------------------  -----------  --------------------------------------  ----------------------------------------------------------------------------
+  1              Ackley()                  M             optimization, metamodeling        Optimization test function from Ackley (1987)
+  2             Borehole()                 8             metamodeling, sensitivity         Borehole function from Harper and Gupta (1983)
+  3           Bratley1992a()               M              integration, sensitivity         Integration test function #1 from Bratley et al. (1992)
+  4           Bratley1992b()               M              integration, sensitivity         Integration test function #2 from Bratley et al. (1992)
+  5           Bratley1992c()               M              integration, sensitivity         Integration test function #3 from Bratley et al. (1992)
+  6           Bratley1992d()               M              integration, sensitivity         Integration test function #4 from Bratley et al. (1992)
+  7         CantileverBeam2D()             2                    reliability                Cantilever beam reliability problem from Rajashekhar and Ellington (1993)
+  8         CircularPipeCrack()            2                    reliability                Circular pipe under bending moment from Verma et al. (2015)
 ...
 ```
 
@@ -155,6 +158,10 @@ UQTestFuns is currently maintained by:
 
 - Damar Wicaksono ([HZDR/CASUS](https://www.casus.science/))
 
+with scientific supervision from:
+
+- Michael Hecht ([HZDR/CASUS](https://www.casus.science/))
+
 ## License
 
 <!--License-->

docs/test-functions/available.md

@@ -15,8 +15,9 @@ kernelspec:
 (test-functions:available)=
 # All Available Functions
 
-The table below lists all the available _classic_ test functions from the literature
-available in the current UQTestFuns, regardless of their typical applications.
+The table below lists all the test functions available in UQTestFuns
+from the uncertainty quantification (UQ) literature,
+regardless of their typical applications.
 
 |                                        Name                                         | Spatial Dimension |           Constructor           |
 |:-----------------------------------------------------------------------------------:|:-----------------:|:-------------------------------:|

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = uqtestfuns
-version = 0.3.0
+version = 0.4.0
 url = https://github.com/damar-wicaksono/uqtestfuns
 author = Damar Wicaksono
 author_email = damar.wicaksono@outlook.com
@@ -18,6 +18,7 @@ classifiers =
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9
    Programming Language :: Python :: 3.10
+   Programming Language :: Python :: 3.11
    Topic :: Scientific/Engineering
    Topic :: Scientific/Engineering :: Mathematics
    Topic :: Software Development :: Libraries :: Python Modules