odtp.yml

# Schema version for tracking updates to the schema format
schema-version: "v0.5.0"

# Component Information
component-name: odtp-eqasim-matsim
component-version: v0.1.7
component-license: BSD-3-Clause
component-type: ephemeral
component-description: ODTP component for running Eqasim Matsim Pipeline.
component-authors:
  - name: Carlos Vivar Rios
    orcid: "https://orcid.org/0000-0002-8076-2034"
component-repository:
  url: "https://github.com/odtp-org/odtp-eqasim-matsim"
  doi: null
tags:
  - mobility
  - matsim
  - simulation

# Information about the tools
tools:
  - tool-name: eqasim-org/ile-de-france
    tool-authors:
      - name: Sebastian Hörl
        orchid: "https://orcid.org/0000-0002-9018-432X"
      - name: S. and M. Balac
        orchid: "https://orcid.org/0000-0002-6099-7442"
    tool-version: fb1112d2a7d1817746be84413da584c391059ad1
    tool-repository:
      url: https://github.com/eqasim-org/ile-de-france
      doi: null
    tool-license: GPL-2.0 License
  - tool-name: ivt-vpl/populations/ch-zh-synpop
    tool-authors:
      - name: Sebastian Hörl
        orchid: "https://orcid.org/0000-0002-9018-432X"
      - name: S. and M. Balac
        orchid: "https://orcid.org/0000-0002-6099-7442"
    tool-version: 4658daa2e441dcda132622e7fcb47da1df8c47d6
    tool-repository:
      url: https://gitlab.ethz.ch/ivt-vpl/populations/ch-zh-synpop
      doi: null
    tool-license: GPL-2.0 License

# If your tool require some secrets token to be passed as ENV to the component
# This won't be traced in MongoDB
secrets: null

# If the tool requires some building arguments such as Matlab license
build-args: null

# If applicable, ports exposed by the component
# Include Name, Description, and Port Value for each port
ports: null

# If applicable, parameters exposed by the component
# Datatype can be str, int, float, or bool.
parameters:
  - name: SCENARIO
    default-value: CORSICA
    datatype: string
    description: Type of desired scenario where to run the simulation. It should match the input data.
    options:
      - CORSICA
      - IDF
      - CH
    allow-custom-value: false
  - name: processes
    default-value: 4
    datatype: integer
    description: Number of processes to be used. Only compatible with SCENARIO equal to CORSICA or IDF 
    parameter-bounds:
      - 0
      - inf
    options: null
    allow-custom-value: false
  - name: hts
    default-value: entd
    datatype: string
    description: To be developed
    parameter-bounds: null
    options:
      - entd
      - egt
    allow-custom-value: false
  - name: sampling_rate
    default-value: 0.001
    datatype: float
    description: To be defined
    parameter-bounds:
      - 0
      - 1
    options: null
    allow-custom-value: false
  - name: random_seed
    default-value: 1234
    datatype: integer
    description: Random seed.
    parameter-bounds:
      - 0
      - inf
    options: null
    allow-custom-value: false
  - name: java_memory
    default-value: 8GB
    datatype: string
    description: Java memory to be used
    parameter-bounds: null
    options:
      - 8GB
      - 16GB
      - 24GB
      - 48GB
      - 100GB
    allow-custom-value: true
  - name: threads
    default-value: 4
    datatype: integer
    description: Threads
    parameter-bounds:
      - 0
      - inf
    options: null
    allow-custom-value: false
  - name: hot_deck_matching_runnners
    default-value: 2
    datatype: integer
    description: To be defined
    parameter-bounds:
      - 0
      - inf
    options: null
    allow-custom-value: false
  - name: input_downsampling
    default-value: 0.01
    datatype: float
    description: To be defined
    parameter-bounds:
      - 0
      - 1
    options: null
    allow-custom-value: false
  - name: enable_scaling
    default-value: true
    datatype: bool
    description: To be defined
    parameter-bounds: null
    options: null
    allow-custom-value: false
  - name: scaling_year
    default-value: 2020
    datatype: integer
    description: To be defined
    parameter-bounds:
      - 2000
      - inf
    options: null
    allow-custom-value: false
  - name: use_freight
    default-value: true
    datatype: bool
    description: To be defined
    parameter-bounds: null
    options: null
    allow-custom-value: false
  - name: hafas_date
    default-value: 01.10.2018
    datatype: date
    description: To be defined
    parameter-bounds: null
    options: null
    allow-custom-value: false
  - name: output_id
    default-value: ch
    datatype: string
    description: To be defined
    parameter-bounds: null
    options: null
    allow-custom-value: false

# If applicable, data-input list required by the component
data-inputs:
  - name: data
    type: Folder
    path: data
    description: Original eqasim input.
  - name: eqasim-output
    type: Folder
    path: eqasim-output
    description: Eqasim output.
  - name: cache
    type: Folder
    path: cache
    description: Eqasim cache folder.

# If applicable, data-output list produced by the component
data-output:
  - name: eqasim-matsim-output
    type: Folder
    path: eqasim-matsim-output
    description: Output from matsim simulations


# If applicable, path to schemas to perform semantic validation.
# Still under development. Ignore.
schema-input: null
schema-output: null

# If applicable, define devices needed such as GPU.
devices:
  - type: gpu
    required: false