Manel-Hammouda commited on
Commit
ff646ed
·
2 Parent(s): fba66fa689804e

Merge master into main: publish curated v1.1.0 content

Browse files
Files changed (4) hide show
  1. .gitattributes +1 -36
  2. AlgorithmScm.fmu +2 -2
  3. LICENSE +281 -0
  4. README.md +84 -0
.gitattributes CHANGED
@@ -1,36 +1 @@
1
- *.7z filter=lfs diff=lfs merge=lfs -text
2
- *.arrow filter=lfs diff=lfs merge=lfs -text
3
- *.bin filter=lfs diff=lfs merge=lfs -text
4
- *.bz2 filter=lfs diff=lfs merge=lfs -text
5
- *.ckpt filter=lfs diff=lfs merge=lfs -text
6
- *.ftz filter=lfs diff=lfs merge=lfs -text
7
- *.gz filter=lfs diff=lfs merge=lfs -text
8
- *.h5 filter=lfs diff=lfs merge=lfs -text
9
- *.joblib filter=lfs diff=lfs merge=lfs -text
10
- *.lfs.* filter=lfs diff=lfs merge=lfs -text
11
- *.mlmodel filter=lfs diff=lfs merge=lfs -text
12
- *.model filter=lfs diff=lfs merge=lfs -text
13
- *.msgpack filter=lfs diff=lfs merge=lfs -text
14
- *.npy filter=lfs diff=lfs merge=lfs -text
15
- *.npz filter=lfs diff=lfs merge=lfs -text
16
- *.onnx filter=lfs diff=lfs merge=lfs -text
17
- *.ot filter=lfs diff=lfs merge=lfs -text
18
- *.parquet filter=lfs diff=lfs merge=lfs -text
19
- *.pb filter=lfs diff=lfs merge=lfs -text
20
- *.pickle filter=lfs diff=lfs merge=lfs -text
21
- *.pkl filter=lfs diff=lfs merge=lfs -text
22
- *.pt filter=lfs diff=lfs merge=lfs -text
23
- *.pth filter=lfs diff=lfs merge=lfs -text
24
- *.rar filter=lfs diff=lfs merge=lfs -text
25
- *.safetensors filter=lfs diff=lfs merge=lfs -text
26
- saved_model/**/* filter=lfs diff=lfs merge=lfs -text
27
- *.tar.* filter=lfs diff=lfs merge=lfs -text
28
- *.tar filter=lfs diff=lfs merge=lfs -text
29
- *.tflite filter=lfs diff=lfs merge=lfs -text
30
- *.tgz filter=lfs diff=lfs merge=lfs -text
31
- *.wasm filter=lfs diff=lfs merge=lfs -text
32
- *.xz filter=lfs diff=lfs merge=lfs -text
33
- *.zip filter=lfs diff=lfs merge=lfs -text
34
- *.zst filter=lfs diff=lfs merge=lfs -text
35
- *tfevents* filter=lfs diff=lfs merge=lfs -text
36
- AlgorithmScm.fmu filter=lfs diff=lfs merge=lfs -text
 
1
+ *.fmu filter=lfs diff=lfs merge=lfs -text
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
AlgorithmScm.fmu CHANGED
@@ -1,3 +1,3 @@
1
  version https://git-lfs.github.com/spec/v1
2
- oid sha256:6f7ae27f20a6ec5e1f921bdcf00331a09bfd669bfbb067268726c30518f37ce7
3
- size 144205396
 
1
  version https://git-lfs.github.com/spec/v1
