Skip to content

Commit be0d119

Browse files
authored
Merge pull request #362 from UCL-CCS/doc-updates
Update README.md
2 parents 7fc359b + 313b0dc commit be0d119

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

+20-12
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3796/badge)](https://bestpractices.coreinfrastructure.org/projects/3796)
99
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/UCL-CCS/EasyVVUQ/dev?filepath=tutorials)
1010

11-
You can find the API Documentation on our [GitHub Pages](https://ucl-ccs.github.io/EasyVVUQ/).
12-
1311
The aim of EasyVVUQ is to facilitate verification, validation and
1412
uncertainty quantification (VVUQ) for a wide variety of
1513
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:
2321

2422
It also lets you construct surrogate models that are cheaper to evaluate than the complete simulation.
2523

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](
27-
https://mybinder.org/v2/gh/UCL-CCS/EasyVVUQ/bdd866c5d5d1f61140b776ec9ac47791b928a7cf?filepath=tutorials%2Fencoder_decoder_tutorial.ipynb) notebook.
24+
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
2832

2933
Available analysis and sampling methods:
3034

@@ -42,18 +46,18 @@ EasyVVUQ also supports building surrogate models using:
4246
Supported computing resources:
4347

4448
* Traditional clusters
45-
* [Kubernetes clusters](https://mybinder.org/v2/gh/UCL-CCS/EasyVVUQ/a9195fa1423d731ed996c9a5e34bb1256c6a0d5b?filepath=tutorials%2Fkubernetes_tutorial.ipynb)
49+
* Kubernetes clusters
4650

47-
The easiest way to get started is to follow the tutorials in our
51+
The easiest way to get familiar with the provided functionality is to follow the tutorials (*\*.ipynb* files) in our
4852
[Binder](https://mybinder.org/v2/gh/UCL-CCS/EasyVVUQ/dev?filepath=tutorials).
4953

50-
Development was funded by the EU Horizon 2020 project [VECMA](http://www.vecma.eu/).
54+
## Installation instructions
5155

52-
## Requirements
56+
### Requirements
5357

5458
To use the library you will need Python 3.7+.
5559

56-
## Installation using pip
60+
### Installation using pip
5761

5862
If you are unsure of the version of python your default `pip` works for type:
5963
```
@@ -73,7 +77,7 @@ To upgrade the library use:
7377
pip install easyvvuq --upgrade
7478
```
7579

76-
## Manual installation from repository
80+
### Manual installation from repository
7781

7882
Alternatively, you can manually install EasyVVUQ.
7983
First clone the repository to your computer:
@@ -95,9 +99,9 @@ Then the library can be installed using:
9599
python setup.py install
96100
```
97101

98-
## Getting Started
102+
## API
99103

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/).
101105

102106
## Citing EasyVVUQ
103107

@@ -108,3 +112,7 @@ Journal of Open Research Software, 8: 11.
108112
109113
> 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.
110114
> [DOI: 10.1002/adts.201900246](https://doi.org/10.1002/adts.201900246).
115+
116+
## Acknowledgments
117+
118+
Development was funded by the EU Horizon 2020 project [VECMA](http://www.vecma.eu/).

0 commit comments

Comments
 (0)