From 449a1166051c91c208848e907564c7b0f0b98734 Mon Sep 17 00:00:00 2001 From: Carlos Vivar Rios Date: Thu, 18 Apr 2024 10:34:41 +0200 Subject: [PATCH] Updated odtp-component-client and README template --- README.template.md | 62 +++++++++++++++++++++++++++++++++++++++++++ odtp-component-client | 2 +- 2 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 README.template.md diff --git a/README.template.md b/README.template.md new file mode 100644 index 0000000..883c63a --- /dev/null +++ b/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 diff --git a/odtp-component-client b/odtp-component-client index 120639f..0b75d5b 160000 --- a/odtp-component-client +++ b/odtp-component-client @@ -1 +1 @@ -Subproject commit 120639f00b1cf622408a5e4ff7e08b02d40cce5c +Subproject commit 0b75d5b31a84d62e0bfc6a46a7827b0457369eef