Skip to content

Commit b79234b

Browse files
committed
A bit about installation
1 parent df292ab commit b79234b

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# CWLProv Python tool
22

3+
The `cwlprov` Python tool is a command line interface to validate and inspect
4+
[CWLProv](https://w3id.org/cwl/prov) Research Objects that capture workflow runs,
5+
typically executed in a [Common Workflow Language](https://www.commonwl.org/)
6+
implementation.
7+
8+
## Installation
9+
10+
You'll need [Python 3](https://www.python.org/downloads/).
11+
12+
To install from [pip](https://pypi.org/project/cwlprov/) try:
13+
14+
pip3 install cwlprov
15+
16+
If you would rather install from the checkout of this source code:
17+
18+
pip3 install .
19+
20+
## Usage
21+
22+
Use `cwlprov --help` to see all options. For instance `cwlprov validate` will validate the folder is valid according to CWLProv.
23+
24+
The [test/](test/) folder contains some examples of workflow runs for different CWLProv profiles.
25+
26+
327
## License
428

529
This repository is distributed under [Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
@@ -10,7 +34,7 @@ SPDX-License-Identifier: Apache-2.0
1034

1135
## Contributing
1236

13-
cwlprov.py is maintained at https://github.com/common-workflow-language/cwlprov-py/
37+
cwlprov.py is maintained at https://github.com/common-workflow-language/cwlprov-py/ by the [Common Workflow Language](https://www.commonwl.org/) project.
1438

1539
Feel free to raise an
1640
[issue](https://github.com/common-workflow-language/cwlprov-py/issues) or a
@@ -39,6 +63,3 @@ at the discretion of the leadership team.
3963
For more details, see our
4064
[Code of Conduct](https://github.com/common-workflow-language/common-workflow-language/blob/master/CODE_OF_CONDUCT.md).
4165

42-
Please note that cwlprov-py is for the CWLProv RO analytics which is generated as a result
43-
of a CWL workflow run.
44-

0 commit comments

Comments
 (0)