Skip to content

Commit

Permalink
Merge pull request #17 from VForWaTer/cosmetic-changes
Browse files Browse the repository at this point in the history
Cosmetic changes
  • Loading branch information
mmaelicke authored Dec 11, 2023
2 parents a7dc709 + 89a5d2e commit 9405d31
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ of this specification.
This section lists the implementations, which we are aware of. By *implementation*,
we are referring to software packages for different programming languages used
in either of the tools, that help to parse the *parametrization* and the *input data* of a tool into
a language specific data structure. Here, you can read more about [parameter and data Input](./input.md).
a language specific data structure. Here, you can read more about [parameter and data input](./input.md).

The available implementations as of now are:

Expand Down
20 changes: 5 additions & 15 deletions docs/tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,6 @@ description: |
This is the second line.
```
### `version`

The version is optional, but highly recommended.
The version number has to follow a semantic verisoning pattern with either major, minor and patch version,
or be limited to only major and minor version.
Semantic version numbers can be prefixed by a small` v`.

Examples are: `1.0`, `v1.3.2`

### `parameters`

Parameters for tools are also an Entity [defined in the specification](parameter.md).
Expand All @@ -81,7 +72,9 @@ An example can be found in the Example section below or on the [Parameters page]
[Input data](./input.md#data-file-specification) for a tool is defined separately from the
parameters in an additional section of `tool.yml`.
Just like for the parameters, the input data of a tool is indexed by their names.
Data is always given to a tool as files or folders.
In case no further configuration is needed, data may be supplied in a single list
of dataset names.
Data has to be provided as files, which may be nested in sub-folders of `/in/`.

## Example

Expand Down Expand Up @@ -110,9 +103,6 @@ tools:
type: integer
array: true
data:
foo_csv:
load: true
foo_nc:
load: false
extension: .nc
- foo_csv:
- foo_nc:
```

0 comments on commit 9405d31

Please sign in to comment.