Skip to content

Commit

Permalink
new: doc: added conda installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mauricege committed May 16, 2019
1 parent 0bbf43f commit bc608c2
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Expand Up @@ -14,12 +14,13 @@ If you use DeepSpectrum or any code from DeepSpectrum in your research work, you

# Installation
This program provides a setup.py script which declares all dependencies.
This program provides a setup.py script for easy installation with [pip](#installation-through-pip) and also an environment.yml for installing through [conda](#conda-installation) (recommended on Windows).

## Dependencies
## Dependencies (only for installation with pip)
* Python >=3.6
* ffmpeg

## Deep Spectrum tool
## Installation through pip
We recommend that you install the DeepSpectrum tool into a virtual environment. To do so first create a new virtualenvironment:
```bash
virtualenv -p python3 ds_virtualenv
Expand All @@ -40,7 +41,16 @@ Or for windows:

Once the virtualenv is activated, the tool can be installed from the source directory (containing setup.py) with this command:
```bash
pip install -e .
pip install .
```
## Conda installation
You can use the included environment.yml file to create a new virtual python environment with DeepSpectrum by running:
```bash
conda env create -f environment.yml
```
Then activate the environmnet with:
```bash
conda activate DeepSpectrum
```

## Configuration
Expand Down

0 comments on commit bc608c2

Please sign in to comment.