2
+ oid sha256:b37efaed3e4d42d38615a843bfaf18fcbc55d48f77949de6f63d8f1216af52ae
3
+ size 4596158
LICENSE ADDED
@@ -0,0 +1,281 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Eclipse Public License - v 2.0
2
+
3
+ THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
4
+ PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
5
+ OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
6
+
7
+ 1. DEFINITIONS
8
+
9
+ "Contribution" means:
10
+
11
+ a) in the case of the initial Contributor, the initial content
12
+ Distributed under this Agreement, and
13
+
14
+ b) in the case of each subsequent Contributor:
15
+ i) changes to the Program, and
16
+ ii) additions to the Program;
17
+
18
+ where such changes and/or additions to the Program originate from
19
+ and are Distributed by that particular Contributor. A Contribution
20
+ "originates" from a Contributor if it was added to the Program by
21
+ such Contributor itself or anyone acting on such Contributor's behalf.
22
+ Contributions do not include changes or additions to the Program that
23
+ are not Modified Works.
24
+
25
+ "Contributor" means any person or entity that Distributes the Program.
26
+
27
+ "Licensed Patents" mean patent claims licensable by a Contributor which
28
+ are necessarily infringed by the use or sale of its Contribution alone
29
+ or when combined with the Program.
30
+
31
+ "Program" means the Contributions Distributed in accordance with this
32
+ Agreement.
33
+
34
+ "Recipient" means anyone who receives the Program under this Agreement
35
+ or any Secondary License (as applicable), including Contributors.
36
+
37
+ "Derivative Works" shall mean any work, whether in Source Code or other
38
+ form, that is based on (or derived from) the Program and for which the
39
+ editorial revisions, annotations, elaborations, or other modifications
40
+ represent, as a whole, an original work of authorship.
41
+
42
+ "Modified Works" shall mean any work in Source Code or other form that
43
+ results from an addition to, deletion from, or modification of the
44
+ contents of the Program, including, for purposes of clarity any new
45
+ file in Source Code form that contains any contents of the Program.
46
+ Modified Works shall not include works that contain only declarations,
47
+ interfaces, types, classes, structures, or files of the Program solely
48
+ in each case in order to link to, bind by name, or subclass the Program
49
+ or Modified Works thereof.
50
+
51
+ "Distribute" means the acts of a) distributing or b) making available
52
+ in any manner that enables the transfer of a copy.
53
+
54
+ "Source Code" means the form of a Program preferred for making
55
+ modifications, including but not limited to software source code,
56
+ documentation source, and configuration files.
57
+
58
+ "Secondary License" means either the GNU General Public License,
59
+ Version 2.0, or any later versions of that license, including any
60
+ exceptions or additional permissions as identified by the initial
61
+ Contributor.
62
+
63
+ 2. GRANT OF RIGHTS
64
+
65
+ a) Subject to the terms of this Agreement, each Contributor hereby
66
+ grants Recipient a non-exclusive, worldwide, royalty-free copyright
67
+ license to reproduce, prepare Derivative Works of, publicly display,
68
+ publicly perform, Distribute and sublicense the Contribution of such
69
+ Contributor, if any, and such Derivative Works.
70
+
71
+ b) Subject to the terms of this Agreement, each Contributor hereby
72
+ grants Recipient a non-exclusive, worldwide, royalty-free patent
73
+ license under Licensed Patents to make, use, sell, offer to sell,
74
+ import and otherwise transfer the Contribution of such Contributor,
75
+ if any, in Source Code or other form. This patent license shall
76
+ apply to the combination of the Contribution and the Program if, at
77
+ the time the Contribution is added by the Contributor, such addition
78
+ of the Contribution causes such combination to be covered by the
79
+ Licensed Patents. The patent license shall not apply to any other
80
+ combinations which include the Contribution. No hardware per se is
81
+ licensed hereunder.
82
+
83
+ c) Recipient understands that although each Contributor grants the
84
+ licenses to its Contributions set forth herein, no assurances are
85
+ provided by any Contributor that the Program does not infringe the
86
+ patent or other intellectual property rights of any other entity.
87
+ Each Contributor disclaims any liability to Recipient for claims
88
+ brought by any other entity based on infringement of intellectual
89
+ property rights or otherwise. As a condition to exercising the
90
+ rights and licenses granted hereunder, each Recipient hereby
91
+ assumes sole responsibility to secure any other intellectual
92
+ property rights needed, if any. For example, if a third party
93
+ patent license is required to allow Recipient to Distribute the
94
+ Program, it is Recipient's responsibility to acquire that license
95
+ before distributing the Program.
96
+
97
+ d) Each Contributor represents that to its knowledge it has
98
+ sufficient copyright rights in its Contribution, if any, to grant
99
+ the copyright license set forth in this Agreement.
100
+
101
+ e) Notwithstanding the terms of any Secondary License, no
102
+ Contributor makes additional grants to any Recipient (other than
103
+ those set forth in this Agreement) as a result of such Recipient's
104
+ receipt of the Program under the terms of a Secondary License
105
+ (if permitted under the terms of Section 3).
106
+
107
+ 3. REQUIREMENTS
108
+
109
+ 3.1 If a Contributor Distributes the Program in any form, then:
110
+
111
+ a) the Program must also be made available as Source Code, in
112
+ accordance with section 3.2, and the Contributor must accompany
113
+ the Program with a statement that the Source Code for the Program
114
+ is available under this Agreement, and informs Recipients how to
115
+ obtain it in a reasonable manner on or through a medium customarily
116
+ used for software exchange; and
117
+
118
+ b) the Contributor may Distribute the Program under a license
119
+ different than this Agreement, provided that such license:
120
+ i) effectively disclaims on behalf of all other Contributors all
121
+ warranties and conditions, express and implied, including
122
+ warranties or conditions of title and non-infringement, and
123
+ implied warranties or conditions of merchantability and fitness
124
+ for a particular purpose;
125
+
126
+ ii) effectively excludes on behalf of all other Contributors all
127
+ liability for damages, including direct, indirect, special,
128
+ incidental and consequential damages, such as lost profits;
129
+
130
+ iii) does not attempt to limit or alter the recipients' rights
131
+ in the Source Code under section 3.2; and
132
+
133
+ iv) requires any subsequent distribution of the Program by any
134
+ party to be under a license that satisfies the requirements of
135
+ this section 3.
136
+
137
+ 3.2 When the Program is Distributed as Source Code:
138
+
139
+ a) it must be made available under this Agreement, or if the
140
+ Program (i) is combined with other material in a separate file or
141
+ files made available under a Secondary License, and (ii) the
142
+ initial Contributor attached to the Source Code the notice
143
+ described in Exhibit A of this Agreement, then the Program may be
144
+ made available under the terms of such Secondary Licenses, and
145
+
146
+ b) a copy of this Agreement must be included with each copy of
147
+ the Program.
148
+
149
+ 3.3 Contributors may not remove or alter any copyright, patent,
150
+ trademark, attribution notices, disclaimers of warranty, or
151
+ limitations of liability ("notices") contained within the Program
152
+ from any copy of the Program which they Distribute, provided that
153
+ Contributors may add their own appropriate notices.
154
+
155
+ 4. COMMERCIAL DISTRIBUTION
156
+
157
+ Commercial distributors of software may accept certain
158
+ responsibilities with respect to end users, business partners and the
159
+ like. While this license is intended to facilitate the commercial use
160
+ of the Program, the Contributor who includes the Program in a
161
+ commercial product offering should do so in a manner which does not
162
+ create potential liability for other Contributors. Therefore, if a
163
+ Contributor includes the Program in a commercial product offering,
164
+ such Contributor ("Commercial Contributor") hereby agrees to defend
165
+ and indemnify every other Contributor ("Indemnified Contributor")
166
+ against any losses, damages and costs (collectively "Losses") arising
167
+ from claims, lawsuits and other legal actions brought by a third party
168
+ against the Indemnified Contributor to the extent caused by the acts
169
+ or omissions of such Commercial Contributor in connection with its
170
+ distribution of the Program in a commercial product offering. The
171
+ obligations in this section do not apply to any claims or Losses
172
+ relating to any actual or alleged intellectual property infringement.
173
+ In order to qualify, an Indemnified Contributor must: a) promptly
174
+ notify the Commercial Contributor in writing of such claim, and
175
+ b) allow the Commercial Contributor to control, and cooperate with
176
+ the Commercial Contributor in, the defense and any related settlement
177
+ negotiations. The Indemnified Contributor may participate in any such
178
+ claim at its own expense.
179
+
180
+ For example, a Contributor might include the Program in a commercial
181
+ product offering, Product X. That Contributor is then a Commercial
182
+ Contributor. If that Commercial Contributor then makes performance
183
+ claims, or offers warranties related to Product X, those performance
184
+ claims and warranties are such Commercial Contributor's responsibility
185
+ alone. Under this section, the Commercial Contributor would have to
186
+ defend claims against the other Contributors related to those
187
+ performance claims and warranties, and if a court requires any other
188
+ Contributor to pay any damages as a result, the Commercial Contributor
189
+ must pay those damages.
190
+
191
+ 5. NO WARRANTY
192
+
193
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
194
+ PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
195
+ BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
196
+ IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
197
+ TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
198
+ PURPOSE. Each Recipient is solely responsible for determining the
199
+ appropriateness of using and distributing the Program and assumes all
200
+ risks associated with its exercise of rights under this Agreement,
201
+ including but not limited to the risks and costs of program errors,
202
+ compliance with applicable laws, damage to or loss of data, programs
203
+ or equipment, and unavailability or interruption of operations.
204
+
205
+ 6. DISCLAIMER OF LIABILITY
206
+
207
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
208
+ PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
209
+ SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
210
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
211
+ PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
212
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
213
+ ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR
214
+ THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
215
+ POSSIBILITY OF SUCH DAMAGES.
216
+
217
+ 7. GENERAL
218
+
219
+ If any provision of this Agreement is invalid or unenforceable under
220
+ applicable law, it shall not affect the validity or enforceability of
221
+ the remainder of the terms of this Agreement, and without further
222
+ action by the parties hereto, such provision shall be reformed to the
223
+ minimum extent necessary to make such provision valid and enforceable.
224
+
225
+ If Recipient institutes patent litigation against any entity
226
+ (including a cross-claim or counterclaim in a lawsuit) alleging that
227
+ the Program itself (excluding combinations of the Program with other
228
+ software or hardware) infringes such Recipient's patent(s), then such
229
+ Recipient's rights granted under Section 2(b) shall terminate as of
230
+ the date such litigation is filed.
231
+
232
+ All Recipient's rights under this Agreement shall terminate if it
233
+ fails to comply with any of the material terms or conditions of this
234
+ Agreement and does not cure such failure in a reasonable period of
235
+ time after becoming aware of such noncompliance. If all Recipient's
236
+ rights under this Agreement terminate, Recipient agrees to cease use
237
+ and distribution of the Program as soon as reasonably practicable.
238
+ However, Recipient's obligations under this Agreement and any licenses
239
+ granted by Recipient relating to the Program shall continue and
240
+ survive.
241
+
242
+ Everyone is permitted to copy and distribute copies of this Agreement,
243
+ but in order to avoid inconsistency the Agreement is copyrighted and
244
+ may only be modified in the following manner. The Agreement Steward
245
+ reserves the right to publish new versions (including revisions) of
246
+ this Agreement from time to time. No one other than the Agreement
247
+ Steward has the right to modify this Agreement. The Eclipse Foundation
248
+ is the initial Agreement Steward. The Eclipse Foundation may assign
249
+ the responsibility to serve as the Agreement Steward to a suitable
250
+ separate entity. Each new version of the Agreement will be given a
251
+ distinguishing version number. The Program (including Contributions)
252
+ may always be Distributed subject to the version of the Agreement
253
+ under which it was received. In addition, after a new version of the
254
+ Agreement is published, Contributor may elect to Distribute the
255
+ Program (including its Contributions) under the new version.
256
+
257
+ Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
258
+ receives no rights or licenses to the intellectual property of any
259
+ Contributor under this Agreement, whether expressly, by implication,
260
+ estoppel or otherwise. All rights in the Program not expressly granted
261
+ under this Agreement are reserved. Nothing in this Agreement is
262
+ intended to be enforceable by any entity that is not a Contributor or
263
+ Recipient. No third-party beneficiary rights are created under this
264
+ Agreement.
265
+
266
+ Exhibit A - Form of Secondary Licenses Notice
267
+
268
+ "This Source Code may also be made available under the following
269
+ Secondary Licenses when the conditions for such availability set forth
270
+ in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
271
+ version(s), and exceptions or additional permissions here}."
272
+
273
+ Simply including a copy of this Agreement, including this Exhibit A
274
+ is not sufficient to license the Source Code under Secondary Licenses.
275
+
276
+ If it is not possible or desirable to put the notice in a particular
277
+ file, then You may include the notice in a location (such as a LICENSE
278
+ file in a relevant directory) where a recipient would be likely to
279
+ look for such a notice.
280
+
281
+ You may add additional accurate notices of copyright ownership.
README.md CHANGED
@@ -1,3 +1,87 @@
1
  ---
