fameio 1.8.2__py3-none-any.whl → 2.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. CHANGELOG.md +224 -0
  2. fameio/scripts/__init__.py +8 -6
  3. fameio/scripts/__init__.py.license +3 -0
  4. fameio/scripts/convert_results.py +31 -35
  5. fameio/scripts/convert_results.py.license +3 -0
  6. fameio/scripts/make_config.py +14 -17
  7. fameio/scripts/make_config.py.license +3 -0
  8. fameio/source/cli/__init__.py +3 -0
  9. fameio/source/cli/convert_results.py +84 -0
  10. fameio/source/cli/make_config.py +62 -0
  11. fameio/source/cli/options.py +58 -0
  12. fameio/source/cli/parser.py +238 -0
  13. fameio/source/loader.py +10 -11
  14. fameio/source/logs.py +90 -35
  15. fameio/source/results/conversion.py +11 -13
  16. fameio/source/results/csv_writer.py +16 -5
  17. fameio/source/results/data_transformer.py +6 -22
  18. fameio/source/results/input_dao.py +163 -0
  19. fameio/source/results/reader.py +25 -14
  20. fameio/source/results/yaml_writer.py +28 -0
  21. fameio/source/scenario/agent.py +56 -39
  22. fameio/source/scenario/attribute.py +9 -12
  23. fameio/source/scenario/contract.py +55 -40
  24. fameio/source/scenario/exception.py +11 -9
  25. fameio/source/scenario/generalproperties.py +11 -17
  26. fameio/source/scenario/scenario.py +19 -14
  27. fameio/source/schema/agenttype.py +75 -27
  28. fameio/source/schema/attribute.py +8 -7
  29. fameio/source/schema/java_packages.py +69 -0
  30. fameio/source/schema/schema.py +44 -15
  31. fameio/source/series.py +148 -25
  32. fameio/source/time.py +8 -8
  33. fameio/source/tools.py +13 -2
  34. fameio/source/validator.py +138 -58
  35. fameio/source/writer.py +120 -113
  36. fameio-2.1.0.dist-info/LICENSES/Apache-2.0.txt +178 -0
  37. fameio-2.1.0.dist-info/LICENSES/CC-BY-4.0.txt +395 -0
  38. fameio-2.1.0.dist-info/LICENSES/CC0-1.0.txt +121 -0
  39. {fameio-1.8.2.dist-info → fameio-2.1.0.dist-info}/METADATA +706 -660
  40. fameio-2.1.0.dist-info/RECORD +53 -0
  41. {fameio-1.8.2.dist-info → fameio-2.1.0.dist-info}/WHEEL +1 -2
  42. fameio-2.1.0.dist-info/entry_points.txt +4 -0
  43. fameio/source/cli.py +0 -253
  44. fameio-1.8.2.dist-info/RECORD +0 -40
  45. fameio-1.8.2.dist-info/entry_points.txt +0 -3
  46. fameio-1.8.2.dist-info/top_level.txt +0 -1
  47. {fameio-1.8.2.dist-info → fameio-2.1.0.dist-info}/LICENSE.txt +0 -0
fameio/source/writer.py CHANGED
@@ -1,14 +1,18 @@
1
- # SPDX-FileCopyrightText: 2023 German Aerospace Center <fame@dlr.de>
1
+ # SPDX-FileCopyrightText: 2024 German Aerospace Center <fame@dlr.de>
2
2
  #
3
3
  # SPDX-License-Identifier: Apache-2.0
4
4
 
5
- import logging as log
6
- import os.path
7
5
  from pathlib import Path
8
- from typing import Any, Dict
6
+ from typing import Any, Dict, List, Union
9
7
 
