Skip to content

Commit c8fc2e9

Browse files
authored
Add installation instructions for CRISPR-HAWK
Added installation instructions for CRISPR-HAWK using Mamba and Conda, including environment setup and tips.
1 parent f5c3571 commit c8fc2e9

1 file changed

Lines changed: 37 additions & 3 deletions

File tree

README.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/crisprhawk/README.html)
12
[![GitHub Release Version](https://img.shields.io/github/v/release/pinellolab/CRISPR-HAWK)](https://github.com/pinellolab/CRISPR-HAWK/releases)
23
[![Build Status](https://github.com/pinellolab/CRISPR-HAWK/actions/workflows/python-package.yml/badge.svg)](https://github.com/pinellolab/CRISPR-HAWK/actions/workflows/python-package.yml)
34
![license](https://img.shields.io/badge/license-AGPL--3.0-lightgrey)
@@ -21,8 +22,6 @@ CRISPR-HAWK is a comprehensive and scalable tool for designing guide RNAs (gRNAs
2122
<br>&nbsp;&nbsp;1.4 [Install CRISPR-HAWK from Source Code](#14-install-crispr-hawk-from-source-code)
2223
<br>&nbsp;&nbsp;1.5 [Install External Software Dependencies](#15-install-external-software-dependencies)
2324
<br>&nbsp;&nbsp;&nbsp;&nbsp;1.5.1 [Install CRISPRitz (for Off-target Estimation)](#151-install-crispritz-for-off-target-estimation)
24-
<br>&nbsp;&nbsp;&nbsp;&nbsp;1.5.2 [Install CRISPRon (Optional On-target Scoring)](#152-install-crispron-optional-on-target-scoring)
25-
<br>&nbsp;&nbsp;&nbsp;&nbsp;1.5.3 [Install sgDesigner (Optional On-target Scoring)](#153-install-sgdesigner-optional-on-target-scoring)
2625
<br>2 [Usage](#2-usage)
2726
<br>&nbsp;&nbsp;2.1 [General Syntax](#21-general-syntax)
2827
<br>&nbsp;&nbsp;2.2 [Search](#22-search)
@@ -138,7 +137,42 @@ CONDA_SUBDIR=osx-64 mamba create -n crisprhawk-env -c bioconda crisprhawk
138137

139138
#### 1.1.2 Install CRISPR-HAWK
140139

141-
TBA
140+
Once Conda or Mamba is installed and the Bioconda channels are properly configured (see [Section 1.1.1](#111-install-conda-or-mamba)), you can install CRISPR-HAWK in a dedicated environment.
141+
142+
We strongly recommend creating a separate environment to ensure reproducibility and avoid dependency conflicts.
143+
144+
**1. Create a new environment (recommended)**
145+
146+
```bash
147+
mamba create -n crisprhawk-env python=3.8 -y
148+
mamba activate crisprhawk-env
149+
```
150+
151+
> 💡 **Tip**: CRISPR-HAWK currently requires **Python 3.8** for full compatibility with all dependencies.
152+
153+
**2. Install CRISPR-HAWK**
154+
155+
```bash
156+
mamba install crisprhawk
157+
```
158+
159+
This command will automatically resolve and install all required dependencies from Bioconda and conda-forge.
160+
161+
> 💡 **Tip**: If you are using Conda instead of Mamba, simply replace `mamba` with `conda`.
162+
163+
After installation, confirm that CRISPR-HAWK is correctly installed:
164+
165+
```bash
166+
crisprhawk --help
167+
```
168+
169+
If the command runs successfully and displays the help message, the installation is complete.
170+
171+
To update to the latest version available on Bioconda:
172+
173+
```bash
174+
mamba update crisprhawk
175+
```
142176

143177
### 1.2 Install CRISPR-HAWK from Docker
144178

0 commit comments

Comments
 (0)