-
Notifications
You must be signed in to change notification settings - Fork 26
/
base.py
60 lines (42 loc) · 1.64 KB
/
base.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
"""Provides base class for all analysis elements.
"""
from .. import BaseElement
__copyright__ = """
Copyright 2018 Robin A. Richardson, David W. Wright
This file is part of EasyVVUQ
EasyVVUQ is free software: you can redistribute it and/or modify
it under the terms of the Lesser GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
EasyVVUQ is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Lesser GNU General Public License for more details.
You should have received a copy of the Lesser GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
"""
__license__ = "LGPL"
class BaseAnalysisElement(BaseElement):
"""Base class for all EasyVVUQ analysis elements.
Attributes
----------
"""
def analyse(self, data_frame=None):
"""Perform analysis on input `data_frame`.
Parameters
----------
data_frame : :obj:`pandas.DataFrame`
Input data for analysis.
Returns
-------
"""
raise NotImplementedError
def element_category(self):
"""Element type for logging and verification"""
return "analysis"
def element_name(self):
"""Name for this element for logging purposes"""
raise NotImplementedError
def element_version(self):
"""Version of this element for logging purposes"""
raise NotImplementedError