Skip to content

Commit

Permalink
bump to 0.1.0rc3
Browse files Browse the repository at this point in the history
  • Loading branch information
junjun-zhang committed May 6, 2017
1 parent a275a05 commit f318fb4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ git clone [email protected]:icgc-dcc/jtracker.git
cd jtracker
pipsi install .
# or install from PyPI for latest release
# or install from PyPI for latest release (no need to clone the source)
pipsi install jtracker
# run it
Expand All @@ -29,16 +29,18 @@ jt

## Design and create your workflow

Follow this example to develop your workflow: https://github.com/icgc-dcc/ega-file-transfer-to-collab
Follow this example to develop your workflow: https://github.com/icgc-dcc/ega-file-transfer-to-collab-jt

Quick note on workflow development and testing:

1. You can have workflow definition and workflow execution in one single Git repo, although separating them in dedicated Git repos is recommended for production use. Here is an example: https://github.com/icgc-dcc/jtracker-example-workflows/tree/master/test.0.0.0.jtracker, note that job states folders and worflow folder are in one repo.

2. It is recommended to use a local Git server for development and testing. Follow this instruction to set up a local git server on a mac: http://www.tomdalling.com/blog/software-processes/how-to-set-up-a-secure-git-server-at-home-osx/. Once set up, you can access it same way as you access github. In my case, `git clone ssh://junjun@localhost:/Users/junjun/mygit/jtracker-demo-workflows.git`


## Create a Git repository to manage workflow execution
## Create a Git repository to manage and track workflow task execution

Here is an example: https://github.com/icgc-dcc/jtracker-example-workflows/tree/master/test.0.1.0.jtracker
Here is an example: https://github.com/icgc-dcc/jtracker-example-workflows/tree/master/ega-file-transfer-to-collab.0.4.0.jtracker

At this time, you will need to set up this Git repository on your own manually. In the near future, 'jt' cli tool will be able to set it up automatically for you.

Expand All @@ -48,7 +50,7 @@ At this time, you will need to set up this Git repository on your own manually.
On a task execution host, you can start a worker as follow assuming workflow definition and job json files exist as specified.

```
jt -g '[email protected]:icgc-dcc/jtracker-example-workflows' -w test -r 0.1.0 worker
jt -g '[email protected]:icgc-dcc/jtracker-example-workflows' -w ega-file-transfer-to-collab -r 0.4.0 worker
```

You can start multiple workers on the same host if there is enough computating resource. You can also start workers in different hosts at the same time. Workflow jobs/tasks will be picked up by individual workers as needed.
Expand Down
2 changes: 1 addition & 1 deletion jtracker/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = '0.1.0rc2'
__version__ = '0.1.0rc3'

from .worker import Worker
from .jtracker import JTracker

0 comments on commit f318fb4

Please sign in to comment.