diff --git a/Dockerfile b/Dockerfile index 35980f7..fd54f1f 100644 --- a/Dockerfile +++ b/Dockerfile @@ -27,7 +27,7 @@ RUN apt-get update && apt-get -y upgrade \ # ODTP setup ################################################## -COPY odtp.requirements.txt /tmp/odtp.requirements.txt +COPY odtp-component-client/requirements.txt /tmp/odtp.requirements.txt RUN pip install -r /tmp/odtp.requirements.txt diff --git a/README.md b/README.md index 473b447..c256ae6 100644 --- a/README.md +++ b/README.md @@ -99,54 +99,84 @@ ODTP requires a set of metadata to work. These fields should be filled by the de ```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: +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 tool -- tool-name: Tool name -- tool-author: Tool's author -- tool-version: Tool version -- tool-repository: Tool's repository -- tool-license: Tool's license - -# If aplicable, ports exposed by the component -- ports: - - XXXX - -# If aplicable, parameters exposed by the component -# Add compatible datatype: str, int or float -- parameters: - - PARAMETER A: datatype - -# If aplicable, data-input list required by the component -- data-inputs: - - data - - cache - -# If aplicable, data-output list produced by the component -- data-output: - - output - -# If aplicable, path to schemas to perform semantic validation. -# Still under development. Ignore. -- schema-input: PATH_TO_INPUT_SCHEMA -- schema-output: PATH_TO_OUTPUT_SCHEMA - -# If aplicable, define devices needed such as gpus. -- devices: - - gpus: False +tool-name: Tool name +tool-author: Tool's author +tool-version: Tool version +tool-repository: Tool's repository +tool-license: Tool's license + +# 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 + - name: PARAMETER B + default-value: DEFAULT_VALUE_B + datatype: DATATYPE_B + description: Description of Parameter B + +# 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: false ``` ## Changelog +- 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. diff --git a/odtp-component-client b/odtp-component-client index d7b90de..120639f 160000 --- a/odtp-component-client +++ b/odtp-component-client @@ -1 +1 @@ -Subproject commit d7b90de5496f53393691be9dd1433be5237215b9 +Subproject commit 120639f00b1cf622408a5e4ff7e08b02d40cce5c diff --git a/odtp.requirements.txt b/odtp.requirements.txt deleted file mode 100644 index b96f138..0000000 --- a/odtp.requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -pymongo -boto3 -PyYAML \ No newline at end of file diff --git a/odtp.yml b/odtp.yml index 95a0772..da00b4a 100644 --- a/odtp.yml +++ b/odtp.yml @@ -1,46 +1,71 @@ # 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: +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 tool -- tool-name: Tool name -- tool-author: Tool's author -- tool-version: Tool version -- tool-repository: Tool's repository -- tool-license: Tool's license +tool-name: Tool name +tool-author: Tool's author +tool-version: Tool version +tool-repository: Tool's repository +tool-license: Tool's license -# If aplicable, ports exposed by the component -- ports: - - XXXX +# 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 aplicable, parameters exposed by the component -# Add compatible datatype: str, int or float -- parameters: - - PARAMETER A: datatype +# 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 + - name: PARAMETER B + default-value: DEFAULT_VALUE_B + datatype: DATATYPE_B + description: Description of Parameter B -# If aplicable, data-input list required by the component -- data-inputs: - - data - - cache +# 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 aplicable, data-output list produced by the component -- data-output: - - output +# 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 aplicable, path to schemas to perform semantic validation. -# Still under development. Ignore. -- schema-input: PATH_TO_INPUT_SCHEMA -- schema-output: PATH_TO_OUTPUT_SCHEMA - -# If aplicable, define devices needed such as gpus. -- devices: - - gpus: False +# 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: false