2
  license: epl-2.0
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: epl-2.0
3
+ tags:
4
+ - simulation
5
+ - automotive
6
+ - driver-behavior
7
+ - fmu
8
+ - fmi
9
+ - openpass
10
+ - stochastic
11
+ language: []
12
  ---
13
+
14
+ # AlgorithmScm — Stochastic Cognitive Model (FMU)
15
+
16
+ > **⚠️ PREVIEW / EXPERIMENTAL — v1.1.0**
17
+ >
18
+ > This is an early preview of the latest SCM updates, which have not yet been
19
+ > officially published on the [Eclipse SCM project](https://gitlab.eclipse.org/eclipse/scm/scm).
20
+ > It is intended for early evaluation and feedback ahead of the official release.
21
+ > Interfaces, parameters, and behavior may change without notice in future versions.
22
+ > Not recommended for production use.
23
+
24
+ ---
25
+
26
+ ## What is SCM?
27
+
28
+ The **Stochastic Cognitive Model (SCM)** is a driver behavior model for traffic simulations and safety analysis.
29
+ It simulates the full chain of human driving cognition:
30
+
31
+ 1. **Sensory perception** — gaze behavior and attention allocation
32
+ 2. **Information handling** — processing and prioritization of traffic information
33
+ 3. **Decision making** — gap acceptance, lane change decisions, speed regulation
34
+ 4. **Action execution** — longitudinal and lateral vehicle control
35
+
36
+ SCM models inter- and intra-individual variation in driver behavior through stochastic parameters,
37
+ enabling realistic simulation of traffic flow and critical driving situations.
38
+ It currently supports **highway** scenarios.
39
+
40
+ SCM integrates with [OpenPASS](https://gitlab.eclipse.org/eclipse/openpass/opSimulation)
41
+ as an FMU component, but is maintained as a separate [Eclipse project](https://gitlab.eclipse.org/eclipse/scm/scm).
42
+
43
+ ---
44
+
45
+ ## Repository Contents
46
+
47
+ | File | Description |
48
+ |------|-------------|
49
+ | `AlgorithmScm.fmu` | Compiled FMU binary (FMI 2.0, Co-Simulation) |
50
+ | `LICENSE` | Eclipse Public License v2.0 |
51
+ | `README.md` | This model card |
52
+
53
+ > Source code is not included in this release.
54
+
55
+ ---
56
+
57
+ ## System Requirements
58
+
59
+ - **FMI standard**: FMI 2.0 Co-Simulation
60
+ - **Simulation platform**: [OpenPASS opSimulation](https://gitlab.eclipse.org/eclipse/openpass/opSimulation)
61
+ - **OS**: Linux (x86-64)
62
+ - **Cycle time**: 100 ms (default, configurable)
63
+
64
+ ---
65
+
66
+ ## Integration with OpenPASS
67
+
68
+ Place `AlgorithmScm.fmu` in your OpenPASS installation directory and reference it in your
69
+ `ProfilesCatalog.xml` as an FMU1 component under the `AlgorithmScm` profile group, e.g.:
70
+
71
+ ```xml
72
+ <ProfileGroup Type="FMU1">
73
+ <Profile Name="RegularScm">
74
+ <String Key="FmuPath" Value="AlgorithmScm.fmu"/>
75
+ <!-- driver and vehicle parameters -->
76
+ </Profile>
77
+ </ProfileGroup>
78
+ ```
79
+
80
+ Refer to the SCM user guide for the full parameter reference and configuration examples.
81
+
82
+ ---
83
+
84
+ ## License
85
+
86
+ This software is distributed under the **Eclipse Public License v2.0** (EPL-2.0).
87
+ A copy of the license is included in this repository as `LICENSE`.