Skip to content

Commit c3491a7

Browse files
committed
handled review comments
1 parent a00f113 commit c3491a7

4 files changed

Lines changed: 42 additions & 2 deletions

File tree

readme.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Probabilistic Library
2+
3+
This is the repository of the Probabilistic Library of Deltares.
4+
5+
The library provides a set of routines that enable reliability, uncertainty, and sensitivity analyses.
6+
7+
## Scientific background
8+
9+
The scientific background can be found here:
10+
[scientific_background.pdf](https://github.com/Deltares/ProbabilisticLibrary/releases/download/25.3.1/scientific_background.pdf)
11+
12+
## Python wrapper
13+
14+
You can access the routines of the library using a Python wrapper.
15+
A description of the Python classes is given here:
16+
[API documentation](https://deltares.github.io/ProbabilisticLibrary/api_reference/index.html.html)
17+
18+
### Installation
19+
20+
The installation file can be found in the [Python Package Index](https://pypi.org/project/probabilistic-library).
21+
The Probabilistic Library should be installed with pip, see the [getting started](https://deltares.github.io/ProbabilisticLibrary/installation.html#install-using-pip) explanation.
22+
23+
### Tutorials
24+
25+
See the [Tutorials](https://deltares.github.io/ProbabilisticLibrary/tutorials/tutorials.html) for several demonstrations and instructions on how to use the Probabilistic Library. Jupyter notebooks are available for each item and demonstrate how to use the Probabilistic Library.
26+
27+
## License
28+
29+
This library is released under the LGPL license. For full text of this license, refer to the [LICENSE](LICENSE) file.
30+
31+
## Developers section
32+
33+
Please check our [Wiki](https://github.com/Deltares/ProbabilisticLibrary/wiki) for more details.
34+
35+
## Contact
36+
For the wheel or additional information, contact:
37+
* Edwin Spee
38+
* Rob Brinkman
39+
* Karolina Wojciechowska
40+
* Matthias Hauth
-6.99 MB
Binary file not shown.

web/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ It consists of the following components:
2828

2929
Together, these components allow users to move seamlessly from exploratory analysis to automated workflows and large-scale studies.
3030

31-
The algorithms implemented in the Probabilistic Suite are described in detail in the `scientific background <./_static/scientific_background.pdf>`_.
31+
The algorithms implemented in the Probabilistic Suite are described in detail in the `scientific background <https://github.com/Deltares/ProbabilisticLibrary/releases/download/25.3.1/scientific_background.pdf>`_.
3232

3333

3434
----

web/run_tutorials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# Functionality
33

4-
The batch file `run_tutorials.bat` generates the rst file for the tutorials (`tutorials.rst`) and all needed image files. The files are placed in the [directory](https://github.com/Deltares/ProbabilisticLibrary/tree/master/web/gallery). After running the batch file, the gallery contents should be pushed to the repository.
4+
The batch file `run_tutorials.bat` generates the rst file for the tutorials (`tutorials.rst`) and all needed image files. The files are placed in the [directory](https://github.com/Deltares/ProbabilisticLibrary/tree/master/web/tutorials). After running the batch file, the tutorials contents should be pushed to the repository.
55

66
# Requirements
77

0 commit comments

Comments
 (0)