Skip to content
Snippets Groups Projects
Commit e8d4002a authored by Akdel, Mehmet's avatar Akdel, Mehmet
Browse files

Merge branch 'akdel001-master-patch-82787' into 'master'

Update README.md

See merge request durai001/caretta!1
parents 1fce5bd0 1078747b
No related branches found
No related tags found
1 merge request!1Update README.md
...@@ -8,8 +8,18 @@ The command-line tool and self-hosted web application do not have this restricti ...@@ -8,8 +8,18 @@ The command-line tool and self-hosted web application do not have this restricti
## Installation ## Installation
### Requirements ### Requirements
#### Operating system support
1. Linux and Mac
All capabilities are supported
2. Windows
The external tool **msms** is not available in Windows. Due to this:
* Feature extraction is not available.
* `extract-all-features` argument in caretta-cli should be always False.
* `caretta-app` is not available.
#### Software
Caretta works with Python 3.7+ Caretta works with Python 3.7+
Run the following commands to install required external dependencies: Run the following commands to install required external dependencies (Mac and Linux only):
```bash ```bash
conda install -c salilab dssp conda install -c salilab dssp
conda install -c bioconda msms conda install -c bioconda msms
...@@ -21,7 +31,7 @@ git clone https://git.wur.nl/durai001/caretta.git ...@@ -21,7 +31,7 @@ git clone https://git.wur.nl/durai001/caretta.git
cd caretta cd caretta
``` ```
### Install both the command-line interface and the web-application: ### Install both the command-line interface and the web-application (Mac and Linux only):
```bash ```bash
pip install -e ".[GUI]" pip install -e ".[GUI]"
``` ```
...@@ -47,7 +57,7 @@ caretta-cli input_pdb_folder ...@@ -47,7 +57,7 @@ caretta-cli input_pdb_folder
# caretta-cli -h for more options # caretta-cli -h for more options
``` ```
### Web-application Usage ### Web-application Usage (Mac and Linux only)
```bash ```bash
caretta-app <host-ip> <port> caretta-app <host-ip> <port>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment