Skip to content

Commit

Permalink
update install info in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
maxibor committed Jun 2, 2020
1 parent 49e4da8 commit 42ffc9b
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions docs/source/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,33 @@ It uses a process akin to a likelihood ratio test to attempt to discriminate bet

## Install

Pydamage is not yet on *pypi* nor *conda*, but you can already install it using pip, provided that you have access to this repository.
### With [conda](https://docs.conda.io/en/latest/) (recommended)

### Install dependencies in conda environment
```bash
conda install -c conda-forge -c bioconda -c maxibor pydamage
```

### With pip

```bash
git clone git@github.com:maxibor/pydamage.git
cd pydamage
conda env create -f environment.yml
conda activate pydamage
pip install pydamage
```

### Install pydamage
### Install from source to use the development version

- from source
Using pip

```bash
python setup.py install
pip install git+ssh://git@github.com/maxibor/pydamage.git
```

- from Github using pip
By cloning in a dedicated conda environment

```bash
pip install git+ssh://git@github.com/maxibor/pydamage.git
git clone git@github.com:maxibor/pydamage.git
cd pydamage
conda env create -f environment.yml
conda activate pydamage
```

## CLI help
Expand Down

0 comments on commit 42ffc9b

Please sign in to comment.