README.md 2.66 KB
Newer Older
1
2
3
4
5
# Contributing

It is highly recommended to contribute (report bugs, code, ideas, etc.) in the original repository. If you want to update the suq controller with the current master run the following git command from Vadere's root source code path:

```
6
git subtree pull --prefix Tools/SUQController git@gitlab.lrz.de:vadere/suq-controller.git master --squash
7
8
9
```


10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
### WORK IN PROGRESS

The suq-controller connects the modules "Surrogate Model" (S) and "Uncertainty Quantification" (UQ) (see other vadere Repos). 
The main functionality of the `suq-controller` is to query many differently parametrized VADERE scenarios and 
return the result of specified quantity of interests (QoI) in a convenient format ([pandas DataFrame](https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.html)). 


This git repository uses git large file storage (git-lfs). This allows to ship default VADERE models (larger .jar files.)
with the git repository. 

For developers: To install git-lfs follow the instructions [here](https://github.com/git-lfs/git-lfs/wiki/Installation)
In file `.gitattributes` in the repo shows the settings for git-lfs. 


### Glossary

Other words were used in this project to not confuse terminology with VADERE (such as `scenario` and `project`). 

* **container** is the parent folder of (multiple) environments
* **environment** is folder consisting of a specifed VADERE scenario that is intended to query
30
* **request** is an user request for a quantity of interest for the specific VADERE setting with the given the scenario 
31
32
33
set in the environment. A query can simulate VADERE for multiple scenario settings for the parameter variation 
(such as a full grid sampling).

34
## Getting started
35

36
Either install as a Python package or run the source code directly. Either way it is recommended to use Python>=3.6 
37
38

### Using the code
39
40
41



42
#### Use source directly:
43

44
45
46
47
48
Run the code from the source directly (without install), please check if you meet the requirements (see `requirements.txt` file). You can also run `pip3 install -r /path/to/requirements.txt`. Make also sure that the Python paths are set correctly (possibly add with `sys`). 

#### Install as Python package:

To install as a package `suqc` run 
49
50
51
52
```
python3 setup.py install
``` 

53
from the command line. (Note: In Linux this may have to be executed with `sudo`).
54
55
56
57
58
59
60

Test if the installed package was installed successfully by running:

```
python3 -c "import suqc; print(suqc.__version__)"
```

61
This command should print the installed version number (and potentially infos to set up required folder) in the terminal. In case an error was thrown the package is 
62
63
not installed successfully. 

64
### Introduction
65
66

See [SRC_PATH]/tutorial