10
- import pandas as pd
11
- from fameio.source.logs import log_error_and_raise
8
+ from fameprotobuf.DataStorage_pb2 import DataStorage
9
+ from fameprotobuf.InputFile_pb2 import InputData
10
+ from fameprotobuf.Field_pb2 import NestedField
11
+ from fameprotobuf.Contract_pb2 import ProtoContract
12
+ from fameprotobuf.Model_pb2 import ModelData
13
+
14
+ from fameio.source.logs import log_error_and_raise, log
15
+ from fameio.source.results.reader import Reader
12
16
  from fameio.source.scenario import (
13
17
  Agent,
14
18
  Attribute,
@@ -16,12 +20,12 @@ from fameio.source.scenario import (
16
20
  GeneralProperties,
17
21
  Scenario,
18
22
  )
19
- from fameio.source.path_resolver import PathResolver
23
+ from fameio.source.schema import Schema
20
24
  from fameio.source.schema.attribute import AttributeSpecs, AttributeType
25
+ from fameio.source.schema.java_packages import JavaPackages
21
26
  from fameio.source.series import TimeSeriesManager
22
- from fameio.source.time import START_IN_REAL_TIME, ConversionException, FameTime
27
+ from fameio.source.time import FameTime
23
28
  from fameio.source.tools import ensure_is_list
24
- from fameprotobuf import DataStorage_pb2
25
29
 
26
30
 
27
31
  class ProtoWriterException(Exception):
@@ -33,107 +37,107 @@ class ProtoWriterException(Exception):
33
37
  class ProtoWriter:
34
38
  """Writes a given scenario to protobuf file"""
35
39
 
40
+ _FAME_PROTOBUF_STREAM_HEADER = "famecoreprotobufstreamfilev001" # noqa
41
+
36
42
  _TYPE_NOT_IMPLEMENTED = "AttributeType '{}' not implemented."
37
- _NOT_TIME_SERIES = "Cannot convert value '{}' to TimeSeries."
38
43
  _CONTRACT_UNSUPPORTED = (
39
44
  "Unsupported value for Contract Attribute '{}'; "
40
45
  "Only support `int`, `float`, `enum` or `dict` types are supported here."
41
46
  )
42
47
  _USING_DEFAULT = "Using provided Default for Attribute: '{}'."
43
- _CORRUPT_TIME_SERIES_VALUE = "TimeSeries file '{}' is corrupt: At least one entry in value column is not numeric."
44
- _CORRUPT_TIME_SERIES_KEY = "TimeSeries file '{}' is corrupt: At least one entry in first column is not a timestamp."
45
- _TIME_SERIES_FILE_NOT_FOUND = "Cannot find TimeSeries file '{}'."
46
48
  _NO_FILE_SPECIFIED = "Could not write to '{}'. Please specify a valid output file."
47
49
 
48
- def __init__(self, file_path: Path, path_resolver=PathResolver()) -> None:
49
- self.file_path = file_path
50
- self.time_series_manager = TimeSeriesManager()
51
- self._path_resolver = path_resolver
50
+ _INFO_WRITING = "Writing scenario to protobuf file `{}`"
51
+ _INFO_WRITING_COMPLETED = "Saved protobuf file `{}` to disk"
52
+
53
+ def __init__(self, file_path: Path, time_series_manager: TimeSeriesManager) -> None:
54
+ self.file_path: Path = file_path
55
+ self._time_series_manager: TimeSeriesManager = time_series_manager
52
56
 
53
57
  def write_validated_scenario(self, scenario: Scenario) -> None:
54
58
  """Writes given validated Scenario to file"""
55
- log.info("Writing scenario to protobuf file `{}`".format(self.file_path))
56
- pb_data_storage = DataStorage_pb2.DataStorage()
57
- pb_input = pb_data_storage.input
58
-
59
- log.info("Adding General Properties")
60
- ProtoWriter._set_general_properties(pb_input, scenario.general_properties)
61
-
62
- log.info("Adding Agents")
63
- schema = scenario.schema
64
- for agent in scenario.agents:
65
- pb_agent = ProtoWriter._set_agent(pb_input.agent.add(), agent)
66
- attribute_specs = schema.agent_types[agent.type_name].attributes
67
- self._set_attributes(pb_agent, agent.attributes, attribute_specs)
59
+ pb_data_storage = self._create_protobuf_from_scenario(scenario)
60
+ self._write_protobuf_to_disk(pb_data_storage)
68
61
 
69
- log.info("Adding Contracts")
70
- for contract in scenario.contracts:
71
- pb_contract = ProtoWriter._set_contract(pb_input.contract.add(), contract)
72
- ProtoWriter._set_contract_attributes(pb_contract, contract.attributes)
62
+ def _create_protobuf_from_scenario(self, scenario: Scenario) -> DataStorage:
63
+ """Returns given `scenario` written to new DataStorage protobuf"""
64
+ log().info("Converting scenario to protobuf.")
65
+ pb_data_storage = DataStorage()
66
+ pb_input = pb_data_storage.input
73
67
 
74
- log.info("Adding TimeSeries")
68
+ self._set_general_properties(pb_input, scenario.general_properties)
69
+ self._add_agents(pb_input, scenario.agents, scenario.schema)
70
+ self._add_contracts(pb_input, scenario.contracts)
75
71
  self._set_time_series(pb_input)
76
- log.info("Writing to disk")
77
- self._write_protobuf_to_disk(pb_data_storage)
72
+ self._set_schema(pb_input, scenario.schema)
73
+
74
+ self._set_java_package_names(pb_data_storage.model, scenario.schema.packages)
75
+ return pb_data_storage
78
76
 
79
77
  @staticmethod
80
- def _set_general_properties(pb_input, gen_props: GeneralProperties) -> None:
81
- """Saves Scenario's general properties to specified protobuf `pb_input` container"""
82
- pb_input.runId = gen_props.run_id
83
- pb_input.simulation.startTime = gen_props.simulation_start_time
84
- pb_input.simulation.stopTime = gen_props.simulation_stop_time
85
- pb_input.simulation.randomSeed = gen_props.simulation_random_seed
86
- pb_input.output.interval = gen_props.output_interval
87
- pb_input.output.process = gen_props.output_process
78
+ def _set_general_properties(pb_input: InputData, general_properties: GeneralProperties) -> None:
79
+ """Saves a scenario's general properties to specified protobuf `pb_input` container"""
80
+ log().info("Adding General Properties")
81
+ pb_input.runId = general_properties.run_id
82
+ pb_input.simulation.startTime = general_properties.simulation_start_time
83
+ pb_input.simulation.stopTime = general_properties.simulation_stop_time
84
+ pb_input.simulation.randomSeed = general_properties.simulation_random_seed
85
+ pb_input.output.interval = general_properties.output_interval
86
+ pb_input.output.process = general_properties.output_process
87
+
88
+ def _add_agents(self, pb_input: InputData, agents: List[Agent], schema: Schema) -> None:
89
+ """Triggers setting of `agents` to `pb_input`"""
90
+ log().info("Adding Agents")
91
+ for agent in agents:
92
+ pb_agent = self._set_agent(pb_input.agent.add(), agent)
93
+ attribute_specs = schema.agent_types[agent.type_name].attributes
94
+ self._set_attributes(pb_agent, agent.attributes, attribute_specs)
95
+ pb_agent.metadata = repr(agent.meta_data)
88
96
 
89
97
  @staticmethod
90
- def _set_agent(pb_agent, agent: Agent):
91
- """Saves type and id of given `agent` to protobuf `pb_agent` container. Returns given `pb_agent`."""
98
+ def _set_agent(pb_agent: InputData.AgentDao, agent: Agent) -> InputData.AgentDao:
99
+ """Saves type and id of given `agent` to protobuf `pb_agent` container. Returns given `pb_agent`"""
92
100
  pb_agent.className = agent.type_name
93
101
  pb_agent.id = agent.id
94
102
  return pb_agent
95
103
 
96
104
  def _set_attributes(
97
105
  self,
98
- pb_parent,
106
+ pb_parent: Union[InputData.AgentDao, NestedField],
99
107
  attributes: Dict[str, Attribute],
100
108
  specs: Dict[str, AttributeSpecs],
101
109
  ) -> None:
102
110
  """Assigns `attributes` to protobuf fields of given `pb_parent` - cascades for nested Attributes"""
103
111
  values_not_set = [key for key in specs.keys()]
104
112
  for name, attribute in attributes.items():
105
- pb_field = ProtoWriter._add_field(pb_parent, name)
113
+ pb_field = self._add_field(pb_parent, name)
106
114
  attribute_specs = specs[name]
107
115
  values_not_set.remove(name)
108
116
  attribute_type = attribute_specs.attr_type
109
117
  if attribute_type is AttributeType.BLOCK:
110
118
  if attribute_specs.is_list:
111
119
  for index, entry in enumerate(attribute.nested_list):
112
- pb_inner = ProtoWriter._add_field(pb_field, str(index))
120
+ pb_inner = self._add_field(pb_field, str(index))
113
121
  self._set_attributes(pb_inner, entry, attribute_specs.nested_attributes)
114
122
  else:
115
- self._set_attributes(
116
- pb_field,
117
- attribute.nested,
118
- attribute_specs.nested_attributes,
119
- )
123
+ self._set_attributes(pb_field, attribute.nested, attribute_specs.nested_attributes)
120
124
  else:
121
125
  self._set_attribute(pb_field, attribute.value, attribute_type)
122
126
  for name in values_not_set:
123
127
  attribute_specs = specs[name]
124
128
  if attribute_specs.is_mandatory:
125
- pb_field = ProtoWriter._add_field(pb_parent, name)
129
+ pb_field = self._add_field(pb_parent, name)
126
130
  self._set_attribute(pb_field, attribute_specs.default_value, attribute_specs.attr_type)
127
- log.info(ProtoWriter._USING_DEFAULT.format(name))
131
+ log().info(self._USING_DEFAULT.format(name))
128
132
 
129
133
  @staticmethod
130
- def _add_field(pb_parent, name: str) -> Any:
134
+ def _add_field(pb_parent: Union[InputData.AgentDao, NestedField], name: str) -> NestedField:
131
135
  """Returns new field with given `name` that is added to given `pb_parent`"""
132
136
  pb_field = pb_parent.field.add()
133
137
  pb_field.fieldName = name
134
138
  return pb_field
135
139
 
136
- def _set_attribute(self, pb_field, value, attribute_type: AttributeType) -> None:
140
+ def _set_attribute(self, pb_field: NestedField, value: Any, attribute_type: AttributeType) -> None:
137
141
  """Sets given `value` to given protobuf `pb_field` depending on specified `attribute_type`"""
138
142
  if attribute_type is AttributeType.INTEGER:
139
143
  pb_field.intValue.extend(ensure_is_list(value))
@@ -146,63 +150,21 @@ class ProtoWriter:
146
150
  elif attribute_type in (AttributeType.ENUM, AttributeType.STRING):
147
151
  pb_field.stringValue.extend(ensure_is_list(value))
148
152
  elif attribute_type is AttributeType.TIME_SERIES:
149
- self._set_time_series_from_value(pb_field, value)
153
+ pb_field.seriesId = self._time_series_manager.get_series_id_by_identifier(value)
150
154
  else:
151
- log_error_and_raise(ProtoWriterException(ProtoWriter._TYPE_NOT_IMPLEMENTED.format(attribute_type)))
152
-
153
- def _set_time_series_from_value(self, pb_field, value):
154
- """Hands given `value` to TimeSeriesManager to assign a unique id which is then set to `pb_field`.seriesId"""
155
- if not isinstance(value, (str, int, float)):
156
- log_error_and_raise(ProtoWriterException(ProtoWriter._NOT_TIME_SERIES.format(str(value))))
157
- elif isinstance(value, str):
158
- value = Path(value).as_posix()
159
- pb_field.seriesId = self.time_series_manager.save_get_time_series_id(value)
160
-
161
- def _set_time_series(self, pb_input):
162
- """Adds all time series from TimeSeriesManager to given `pb_input`"""
163
- ids_of_series_by_name = self.time_series_manager.get_ids_of_series_by_name()
164
- for identifier, unique_id in ids_of_series_by_name.items():
165
- pb_series = pb_input.timeSeries.add()
166
- pb_series.seriesId = unique_id
167
- series_name, data_frame = self._get_series_as_dataframe(identifier)
168
- pb_series.seriesName = series_name
169
- try:
170
- ProtoWriter._add_rows_to_series(pb_series, data_frame)
171
- except TypeError:
172
- log_error_and_raise(ProtoWriterException(ProtoWriter._CORRUPT_TIME_SERIES_VALUE.format(identifier)))
173
- except ConversionException:
174
- log_error_and_raise(ProtoWriterException(ProtoWriter._CORRUPT_TIME_SERIES_KEY.format(identifier)))
175
-
176
- def _get_series_as_dataframe(self, identifier) -> (str, pd.DataFrame):
177
- """Returns a DataFrame containing the series obtained from the given `identifier` and an associated name"""
178
- if isinstance(identifier, str):
179
- # expect the string to be a file path
180
- series_path = self._path_resolver.resolve_series_file_path(identifier)
181
- if series_path and os.path.exists(series_path):
182
- return identifier, pd.read_csv(series_path, sep=";", header=None)
183
- log_error_and_raise(ProtoWriterException(ProtoWriter._TIME_SERIES_FILE_NOT_FOUND.format(identifier)))
184
- else:
185
- name = "Constant value: {}".format(identifier)
186
- return name, pd.DataFrame({"time": [START_IN_REAL_TIME], "value": [identifier]})
155
+ log_error_and_raise(ProtoWriterException(self._TYPE_NOT_IMPLEMENTED.format(attribute_type)))
187
156
 
188
157
  @staticmethod
189
- def _add_rows_to_series(series, data_frame):
190
- for key, value in data_frame.itertuples(index=False):
191
- row = series.row.add()
192
- row.timeStep = FameTime.convert_string_if_is_datetime(key)
193
- row.value = value
194
-
195
- def _write_protobuf_to_disk(self, pb_data_storage) -> None:
196
- """Writes given `protobuf_input_data` to disk"""
197
- try:
198
- with open(self.file_path, "wb") as file:
199
- file.write(pb_data_storage.SerializeToString())
200
- except OSError as e:
201
- log_error_and_raise(ProtoWriterException(ProtoWriter._NO_FILE_SPECIFIED.format(self.file_path), e))
202
- log.info("Saved protobuf file `{}` to disk".format(self.file_path))
158
+ def _add_contracts(pb_input: InputData, contracts: List[Contract]) -> None:
159
+ """Triggers setting of `contracts` to `pb_input`"""
160
+ log().info("Adding Contracts")
161
+ for contract in contracts:
162
+ pb_contract = ProtoWriter._set_contract(pb_input.contract.add(), contract)
163
+ ProtoWriter._set_contract_attributes(pb_contract, contract.attributes)
164
+ pb_contract.metadata = repr(contract.meta_data)
203
165
 
204
166
  @staticmethod
205
- def _set_contract(pb_contract, contract: Contract):
167
+ def _set_contract(pb_contract: ProtoContract, contract: Contract) -> ProtoContract:
206
168
  """Saves given `contract` details to protobuf container `pb_contract`. Returns given `pb_contract`"""
207
169
  pb_contract.senderId = contract.sender_id
208
170
  pb_contract.receiverId = contract.receiver_id
@@ -214,10 +176,12 @@ class ProtoWriter:
214
176
  return pb_contract
215
177
 
216
178
  @staticmethod
217
- def _set_contract_attributes(pb_parent, attributes: Dict[str, Attribute]) -> None:
179
+ def _set_contract_attributes(
180
+ pb_parent: Union[ProtoContract, NestedField], attributes: Dict[str, Attribute]
181
+ ) -> None:
218
182
  """Assign (nested) Attributes to given protobuf container `pb_parent`"""
219
183
  for name, attribute in attributes.items():
220
- log.debug("Assigning contract attribute `{}`.".format(name))
184
+ log().debug("Assigning contract attribute `{}`.".format(name))
221
185
  pb_field = ProtoWriter._add_field(pb_parent, name)
222
186
 
223
187
  if attribute.has_value:
@@ -232,3 +196,46 @@ class ProtoWriter:
232
196
  log_error_and_raise(ProtoWriterException(ProtoWriter._CONTRACT_UNSUPPORTED.format(str(attribute))))
233
197
  elif attribute.has_nested:
234
198
  ProtoWriter._set_contract_attributes(pb_field, attribute.nested)
199
+
200
+ def _set_time_series(self, pb_input: InputData) -> None:
201
+ """Adds all time series from TimeSeriesManager to given `pb_input`"""
202
+ log().info("Adding TimeSeries")
203
+ for unique_id, identifier, data in self._time_series_manager.get_all_series():
204
+ pb_series = pb_input.timeSeries.add()
205
+ pb_series.seriesId = unique_id
206
+ pb_series.seriesName = identifier
207
+ ProtoWriter._add_rows_to_series(pb_series, data)
208
+
209
+ @staticmethod
210
+ def _add_rows_to_series(series: InputData.TimeSeriesDao, data_frame) -> None:
211
+ for key, value in data_frame.itertuples(index=False):
212
+ row = series.row.add()
213
+ row.timeStep = int(key)
214
+ row.value = value
215
+
216
+ @staticmethod
217
+ def _set_schema(pb_input: InputData, schema: Schema) -> None:
218
+ """Sets the given `schema` `pb_input`"""
219
+ log().info("Adding Schema")
220
+ pb_input.schema = schema.to_string()
221
+
222
+ @staticmethod
223
+ def _set_java_package_names(pb_model: ModelData, java_packages: JavaPackages) -> None:
224
+ """Adds given JavaPackages names to given ModelData section"""
225
+ pb_packages = pb_model.packages
226
+ pb_packages.agent.extend(java_packages.agents)
227
+ pb_packages.dataItem.extend(java_packages.data_items)
228
+ pb_packages.portable.extend(java_packages.portables)
229
+
230
+ def _write_protobuf_to_disk(self, pb_data_storage: DataStorage) -> None:
231
+ """Writes given `protobuf_input_data` to disk"""
232
+ log().info(self._INFO_WRITING.format(self.file_path))
233
+ try:
234
+ with open(self.file_path, "wb") as file:
235
+ serialised_data_storage = pb_data_storage.SerializeToString()
236
+ file.write(self._FAME_PROTOBUF_STREAM_HEADER.encode(Reader.HEADER_ENCODING))
237
+ file.write(len(serialised_data_storage).to_bytes(Reader.BYTES_DEFINING_MESSAGE_LENGTH, byteorder="big"))
238
+ file.write(serialised_data_storage)
239
+ except OSError as e:
240
+ log_error_and_raise(ProtoWriterException(ProtoWriter._NO_FILE_SPECIFIED.format(self.file_path), e))
241
+ log().info(self._INFO_WRITING_COMPLETED.format(self.file_path))
@@ -0,0 +1,178 @@
1
+ Copyright 2020 German Aerospace Center
2
+
3
+ Apache License
4
+ Version 2.0, January 2004
5
+ http://www.apache.org/licenses/
6
+
7
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. Definitions.
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. Grant of Copyright License. Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. Grant of Patent License. Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. Redistribution. You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ (a) You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ (b) You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ (c) You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ (d) If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. Trademarks. This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. Disclaimer of Warranty. Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. Limitation of Liability. In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. Accepting Warranty or Additional Liability. While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ END OF TERMS AND CONDITIONS