Mercurial > repos > kls286 > chap_test_20230328

annotate README.md @ 7:91a302ac9636 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0-dirty
author kls286
date Tue, 28 Mar 2023 18:58:42 +0000
parents 649eb2ea2f49
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
1 ### Pipeline
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
2 This package conains proof of concepts pipeline framework for workflow
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
3 execution. It requires proper configuration of pipeline in terms classes, e.g.
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
4 ```
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
5 # pipeline deifinition as sequence of objects
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
6 pipeline:
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
7 - reader.Reader
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
8 - processor.Processor
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
9 - fitter.Fitter
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
10 - processor.Processor
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
11 - writer.Writer
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
12 - fitter.Fitter
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
13 - writer.Writer
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
14
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
15 # specific object parameters, e.g. our reader accepts fileName=data.csv
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
16 reader.Reader:
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
17 fileName: data.csv
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
18
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
19
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
20 # specific object parameters, e.g. our writer accepts fileName=data.out
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
21 writer.Writer:
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
22 fileName: data.out
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
23 ```
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
24
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
25 Then, you may execute this pipeline as following:
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
26 ```
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
27 ./runner.py --config config.yaml
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
28 ```
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
29 and, check the output in `data.out` file.
649eb2ea2f49 planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
kls286
parents:
diff changeset
30