# 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": "",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "tibanna",
"author": "4DN-DCIC Team",
"author_email": "support@4dnucleome.org",
"download_url": "https://files.pythonhosted.org/packages/57/ae/ca15b7695c255de8889916d4408032b2e889c8342c087b69ddf67e3ac4d8/tibanna-5.2.0.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.2.0",
"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": "0547ca5c77d4b9e1642ddc44a490884937d96cccb03534ec005db8ee691014fe",
"md5": "9e388dbe9504e48931df6e16c2891bf3",
"sha256": "baddc832a3ff2e29a75409afc3b3be9e75ad4a5a372909ed98847646e0e936ae"
},
"downloads": -1,
"filename": "tibanna-5.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e388dbe9504e48931df6e16c2891bf3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 107750,
"upload_time": "2024-01-09T19:40:43",
"upload_time_iso_8601": "2024-01-09T19:40:43.655275Z",
"url": "https://files.pythonhosted.org/packages/05/47/ca5c77d4b9e1642ddc44a490884937d96cccb03534ec005db8ee691014fe/tibanna-5.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "57aeca15b7695c255de8889916d4408032b2e889c8342c087b69ddf67e3ac4d8",
"md5": "bf1223bbdb3f104f1219d7584bc4b830",
"sha256": "6e6d52661667ef245dcaed37a6a5fe73ab2f5f393d2038cfb5380c94ed4d292f"
},
"downloads": -1,
"filename": "tibanna-5.2.0.tar.gz",
"has_sig": false,
"md5_digest": "bf1223bbdb3f104f1219d7584bc4b830",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 96406,
"upload_time": "2024-01-09T19:40:47",
"upload_time_iso_8601": "2024-01-09T19:40:47.507061Z",
"url": "https://files.pythonhosted.org/packages/57/ae/ca15b7695c255de8889916d4408032b2e889c8342c087b69ddf67e3ac4d8/tibanna-5.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-09 19:40:47",
"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
