-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated odtp-component-client and README template
- Loading branch information
Showing
2 changed files
with
63 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |