You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can find the API Documentation on our [GitHub Pages](https://ucl-ccs.github.io/EasyVVUQ/).
12
-
13
11
The aim of EasyVVUQ is to facilitate verification, validation and
14
12
uncertainty quantification (VVUQ) for a wide variety of
15
13
simulations. While very convenient for simple cases, EasyVVUQ is particularly well suited in situations where the simulations are computationally expensive,
@@ -23,8 +21,14 @@ Here are some examples of questions EasyVVUQ can answer about your code:
23
21
24
22
It also lets you construct surrogate models that are cheaper to evaluate than the complete simulation.
25
23
26
-
Basic concepts are introduced [here](https://mybinder.org/v2/gh/UCL-CCS/EasyVVUQ/a6852d6c5ba36f15579e601d7a8d074505f31084?filepath=tutorials%2Fbasic_tutorial.ipynb) and [here](https://mybinder.org/v2/gh/UCL-CCS/EasyVVUQ/74d6a9f4b0eecc754918de2f3795395d35ac4875?filepath=tutorials%2Fvector_qoi_tutorial.ipynb). For an introduction for interfacing your simulation to EasyVVUQ see [this](
The high-level overview of the library is avalable at our [readthedocs](https://easyvvuq.readthedocs.io/en/dev/).
25
+
26
+
## Getting Started
27
+
28
+
For the quick start with EasyVVUQ we reccommend to check our basic interactive tutorial available [here](https://mybinder.org/v2/gh/UCL-CCS/EasyVVUQ/a6852d6c5ba36f15579e601d7a8d074505f31084?filepath=tutorials%2Fbasic_tutorial.ipynb).
29
+
30
+
31
+
## Functionality
28
32
29
33
Available analysis and sampling methods:
30
34
@@ -42,18 +46,18 @@ EasyVVUQ also supports building surrogate models using:
Development was funded by the EU Horizon 2020 project [VECMA](http://www.vecma.eu/).
54
+
## Installation instructions
51
55
52
-
## Requirements
56
+
###Requirements
53
57
54
58
To use the library you will need Python 3.7+.
55
59
56
-
## Installation using pip
60
+
###Installation using pip
57
61
58
62
If you are unsure of the version of python your default `pip` works for type:
59
63
```
@@ -73,7 +77,7 @@ To upgrade the library use:
73
77
pip install easyvvuq --upgrade
74
78
```
75
79
76
-
## Manual installation from repository
80
+
###Manual installation from repository
77
81
78
82
Alternatively, you can manually install EasyVVUQ.
79
83
First clone the repository to your computer:
@@ -95,9 +99,9 @@ Then the library can be installed using:
95
99
python setup.py install
96
100
```
97
101
98
-
## Getting Started
102
+
## API
99
103
100
-
Documentation, including a basic tutorial, is avalable [here](https://easyvvuq.readthedocs.io/en/dev/).
104
+
You can find the EasyVVUQ API documentation on our [GitHub Pages](https://ucl-ccs.github.io/EasyVVUQ/).
101
105
102
106
## Citing EasyVVUQ
103
107
@@ -108,3 +112,7 @@ Journal of Open Research Software, 8: 11.
108
112
109
113
> Wright, D.W., Richardson, R.A., Edeling, W., Lakhlili, J., Sinclair, R.C., Jancauskas, V., Suleimenova, D., Bosak, B., Kulczewski, M., Piontek, T., Kopta, P., Chirca, I., Arabnejad, H., Luk, O.O., Hoenen, O., Weglarz, J., Crommelin, D., Groen, D. and Coveney, P.V. (2020), Building Confidence in Simulation: Applications of EasyVVUQ. Adv. Theory Simul., 3: 1900246.
0 commit comments