Initial commit

.env.dist

@@ -0,0 +1,15 @@
+#ODTP COMPONENT VARIABLES
+VARIABLES=
+# ODTP ENV VARIABLES TO CONNECT
+ODTP_MONGO_SERVER=
+ODTP_S3_SERVER=
+ODTP_BUCKET_NAME=
+ODTP_ACCESS_KEY=
+ODTP_SECRET_KEY=
+# ODTP ENV VARIABLES DB REFERENCES
+ODTP_USER_ID=
+ODTP_DIGITAL_TWIN=
+ODTP_EXCUTION=
+ODTP_STEP=
+ODTP_COMPONENT=
+ODTP_COMPONENT_VERSION=

.gitignore

@@ -0,0 +1,132 @@
+# Mac crap
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "odtp-component-client"]
+	path = odtp-component-client
+	url = https://github.com/odtp-org/odtp-component-client

Dockerfile

@@ -0,0 +1,73 @@
+FROM ubuntu:22.04
+
+RUN apt update
+RUN apt install python3.10 python3-pip -y 
+
+##################################################
+# Ubuntu setup
+##################################################
+
+RUN  apt-get update \
+  && apt-get install -y wget \
+  && rm -rf /var/lib/apt/lists/*
+
+RUN apt-get update && apt-get -y upgrade \
+  && apt-get install -y --no-install-recommends \
+    unzip \
+    nano \
+    git \ 
+    g++ \
+    gcc \
+    htop \
+    zip \
+    ca-certificates \
+    && rm -rf /var/lib/apt/lists/*
+
+##################################################
+# ODTP setup
+##################################################
+
+COPY odtp-component-client/requirements.txt /tmp/odtp.requirements.txt
+RUN pip install -r /tmp/odtp.requirements.txt
+
+
+#######################################################################
+# PLEASE INSTALL HERE ALL SYSTEM DEPENDENCIES RELATED TO YOUR TOOL
+#######################################################################
+
+# Installing dependecies from the app
+COPY requirements.txt /tmp/requirements.txt
+RUN pip install -r /tmp/requirements.txt
+
+
+######################################################################
+# ODTP COMPONENT CONFIGURATION. 
+# DO NOT TOUCH UNLESS YOU KNOW WHAT YOU ARE DOING.
+######################################################################
+
+##################################################
+# ODTP Preparation
+##################################################
+
+RUN mkdir /odtp \
+    /odtp/odtp-config \
+    /odtp/odtp-app \
+    /odtp/odtp-component-client \
+    /odtp/odtp-logs \ 
+    /odtp/odtp-input \
+    /odtp/odtp-workdir \
+    /odtp/odtp-output 
+
+# This last 2 folders are specific from odtp-eqasim
+RUN mkdir /odtp/odtp-workdir/cache \
+    /odtp/odtp-workdir/output 
+
+# This copy all the information for running the ODTP component
+COPY odtp.yml /odtp/odtp-config/odtp.yml
+
+COPY ./odtp-component-client /odtp/odtp-component-client
+
+COPY ./app /odtp/odtp-app
+WORKDIR /odtp
+
+ENTRYPOINT ["bash", "/odtp/odtp-component-client/startup.sh"]

LICENSE

@@ -0,0 +1,15 @@
+BSD 3-Clause "New" or "Revised" License
+Licence ID
+BSD-3-Clause
+Licence text
+Copyright (c) 2023-2024 Swiss Data Science Center. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,276 @@
+# ODTP Component Template
+
+This is a template that facilitates the development of new `odtp-components`. An `odtp` compatible component is a docker container able to perform a functional unit of computing in the digital twin. You can think of it as a blackbox that takes inputs files and/or parameters and perfom a task. Usually this lead to some files as a result (Ephemeral component), or to a visualization (Interactive component).
+
+Internally a component will run a bash script `./app/app.sh` that must include the commands for running your tool, and managing the input/output logic. While input files are located in the folder `/odtp/odtp-input`, parameters values are represented by environment variables within the component. In this way you can access to them by using `$` before the name of your variable. Finally, the output files generated are requested to be placed in `/odtp/odtp-output/`.
+
+## How to clone this repository? 
+
+> [!NOTE]  
+> This repository makes use of submodules. Therefore, when cloning it you need to include them.
+>  
+> `git clone --recurse-submodules https://github.com/odtp-org/odtp-component-template`
+
+
+## How to create an odtp compatible component using this template?
+
+1. Identify which parameters would you like to expose.
+2. Configure the Dockerfile to install all the OS requirements needed for your tool to run. 
+    1. (Optional) If your tool requires python, and the dependencies offered in the repo are not compatible with the docker image you can configure custom dependencies in requirements.txt
+3. Configure the `app/app.sh` file to:
+    1. Clone the repository of your tool and checkout to one specific commit. 
+    2. (Optional) If your app uses a config file (i.e. `config.yml` or `config.json`), you need to provide a templace including placeholders for the variables you would like to expose. Placeholders can be defined by using double curly braces wrapping the name of the variable, such as `{{VARIABLE}}`. Then you can run `python3 /odtp/odtp-component-client/parameters.py PATH_TO_TEMPLATE PATH_TO_OUTPUT_CONFIG_FILE` and every placeholder will be replaced by the value in the environment variable.
+    3. Copy (`cp -r`) or create symbolic links (`ln -s`) to locate the input files in `/odpt/odtp-input/` in the folder. 
+    4. Run the tool. You can access to the parameters as environemnt variables (i.e. `$PARAMETER_A`)
+    5. Manage the output exporting. At the end of the component execution all generated output should be located in `/odtp/odtp-output`. Copy all output files into this folder. 
+4. Describe all the metadata in `odtp.yml`. Please check below for instructions.
+5. Publish your tool in the ODTP Zoo. (Temporaly unavailable)
+
+### Semantic Validation
+
+ODTP will be able to validate the input/output files. In order to do this we use SHACL validation. However, the developer should provide a schema of the input/output schema. This section is still under development and it will be available soon. 
+
+## Internal data structure of a component
+
+It's important to remark that when the container is built an specific folder structure is generated:
+
+- `/odtp`: The main folder.
+- `/odtp/odtp-component-client`: This is the odtp client that will manage the execution, logging, and input/output functions of the component. It is include as a submodule, and the user doesn't need to modify it.
+- `/odtp/odtp-app`: This folder have the content of `/app` folder in this template. It contains the tool execution bash script and the tool configuration files. 
+- `/odtp/odtp-workdir`: This is the working directory where the tool repository should be placed and all the middle files such as cache folders.
+- `/odtp/odtp-input`: Input folder that is be mounted as volume for the docker container.
+- `/odtp/odtp-output`: Output folder that is mounted as volume for the docker container.
+- `/odtp/odtp-logs`: Folder reserved for internal loggings. 
+- `/odtp/odtp-config`: Folder reserved for odtp configuration. 
+
+## Testing the component
+
+There are 3 main ways in which you can test a component and the different odtp features. 
+
+1. Testing it as a docker container
+2. Testing it as a single component using `odtp`
+3. Testing it in a `odtp` digital twin execution
+
+When developing we recomend to start by testing the component via docker and then follow with the others.  
+
+### Testing the component as a docker container
+
+The user will need to manually create the input/output folders and build the docker image.
+
+1. Prepare the following folder structure:
+
+```
+- testing-folder
+    - data-input
+    - data-output
+```
+
+Place all required input files in `testing-folder/data-input`.
+
+2. Create your `.env` file with the following parameters.
+
+```
+# ODTP COMPONENT VARIABLES
+PARAMETER-A=.....
+PARAMETER-B=.....
+```
+
+3. Build the dockerfile. 
+
+```
+docker build -t odtp-component .
+```
+
+4. Run the following command.
+
+```
+docker run -it --rm \ 
+-v {PATH_TO_YOUR_INPUT_VOLUME}:/odtp/odtp-input \
+-v {PATH_TO_YOUR_INPUT_VOLUME}:/odtp/odtp-output \
+--env-file .env \
+odtp-component
+```
+
+This command will run the component. If you want debug some errors and execute the docker in an interactive manner, you can use the flag `--entrypoint bash` when running docker.
+
+Also if your tool is interactive such as an Streamlit app, don't forget to map the ports by using `-p XXXX:XXXX`. 
+
+### Testing the component as part of odtp
+
+To execute the command as part of `odtp` please refer to our `odtp` documentation: 
+
+https://odtp-org.github.io/odtp-manuals/
+
+## `odtp.yml`
+
+ODTP requires a set of metadata to work. These fields should be filled by the developers.
+
+```yml
+# This file should contain basic component information for your component.
+component-name: Component Name
+component-author: Component Author
+component-version: Component Version
+component-repository: Component Repository
+component-license: Component License
+component-type: ephemeral or interactive
+component-description: Description
+tags:
+  - tag1
+  - tag2
+
+# Information about the tools
+tools:
+  - tool-name: tool's name
+    tool-author: Tool's author
+    tool-version: Tool version
+    tool-repository: Tool's repository
+    tool-license: Tool's license
+
+# If your tool require some secrets token to be passed as ENV to the component
+# This won't be traced
+secrets:
+  - name: Key of the argument
+  - description: Description of the secret
+
+# If the tool requires some building arguments such as Matlab license
+build-args:
+  - name: Key of the argument
+  - description: Descriptio of the building argument
+  - secret: Bool
+
+# If applicable, ports exposed by the component
+# Include Name, Description, and Port Value for each port
+ports:
+  - name: PORT A
+    description: Description of Port A
+    port-value: XXXX
+  - name: PORT B
+    description: Description of Port B
+    port-value: YYYY
+
+# If applicable, parameters exposed by the component
+# Datatype can be str, int, float, or bool.
+parameters:
+  - name: PARAMETER A
+    default-value: DEFAULT_VALUE_A
+    datatype: DATATYPE_A
+    description: Description of Parameter A
+    parameter-bounds: # Boundaries for int and float datatype
+      - 0 # Lower bound
+      - inf # Upper bound
+    options: null
+    allow-custom-value: false # If true the user can add a custom value out of parameter-bounds, or options
+
+  - name: PARAMETER B
+    default-value: DEFAULT_VALUE_B
+    datatype: DATATYPE_B
+    description: Description of Parameter B
+    parameter-bounds: null
+    options: # If your string parameter is limited to a few option, please list them here. 
+      - OptionA
+      - OptionB
+      - OptionC
+    allow-custom-value: false # If true the user can add a custom value out of parameter-bounds, or options
+
+# If applicable, data-input list required by the component
+data-inputs:
+  - name: INPUT A
+    type: TYPE_A # Folder or filetype
+    path: VALUE_A  
+    description: Description of Input A
+  - name: INPUT B
+    type: TYPE_B # Folder or filetype
+    path: VALUE_B  
+    description: Description of Input B
+
+# If applicable, data-output list produced by the component
+data-output:
+  - name: OUTPUT A
+    type: TYPE_A # Folder or filetype
+    path: VALUE_A
+    description: Description of Output A
+  - name: OUTPUT B
+    type: TYPE_B # Folder or filetype
+    path: VALUE_B
+    description: Description of Output B
+
+# If applicable, path to schemas to perform semantic validation.
+# Still under development. Ignore.
+schema-input: PATH_TO_INPUT_SCHEMA
+schema-output: PATH_TO_OUTPUT_SCHEMA
+
+# If applicable, define devices needed such as GPU.
+devices:
+  gpu: Bool
+```
+
+## Changelog
+
+- v0.4.0
+  - Update default Base and Python in Dockerfile to `ubuntu:22.04` and `python3.10`
+
+- v0.3.4
+  - Inclusion of `secrets` and `build-args` in `odtp.yml`
+  - Tools as list
+
+- v0.3.3
+  - Inclusion of boundaries conditions and options in `odtp.yml` parameters.    
+
+- v0.3.2
+  - Extended `odtp.yml` parameters and input/output definition.
+  - `odtp.requirements.txt` transfered to submodule `odtp-component-client`.
+
+- v0.3.1
+  - Updating schema fields in `odtp.yml` to kebab-case.
+
+- v0.3.0
+  - Turning `odtp-client` into a separate repository and adding it as a submodule in `odtp-component-client`
+  - Updating `app.sh` and tutorial.
+  - Updating `odtp.yml` file.
+  - Adding `.DS_Store` to `.gitignore`
+
+- v0.2.0
+  - Compatible with ODTP v.0.2.0 only with platform / components
+  - Compatible with configuration text files
+  - Improved loging system
+  - Accepting Digital Twins, Executions, and steps, metadata.
+  - Including component versioning in `odtp.yml`
+
+- v0.1.0
+  - Compatible with ODTP v.0.1.0 only with platform / components
+  - Compatible with configuration text files
+
+## Acknowledgments, Copyright, and Licensing
+
+### Acknowledgments and Funding
+
+This work is part of the broader project **O**pen **D**igital **T**win **P**latform of the **S**wiss **M**obility **S**ystem (ODTP-SMS) funded by Swissuniversities CHORD grant Track B - Establish Projects. ODTP-SMS project is a joint endeavour by the Center for Sustainable Future Mobility - CSFM (ETH Zürich) and the Swiss Data Science Center - SDSC (EPFL and ETH Zürich). 
+The Swiss Data Science Center (SDSC) develops domain-agnostic standards and containerized components to manage digital twins. This includes the creation of the Core Platform (both back-end and front-end), Service Component Integration Templates, Component Ontology, and the Component Zoo template. 
+The Center for Sustainable Future Mobility (CSFM) develops mobility services and utilizes the components produced by SDSC to deploy a mobility digital twin platform. CSFM focuses on integrating mobility services and collecting available components in the mobility zoo, thereby applying the digital twin concept in the realm of mobility.
+ 
+### Copyright
+
+Copyright © 2023-2024 Swiss Data Science Center (SDSC), www.datascience.ch. All rights reserved.
+The SDSC is jointly established and legally represented by the École Polytechnique Fédérale de Lausanne (EPFL) and the Eidgenössische Technische Hochschule Zürich (ETH Zürich). This copyright encompasses all materials, software, documentation, and other content created and developed by the SDSC.
+
+### Intellectual Property (IP) Rights
+
+The Open Digital Twin Platform (ODTP) is the result of a collaborative effort between ETH Zurich (ETHZ) and the École Polytechnique Fédérale de Lausanne (EPFL). Both institutions hold equal intellectual property rights for the ODTP project, reflecting the equitable and shared contributions of EPFL and ETH Zürich in the development and advancement of this initiative.  
+ 
+### Licensing
+
+The Service Component Integration Templates within this repository are licensed under the BSD 3-Clause "New" or "Revised" License. This license allows for broad compatibility and standardization, encouraging open use and contribution. For the full license text, please see the LICENSE file accompanying these templates.
+
+#### Distinct Licensing for Other Components
+
+- **Core Platform**: Open-source under AGPLv3.
+- **Ontology**: Creative Commons Attribution-ShareAlike (CC BY-SA).
+- **Component Zoo Template**: BSD-3 license.
+
+### Alternative Commercial Licensing
+
+Alternative commercial licensing options for the core platform and other components are available and can be negotiated through the EPFL Technology Transfer Office (https://tto.epfl.ch) or ETH Zürich Technology Transfer Office (https://ethz.ch/en/industry/transfer.html).
+
+## Ethical Use and Legal Compliance Disclaimer
+
+Please note that this software should not be used to deliberately harm any individual or entity. Users and developers must adhere to ethical guidelines and use the software responsibly and legally. This disclaimer serves to remind all parties involved in the use or development of this software to engage in practices that are ethical, lawful, and in accordance with the intended purpose of the software.

README.template.md

@@ -0,0 +1,62 @@
+# Name of the component
+
+Description of the component
+
+| Tool Info | Links |
+| --- | --- |
+| Original Tool | []() |
+| Current Tool Version  | [commit-hash](link-to-commit-hash) |
+
+
+## ODTP command 
+
+```
+odtp new odtp-component-entry \
+--name odtp-component \
+--component-version x.y.z \
+--repository Link to repository
+``` 
+
+## Data sheet
+
+### Parameters
+
+| Parameter | Description | Default Value |
+| --- | --- | --- |
+| A | B | C |
+
+### Input Files
+
+| File/Folder | Description |
+| --- | --- | 
+| A | B |
+
+### Output Files
+
+| File/Folder | Description |
+| --- | --- | 
+| A | B |
+
+## Tutorial
+
+### How to run this component as docker
+
+Build the dockerfile 
+
+```
+docker build -t odtp-component .
+```
+
+Run the following command. Mount the correct volumes for input/output folders. 
+
+```
+docker run -it --rm \
+-v {PATH_TO_YOUR_INPUT_VOLUME}:/odtp/odtp-input \
+-v {PATH_TO_YOUR_OUTPUT_VOLUME}:/odtp/odtp-output \
+--env-file .env odtp-component
+```
+
+
+## Developed by
+
+XXXXXXXXXX

app/app.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+############################################################################################
+# START OF MANUAL CONFIGURATION. 
+# ADAPT THE TEMPLATE HERE.
+############################################################################################
+
+#########################################################
+# 1. GITHUB CLONING OF REPO
+# Clone the repository of your tool and checkout to one specific commit. 
+#########################################################
+
+# git clone https://github.com/odtp-org/tool-example.git /odtp/odtp-workdir/tool-example
+# cd /odtp/odtp-workdir/tool-example
+# git checkout xxxxxxxxxxxx
+
+#########################################################
+# 2. CONFIG FILE CONFIGURATION
+# Read placeholders and create config file from Environment  
+#########################################################
+
+# python3 /odtp/odtp-component-client/parameters.py /odtp/odtp-app/config_templates/template.yml /odtp/odtp-workdir/config.yml
+
+#########################################################
+# 3. INPUT FOLDER MANAGEMENT
+#########################################################
+
+# ln -s /odtp/odtp-input/... /odtp/odtp-workdir/...
+
+#########################################################
+# 4. TOOL EXECUTION
+# While the output is managed by ODTP and placed in /odtp/odtp-output/
+#########################################################
+
+# COMMAND $PARAMETER_A #PARAMETER_B /odtp/odtp-input/data
+
+#########################################################
+# 5. OUTPUT FOLDER MANAGEMENT
+# The selected output files generated should be placed in the output folder
+#########################################################
+
+# cp -r /odtp/odtp-workdir/output/* /odtp/odtp-output
+
+############################################################################################
+# END OF MANUAL USER APP
+############################################################################################

app/config_templates/template.yml

@@ -0,0 +1,3 @@
+# Use the variable name between squared brackets to replace values in the template. 
+constant_string: /odtp/odtp-workdir/cache
+value_to_replace: [variable_key]

odtp-component-client

@@ -0,0 +1 @@
+Subproject commit 0b75d5b31a84d62e0bfc6a46a7827b0457369eef

odtp.yml

@@ -0,0 +1,95 @@
+# This file should contain basic component information for your component.
+component-name: Component Name
+component-author: Component Author
+component-version: Component Version
+component-repository: Component Repository
+component-license: Component License
+component-type: ephemeral or interactive
+component-description: Description
+tags:
+  - tag1
+  - tag2
+
+# Information about the tools
+tools:
+  - tool-name: tool's name
+    tool-author: Tool's author
+    tool-version: Tool version
+    tool-repository: Tool's repository
+    tool-license: Tool's license
+
+# If your tool require some secrets token to be passed as ENV to the component
+# This won't be traced in MongoDB
+secrets:
+  - name: Key of the argument
+  - description: Description of the secret
+
+# If the tool requires some building arguments such as Matlab license
+build-args:
+  - name: Key of the argument
+  - description: Descriptio of the building argument
+  - secret: Bool
+
+# If applicable, ports exposed by the component
+# Include Name, Description, and Port Value for each port
+ports:
+  - name: PORT A
+    description: Description of Port A
+    port-value: XXXX
+  - name: PORT B
+    description: Description of Port B
+    port-value: YYYY
+
+# If applicable, parameters exposed by the component
+# Datatype can be str, int, float, or bool.
+parameters:
+  - name: PARAMETER A
+    default-value: DEFAULT_VALUE_A
+    datatype: DATATYPE_A
+    description: Description of Parameter A
+    parameter-bounds: # Boundaries for int and float datatype
+      - 0 # Lower bound
+      - inf # Upper bound
+    options: null
+    allow-custom-value: false # If true the user can add a custom value out of parameter-bounds, or options
+  - name: PARAMETER B
+    default-value: DEFAULT_VALUE_B
+    datatype: DATATYPE_B
+    description: Description of Parameter B
+    parameter-bounds: null
+    options: # If your string parameter is limited to a few option, please list them here. 
+      - OptionA
+      - OptionB
+      - OptionC
+    allow-custom-value: false # If true the user can add a custom value out of parameter-bounds, or options
+
+# If applicable, data-input list required by the component
+data-inputs:
+  - name: INPUT A
+    type: TYPE_A # Folder or filetype
+    path: VALUE_A  
+    description: Description of Input A
+  - name: INPUT B
+    type: TYPE_B # Folder or filetype
+    path: VALUE_B  
+    description: Description of Input B
+
+# If applicable, data-output list produced by the component
+data-output:
+  - name: OUTPUT A
+    type: TYPE_A # Folder or filetype
+    path: VALUE_A
+    description: Description of Output A
+  - name: OUTPUT B
+    type: TYPE_B # Folder or filetype
+    path: VALUE_B
+    description: Description of Output B
+
+# If applicable, path to schemas to perform semantic validation.
+# Still under development. Ignore.
+schema-input: PATH_TO_INPUT_SCHEMA
+schema-output: PATH_TO_OUTPUT_SCHEMA
+
+# If applicable, define devices needed such as GPU.
+devices:
+  gpu: Bool

requirements.txt

@@ -0,0 +1 @@
+# Please list here all python dependencies of your tool