README.md 1.38 KB
Newer Older
1
# ogsdatacompare
Feliks Kuba Kiszkurno's avatar
Feliks Kuba Kiszkurno committed
2
3
4

Python scripts that create different plot comparing results of OGS simulations

5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
## Usage
There are two ways of using ogs-data-compare.

You can provide a dictionary with settings:
```python
settings = { # Required parameters
            'parameter': 'parameter_to_observe',
            'path': 'path/to/experiment/folder', # os.path.join is recommended
            'points_file': 'path/to/observation/points/definition/file.csv',  # os.path.join is recommended 
            
            # Optional parameters
            'plot_ext': ['png'],
            'include_legend': True
            }

20
data_compare = ogsdatacompare.OGSDataCompare(settings)
21
22
23
```
or provide mandatory arguments later, when read_data() method is called:
```python
24
data_compare = ogsdatacompare.OGSDataCompare()
25
26
27
28
29
30
31
32
33
data_compare.read_data(path='path/to/experiment/folder',  # os.path.join is recommended
                       parameter='parameter_to_observe',
                       points_path='path/to/observation/points/definition/file.csv'  # os.path.join is recommended
                      )
```

Those two methods can be combined. For example settings dictionary can contain definitions for some optional parameters and mandatory ones can be defined when read_data() method is called.

## Manual
Feliks Kuba Kiszkurno's avatar
Feliks Kuba Kiszkurno committed
34
For more detailed description, please see Documentation/ogs_compare.md or the example jupyter notebook in Documentation/Example.