easyvvuq.constants

 1"""Constants and Enums to set defaults and constrain selections
 2
 3
 4Attributes
 5----------
 6
 7default_campaign_prefix : str
 8    Text used to ensure campaign names are identifiable and somewhat human
 9    readable.
10"""
11from enum import Enum, IntEnum
12
13__copyright__ = """
14
15    Copyright 2018 Robin A. Richardson, David W. Wright
16
17    This file is part of EasyVVUQ
18
19    EasyVVUQ is free software: you can redistribute it and/or modify
20    it under the terms of the Lesser GNU General Public License as published by
21    the Free Software Foundation, either version 3 of the License, or
22    (at your option) any later version.
23
24    EasyVVUQ is distributed in the hope that it will be useful,
25    but WITHOUT ANY WARRANTY; without even the implied warranty of
26    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27    Lesser GNU General Public License for more details.
28
29    You should have received a copy of the Lesser GNU General Public License
30    along with this program.  If not, see <https://www.gnu.org/licenses/>.
31
32"""
33__license__ = "LGPL"
34
35default_campaign_prefix = 'EasyVVUQ_Campaign_'
36
37
38class OutputType(Enum):
39    """
40    Types of data output by UQPs/VVPs
41    """
42
43    SAMPLE = 'sample'
44    ARRAY = 'array'
45    SAMPLE_ARRAY = 'sample_array'
46    TRACK = 'track'
47    SUMMARY = 'summary'
48
49
50class Status(IntEnum):
51    """
52    Status of runs in the Run Table
53    """
54
55    NEW = 1
56    ENCODED = 2
57    COLLATED = 3
58    IGNORED = 4
59    INVALID = 5