Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add conda env installation
  • Loading branch information
alihamraoui authored Jul 19, 2024
1 parent 410fa6e commit 52d6c15
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,25 +64,28 @@ To run ToulligQC without Docker, you need to install the following Python module
* tqdm
* pod5

* **Conda environemnt**
<a name="Conda-environemnt"></a>
### 1.2 Conda environemnt**

You can use a conda environment to install the required packages:

```
git clone https://github.com/GenomicParisCentre/toulligQC.git
cd toulligqc && python3 setup.py build install
conda env create -f environment.yml
conda activate toulliqc
```

<a name="pypi-installation"></a>
### 1.2 Using a PyPi package
### 1.3 Using a PyPi package

ToulligQC can be more easlily installed with a pip package availlable on the PyPi repository. The following command line will install the latest version of ToulligQC:
```bash
$ pip3 install toulligqc
```

<a name="docker"></a>
### 1.3 Using Docker
### 1.4 Using Docker
ToulligQC and its dependencies are available through a Docker image. To install docker on your system, go to the Docker website (<https://docs.docker.com/engine/installation/>).
Even if Docker can run on Windows or macOS virtual machines, we recommend to run ToulligQC on a Linux host.
<a name="docker-image-recovery"></a>
Expand Down

0 comments on commit 52d6c15

Please sign in to comment.