Skip to content

Commit

Permalink
minor tweaks and new image
Browse files Browse the repository at this point in the history
  • Loading branch information
fubar2 committed May 21, 2023
1 parent 778cd4f commit 081ee9f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
Binary file modified topics/dev/images/ToolFactory_big_picture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 21 additions & 3 deletions topics/dev/tutorials/tool-generators/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,21 +218,39 @@ In this case, a single text string is needed from the user.

Tool definition involves configuring the major sections of the ToolFactory form for the new tool.

The following information about a script is needed:
Five categories needed to generate a script:

- Conda dependency requirements
- History data inputs
- History outputs - data and collections
- History outputs
- User controlled parameters
- Developer supplied code/scripts to embed

For the `hello` tool case:

Conda dependency requirements:

- There are no dependencies usually because bash is available and version is not important.
- For completeness, it could be included as a Conda package. It's your tool.

History data inputs:

- This tool requires no history input files.

History outputs - data and collections:
- It produces one text output file.

User controlled parameters:
- The tool form should show a single input text field for the user to supply.
- Executing the tool is expected to write the combined string to a new history item.

Developer supplied code/scripts to embed:
- These are optional - many Conda packages will not need them.
- Most simple use-cases will involve developer supplied, known working code.
- Executing the tool is expected to write the decorated string to a new history item.
- This must be known to work with suitable inputs on the command line.
- Broken code == broken tool.
- Such as `echo "Hello $1!"` as a Bash script
- There are other advanced features, such as command over-rides where code can be embedded

At this point, the plan for this new tool is:

Expand Down

0 comments on commit 081ee9f

Please sign in to comment.