Skip to content

Commit 7130fe8

Browse files
caviricaviri
authored
Updated odtp.yml
1 parent ca256cf commit 7130fe8

2 files changed

Lines changed: 189 additions & 39 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,9 @@ If you want to kill the session just write `exit`. Also use `tmux ls` to list al
121121

122122
## Changelog
123123

124+
- v0.4.1
125+
- Updated `odtp.yml` to version v0.3.4 (https://github.com/odtp-org/odtp-component-template/commit/c4732294bb57bd5dfdc9630f4676f69462a3c07e)
126+
124127
- v0.4.0 Synthesis pipeline separated from matsim
125128
- Matsim pipeline: https://github.com/odtp-org/odtp-eqasim-matsim
126129

@@ -136,7 +139,7 @@ If you want to kill the session just write `exit`. Also use `tmux ls` to list al
136139
- Logger: If MongoDB arg. provided the container will log its activity in the db.
137140
- S3 Compatibility: Output content, and snapshots can be uploaded to the S3 server.
138141

139-
- v.0.0.1: Version compatible with IDF
142+
- v0.0.1: Version compatible with IDF
140143

141144
## Development.
142145

‎odtp.yml‎

Lines changed: 185 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,185 @@
1-
# This file should contain basic component information such as
2-
3-
- name: eqasim
4-
- repo: https://github.com/odtp-org/odtp-eqasim
5-
- author: "Author Test"
6-
- original_author: Author of the tool
7-
- description: Synthetic population for Matsim
8-
- arguments:
9-
- scenario: [idf, ch]
10-
- hts: [entd, egt]
11-
- sampling_rate: 0.001
12-
- random_seed: 1234
13-
- java_memory: 24G
14-
- generate_vehicles_file: True
15-
- generted_vehicels_method: fleet_sample
16-
- vehicles_data_year: 2015
17-
- volume:
18-
- data: /odtp/odtp-volume/data
19-
- ports:
20-
- api: 7100
21-
- logger: 7101
22-
- devices:
23-
- gpus: False
24-
- inputSchema: ...
25-
- outputSchema: ...
26-
- env:
27-
- ODTP_MONGO_SERVER
28-
- ODTP_S3_SERVER
29-
- ODTP_BUCKET_NAME
30-
- ODTP_ACCESS_KEY
31-
- ODTP_SECRET_KEY
32-
- ODTP_USER_ID
33-
- ODTP_DIGITAL_TWIN
34-
- ODTP_EXCUTION
35-
- ODTP_STEP
36-
- ODTP_COMPONENT
37-
- ODTP_COMPONENT_VERSION
38-
- ODTP_SAVE_SNAPSHOT
1+
# This file should contain basic component information for your component.
2+
component-name: odtp-eqasim-matsim
3+
component-author: Carlos Vivar Rios
4+
component-version: 0.4.1
5+
component-repository: https://github.com/odtp-org/odtp-eqasim
6+
component-license: BSD-3-Clause
7+
component-type: ephemeral
8+
component-description: ODTP component for running Eqasim Matsim Pipeline.
9+
tags:
10+
- mobility
11+
- eqasim
12+
- simulation
13+
14+
# Information about the tools
15+
tools:
16+
- tool-name: eqasim-org/ile-de-france
17+
tool-author: Hörl, S. and M. Balac
18+
tool-version: fb1112d2a7d1817746be84413da584c391059ad1
19+
tool-repository: https://github.com/eqasim-org/ile-de-france
20+
tool-license: GPL-2.0 License
21+
- tool-name: ivt-vpl/populations/ch-zh-synpop
22+
tool-author: Hörl, S. and M. Balac
23+
tool-version: 4658daa2e441dcda132622e7fcb47da1df8c47d6
24+
tool-repository: https://gitlab.ethz.ch/ivt-vpl/populations/ch-zh-synpop
25+
tool-license: GPL-2.0 License
26+
27+
# If your tool require some secrets token to be passed as ENV to the component
28+
# This won't be traced in MongoDB
29+
secrets: null
30+
31+
# If the tool requires some building arguments such as Matlab license
32+
build-args: null
33+
34+
# If applicable, ports exposed by the component
35+
# Include Name, Description, and Port Value for each port
36+
ports: null
37+
38+
# If applicable, parameters exposed by the component
39+
# Datatype can be str, int, float, or bool.
40+
parameters:
41+
- name: SCENARIO
42+
default-value: CORSICA
43+
datatype: string
44+
description: Type of desired scenario where to run the simulation. It should match the input data.
45+
options:
46+
- CORSICA
47+
- IDF
48+
- CH
49+
allow-custom-value: false
50+
- name: processes
51+
default-value: 4
52+
datatype: integer
53+
description: Number of processes to be used. Only compatible with SCENARIO equal to CORSICA or IDF
54+
parameter-bounds:
55+
- 0
56+
- inf
57+
options: null
58+
allow-custom-value: false
59+
- name: hts
60+
default-value: entd
61+
datatype: string
62+
description: To be developed
63+
parameter-bounds: null
64+
options:
65+
- entd
66+
- egt
67+
allow-custom-value: false
68+
- name: sampling_rate
69+
default-value: 0.001
70+
datatype: float
71+
description: To be defined
72+
parameter-bounds:
73+
- 0
74+
- 1
75+
options: null
76+
allow-custom-value: false
77+
- name: random_seed
78+
default-value: 1234
79+
datatype: integer
80+
description: Random seed.
81+
parameter-bounds:
82+
- 0
83+
- inf
84+
options: null
85+
allow-custom-value: false
86+
- name: java_memory
87+
default-value: 8GB
88+
datatype: string
89+
description: Java memory to be used
90+
parameter-bounds: null
91+
options:
92+
- 8GB
93+
- 16GB
94+
- 24GB
95+
- 48GB
96+
- 100GB
97+
allow-custom-value: true
98+
- name: threads
99+
default-value: 4
100+
datatype: integer
101+
description: Threads
102+
parameter-bounds:
103+
- 0
104+
- inf
105+
options: null
106+
allow-custom-value: false
107+
- name: hot_deck_matching_runnners
108+
default-value: 2
109+
datatype: integer
110+
description: To be defined
111+
parameter-bounds:
112+
- 0
113+
- inf
114+
options: null
115+
allow-custom-value: false
116+
- name: input_downsampling
117+
default-value: 0.01
118+
datatype: float
119+
description: To be defined
120+
parameter-bounds:
121+
- 0
122+
- 1
123+
options: null
124+
allow-custom-value: false
125+
- name: enable_scaling
126+
default-value: true
127+
datatype: bool
128+
description: To be defined
129+
parameter-bounds: null
130+
options: null
131+
allow-custom-value: false
132+
- name: scaling_year
133+
default-value: 2020
134+
datatype: integer
135+
description: To be defined
136+
parameter-bounds:
137+
- 2000
138+
- inf
139+
options: null
140+
allow-custom-value: false
141+
- name: use_freight
142+
default-value: true
143+
datatype: bool
144+
description: To be defined
145+
parameter-bounds: null
146+
options: null
147+
allow-custom-value: false
148+
- name: hafas_date
149+
default-value: 01.10.2018
150+
datatype: date
151+
description: To be defined
152+
parameter-bounds: null
153+
options: null
154+
allow-custom-value: false
155+
- name: output_id
156+
default-value: ch
157+
datatype: string
158+
description: To be defined
159+
parameter-bounds: null
160+
options: null
161+
allow-custom-value: false
162+
163+
# If applicable, data-input list required by the component
164+
data-inputs:
165+
- name: data
166+
type: Folder
167+
path: data
168+
description: Original eqasim input.
169+
170+
# If applicable, data-output list produced by the component
171+
data-output:
172+
- name: eqasim-output
173+
type: Folder
174+
path: eqasim-output
175+
description: Output from matsim simulations
176+
177+
178+
# If applicable, path to schemas to perform semantic validation.
179+
# Still under development. Ignore.
180+
schema-input: null
181+
schema-output: null
182+
183+
# If applicable, define devices needed such as GPU.
184+
devices:
185+
gpu: false

0 commit comments

Comments
 (0)