# Tibanna
[](https://www.python.org/downloads/release/python-380/) [](https://travis-ci.org/4dn-dcic/tibanna) [](https://www.codacy.com/app/4dn/tibanna?utm_source=github.com&utm_medium=referral&utm_content=4dn-dcic/tibanna&utm_campaign=Badge_Grade) [](https://www.codacy.com/app/4dn/tibanna?utm_source=github.com&utm_medium=referral&utm_content=4dn-dcic/tibanna&utm_campaign=Badge_Coverage) [](https://tibanna.readthedocs.io/en/latest/?badge=latest)
***
Tibanna runs portable pipelines (in CWL/WDL/Snakemake/shell) on the AWS Cloud.
<br>
Install Tibanna.
```bash
pip install tibanna
```
<br>
Use CLI to set up the cloud component and run workflow.
```bash
# Deploy Unicorn to the Cloud (Unicorn = serverless scheduler/resource allocator).
tibanna deploy_unicorn --usergroup=mygroup
# Run CWL/WDL workflow on the Cloud.
tibanna run_workflow --input-json=myrun.json
```
<br>
Alternatively, use Python API.
```python
from tibanna.core import API
# Deploy Unicorn to the Cloud.
API().deploy_unicorn(usergroup='mygroup')
# Run CWL/WDL workflow on the Cloud.
API().run_workflow(input_json='myrun.json')
```
<br>
---
Note: Starting `0.8.2`, Tibanna supports local CWL/WDL files as well as shell commands and Snakemake workflows.
Note 2: As of Tibanna version `2.0.0`, Python 3.7 (and lower) is no longer supported. Please switch to Python 3.11! Python 3.8 is also supported as a fallback, but please prefer 3.11 if you can.
Note 3: Starting `0.8.0`, one no longer needs to `git clone` the Tibanna repo.
* Please switch from `invoke <command>` to `tibanna <command>`!
* We also renovated the Python API as an inheritable class to allow development around tibanna.
For more details, see Tibanna [**Documentation**](http://tibanna.readthedocs.io/en/latest).
* Also check out our [**paper in _Bioinformatics_**](https://doi.org/10.1093/bioinformatics/btz379).
* A preprint can also be found on [**biorxiv**](https://www.biorxiv.org/content/10.1101/440974v3).
Raw data
{
"_id": null,
"home_page": "http://github.com/4dn-dcic/tibanna",
"name": "tibanna",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.8",
"maintainer_email": null,
"keywords": "tibanna",
"author": "4DN-DCIC Team",
"author_email": "support@4dnucleome.org",
"download_url": "https://files.pythonhosted.org/packages/5c/96/8bec0589414871bbc61a42a11e9daed073d1b33c36c9bac8a4a5ae153f2d/tibanna-5.4.3.tar.gz",
"platform": null,
"description": "# Tibanna\n\n[](https://www.python.org/downloads/release/python-380/) [](https://travis-ci.org/4dn-dcic/tibanna) [](https://www.codacy.com/app/4dn/tibanna?utm_source=github.com&utm_medium=referral&utm_content=4dn-dcic/tibanna&utm_campaign=Badge_Grade) [](https://www.codacy.com/app/4dn/tibanna?utm_source=github.com&utm_medium=referral&utm_content=4dn-dcic/tibanna&utm_campaign=Badge_Coverage) [](https://tibanna.readthedocs.io/en/latest/?badge=latest)\n\n***\n\nTibanna runs portable pipelines (in CWL/WDL/Snakemake/shell) on the AWS Cloud.\n\n<br>\n\nInstall Tibanna.\n```bash\npip install tibanna\n```\n\n<br>\n\nUse CLI to set up the cloud component and run workflow.\n```bash\n# Deploy Unicorn to the Cloud (Unicorn = serverless scheduler/resource allocator).\ntibanna deploy_unicorn --usergroup=mygroup\n\n# Run CWL/WDL workflow on the Cloud.\ntibanna run_workflow --input-json=myrun.json\n```\n\n<br>\n\nAlternatively, use Python API.\n\n```python\nfrom tibanna.core import API\n\n# Deploy Unicorn to the Cloud.\nAPI().deploy_unicorn(usergroup='mygroup')\n\n# Run CWL/WDL workflow on the Cloud.\nAPI().run_workflow(input_json='myrun.json')\n```\n\n<br>\n\n---\nNote: Starting `0.8.2`, Tibanna supports local CWL/WDL files as well as shell commands and Snakemake workflows.\n\nNote 2: As of Tibanna version `2.0.0`, Python 3.7 (and lower) is no longer supported. Please switch to Python 3.11! Python 3.8 is also supported as a fallback, but please prefer 3.11 if you can.\n\nNote 3: Starting `0.8.0`, one no longer needs to `git clone` the Tibanna repo. \n* Please switch from `invoke <command>` to `tibanna <command>`! \n* We also renovated the Python API as an inheritable class to allow development around tibanna.\n\n\nFor more details, see Tibanna [**Documentation**](http://tibanna.readthedocs.io/en/latest).\n* Also check out our [**paper in _Bioinformatics_**](https://doi.org/10.1093/bioinformatics/btz379).\n* A preprint can also be found on [**biorxiv**](https://www.biorxiv.org/content/10.1101/440974v3).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tibanna runs portable pipelines (in CWL/WDL) on the AWS Cloud.",
"version": "5.4.3",
"project_urls": {
"Homepage": "http://github.com/4dn-dcic/tibanna",
"Repository": "http://github.com/4dn-dcic/tibanna.git"
},
"split_keywords": [
"tibanna"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "15eff38d3fc9d7ea0c668bc61952cfe438f1d948df699a0a4c8ede8494082c50",
"md5": "1795c39ac54d0da006caddcda4a89069",
"sha256": "d1f25ac4d466117b3d768692db098e81703101c68320a4024b0229b3cb9e8b7b"
},
"downloads": -1,
"filename": "tibanna-5.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1795c39ac54d0da006caddcda4a89069",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8",
"size": 108114,
"upload_time": "2024-08-06T17:33:41",
"upload_time_iso_8601": "2024-08-06T17:33:41.385102Z",
"url": "https://files.pythonhosted.org/packages/15/ef/f38d3fc9d7ea0c668bc61952cfe438f1d948df699a0a4c8ede8494082c50/tibanna-5.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5c968bec0589414871bbc61a42a11e9daed073d1b33c36c9bac8a4a5ae153f2d",
"md5": "246ab21939441114b8470cceabe856a4",
"sha256": "0df237bfdfbc091bfb452932bf8d8772d41cc0c8bc26e6350252e18010f7eb86"
},
"downloads": -1,
"filename": "tibanna-5.4.3.tar.gz",
"has_sig": false,
"md5_digest": "246ab21939441114b8470cceabe856a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8",
"size": 96191,
"upload_time": "2024-08-06T17:33:44",
"upload_time_iso_8601": "2024-08-06T17:33:44.636832Z",
"url": "https://files.pythonhosted.org/packages/5c/96/8bec0589414871bbc61a42a11e9daed073d1b33c36c9bac8a4a5ae153f2d/tibanna-5.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-06 17:33:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "4dn-dcic",
"github_project": "tibanna",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tibanna"
}
JSON
