Commit f49f95a1 authored by Feliks Kuba Kiszkurno's avatar Feliks Kuba Kiszkurno
Browse files

Some names were refactored in order to improve consistency

parent 1e89a0bb
# Documentation of ogs-Comapare
# Documentation of ogsdatacompare
Overview of functions in this package can be found in this document.
......@@ -46,7 +46,7 @@ Methods read_data and read_data_full assume that the input data is 2D. For 3D an
### ogs_compare_time_point
#### Syntax
```python
ogs_compare_time_point(time_step)
OGSDataCompare.ogs_compare_time_point(time_step)
```
Configuration dictionary is explained in "General setup" section, result_folder is an access path (both absolute and relative should work) to folder containing all experiments, time_step is a list of time steps at which the results will be compared given as an array. Each value in the time_step array will generate a separate figure.
......@@ -56,7 +56,7 @@ Creates plot with value of an output parameter (temperature, pressure, etc) on Y
### ogs_compare
#### Syntax
```python
ogs_compare()
OGSDataCompare.ogs_compare()
```
This function doesn't require any input.
Optional parameters:
......@@ -67,7 +67,7 @@ Creates a figure with separate subfigures for all observation points. Each of th
### ogs_compare_separate
#### Syntax
```python
ogs_compare_separate()
OGSDataCompare.ogs_compare_separate()
```
#### Goal
The same as ogs_compare but all subfigures are plotted and saved as separate figures and files.
......@@ -75,7 +75,7 @@ The same as ogs_compare but all subfigures are plotted and saved as separate fig
### ogs_compare_3D_view
#### Syntax
```python
ogs_compare_3d_view()
OGSDataCompare.ogs_compare_3d_view()
```
#### Goal
Creates a 3D comparing the output parameter for all combinations of two tested parameters in the provided experiments. Each plot is for one time step and observation point combination. This function requires experiment folders being named in accordance with the convention discussed in "Naming convention" section.
......
# Ogs Data Compare
# ogsdatacompare
Python scripts that create different plot comparing results of OGS simulations
......@@ -17,11 +17,11 @@ settings = { # Required parameters
'include_legend': True
}
data_compare = OGSDataCompare(settings)
data_compare = ogsdatacompare.OGSDataCompare(settings)
```
or provide mandatory arguments later, when read_data() method is called:
```python
data_compare = OGSDataCompare()
data_compare = ogsdatacompare.OGSDataCompare()
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
......
from ogs_compare import OGSDataCompare
from ogsdatacompare.ogs_data_compare import OGSDataCompare
import os
......@@ -14,10 +14,10 @@ settings = {'parameter': 'pressure',
data_compare = OGSDataCompare(settings)
data_compare.read_data()
#data_compare.read_data_full()
#data_compare.plot_min_max()
#data_compare.ogs_compare()
#data_compare.ogs_compare_separate()
#data_compare.ogs_compare_time_point(time_step=[1.0, 2.0, 3.0, 4.0, 5.0])
data_compare.ogs_compare_separate()
data_compare.ogs_compare_time_point(time_step=[2.3, 2.7])
data_compare.ogs_compare_3d_view(time_step=[2.3, 2.7]) # time_step=[1.0, 2.0, 3.0, 4.0, 5.0])
data_compare.read_data_full()
data_compare.plot_min_max()
from .Tools.points import load_points, plot_points
from .Tools.detect_experiments import detect_experiments, getfilesbyextension
from .ogs_compare import OGSDataCompare
aiohttp==3.8.1
aiosignal==1.2.0
async-timeout==4.0.2
attrs==21.4.0
cftime==1.6.0
charset-normalizer==2.0.12
cycler==0.11.0
dill==0.3.4
fonttools==4.33.1
frozenlist==1.3.0
idna==3.3
kiwisolver==1.4.2
lxml==4.8.0
matplotlib==3.5.1
multidict==6.0.2
multiprocess==0.70.12.2
netCDF4==1.5.8
numpy==1.22.3
ogs6py==0.332
packaging==21.3
pandas==1.4.2
pathos==0.2.8
patsy==0.5.2
Pillow==9.1.0
pox==0.3.0
ppft==1.6.6.4
pyDOE2==1.3.0
pyparsing==3.0.8
python-dateutil==2.8.2
pytz==2022.1
SALib==1.4.5
scipy==1.8.0
six==1.16.0
statsmodels==0.13.2
vtk==9.1.0
VTUinterface @ file:///home/kiszkurn/Downloads/VTUinterface-master
wslink==1.5.3
yarl==1.7.2
pandas~=1.4.3
matplotlib~=3.5.2
numpy~=1.23.1
# vtuIO
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment