# Folding
[![PyPI - Version](https://img.shields.io/pypi/v/folding)](https://pypi.org/project/folding/)
Folding is a streamlined version of ColabFold that focuses on running AlphaFold2 locally on Linux systems. It combines the power of ColabFold and LocalColabFold to provide an easy-to-use tool for protein structure prediction.
## Features
- Supports AlphaFold2 for protein structure prediction
- Includes `folding-search` and `folding-batch` functionalities
## Requirements
* Linux
* RTX 4070 or greater
## Installation
1. Clone this repository or download it to your local machine.
2. Navigate to the folding directory:
```
cd /path/to/folding
```
3. Run the installation script:
```
bash install.sh
```
4. After installation, add the folding conda environment to your PATH:
```
export PATH="/path/to/folding/folding-conda/bin:$PATH"
```
## Usage
### folding-search
To use `folding-search`:
```
folding-search [OPTIONS] QUERY_FILE RESULTS_DIR
```
For more details on available options, run:
```
folding-search --help
```
### folding-batch
To use `folding-batch`:
```
folding-batch [OPTIONS] INPUT_DIR OUTPUT_DIR
```
For more details on available options, run:
```
folding-batch --help
```
## Support
For issues and feature requests, please open an issue on the GitHub repository.
## License
This project is licensed under the MIT License. See the LICENSE file for details.
## Acknowledgements
folding is based on the work of ColabFold and LocalColabFold. We thank the original authors and contributors of these projects for their valuable work in the field of protein structure prediction.
Raw data
{
"_id": null,
"home_page": "https://github.com/truemagic-coder/cyberchipped-fold",
"name": "folding",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Bevan Hunt",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/44/d1/a5fb1b4c382a5bf9576dd488f8bf06ce28e957170ced399a98d527724951/folding-0.0.5.tar.gz",
"platform": null,
"description": "# Folding\n\n[![PyPI - Version](https://img.shields.io/pypi/v/folding)](https://pypi.org/project/folding/)\n\nFolding is a streamlined version of ColabFold that focuses on running AlphaFold2 locally on Linux systems. It combines the power of ColabFold and LocalColabFold to provide an easy-to-use tool for protein structure prediction.\n\n## Features\n\n- Supports AlphaFold2 for protein structure prediction\n- Includes `folding-search` and `folding-batch` functionalities\n\n## Requirements\n* Linux\n* RTX 4070 or greater\n\n## Installation\n\n1. Clone this repository or download it to your local machine.\n2. Navigate to the folding directory:\n ```\n cd /path/to/folding\n ```\n3. Run the installation script:\n ```\n bash install.sh\n ```\n4. After installation, add the folding conda environment to your PATH:\n ```\n export PATH=\"/path/to/folding/folding-conda/bin:$PATH\"\n ```\n\n## Usage\n\n### folding-search\n\nTo use `folding-search`:\n\n```\nfolding-search [OPTIONS] QUERY_FILE RESULTS_DIR\n```\n\nFor more details on available options, run:\n\n```\nfolding-search --help\n```\n\n### folding-batch\n\nTo use `folding-batch`:\n\n```\nfolding-batch [OPTIONS] INPUT_DIR OUTPUT_DIR\n```\n\nFor more details on available options, run:\n\n```\nfolding-batch --help\n```\n\n## Support\n\nFor issues and feature requests, please open an issue on the GitHub repository.\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n## Acknowledgements\n\nfolding is based on the work of ColabFold and LocalColabFold. We thank the original authors and contributors of these projects for their valuable work in the field of protein structure prediction.\n",
"bugtrack_url": null,
"license": "MIT, but separate licenses for the trained weights",
"summary": "ColabFold modified for AlphaFold2 and local installation",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/truemagic-coder/cyberchipped-fold",
"Repository": "https://github.com/truemagic-coder/cyberchipped-fold"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "239c5bd7692c4f74d11c064dcb7bb58de9bb431671b37e16c13004dd5ef1ecd8",
"md5": "090fb40d77fa17fffe82b97beaf7793e",
"sha256": "1c4705a6f43bf625546e634c05112cde0561c6b4859d030fe49c7f1dc2d60526"
},
"downloads": -1,
"filename": "folding-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "090fb40d77fa17fffe82b97beaf7793e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 74239,
"upload_time": "2024-08-25T06:52:16",
"upload_time_iso_8601": "2024-08-25T06:52:16.519792Z",
"url": "https://files.pythonhosted.org/packages/23/9c/5bd7692c4f74d11c064dcb7bb58de9bb431671b37e16c13004dd5ef1ecd8/folding-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "44d1a5fb1b4c382a5bf9576dd488f8bf06ce28e957170ced399a98d527724951",
"md5": "4da4fd33c680696a728dd8b966965830",
"sha256": "e995281a1756a0603786ab930edd457d20345530a9d0e57d8c6291d4cf0e7d86"
},
"downloads": -1,
"filename": "folding-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "4da4fd33c680696a728dd8b966965830",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 65794,
"upload_time": "2024-08-25T06:52:18",
"upload_time_iso_8601": "2024-08-25T06:52:18.161795Z",
"url": "https://files.pythonhosted.org/packages/44/d1/a5fb1b4c382a5bf9576dd488f8bf06ce28e957170ced399a98d527724951/folding-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 06:52:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "truemagic-coder",
"github_project": "cyberchipped-fold",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "folding"
}