|
@@ -1,45 +1,116 @@
|
|
|
# Kalliope installation on Debian Jessie
|
|
|
|
|
|
-## Automated install
|
|
|
+## Requirements
|
|
|
|
|
|
-Clone the project
|
|
|
+### Debian packages requirements
|
|
|
+
|
|
|
+Edit `/etc/apt/sources.list` and check that you have `contrib` and `non-free` and backports archives enabled:
|
|
|
+```
|
|
|
+deb http://httpredir.debian.org/debian jessie main contrib non-free
|
|
|
+deb-src http://httpredir.debian.org/debian jessie main contrib non-free
|
|
|
+deb http://httpredir.debian.org/debian jessie-backports main contrib non-free
|
|
|
+deb-src http://httpredir.debian.org/debian jessie-backports main contrib non-free
|
|
|
+```
|
|
|
+
|
|
|
+Install some required system libraries and softwares:
|
|
|
+
|
|
|
+```
|
|
|
+sudo apt-get update
|
|
|
+sudo apt-get install git python-pip python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer
|
|
|
+```
|
|
|
+
|
|
|
+You also need some packages from the backports:
|
|
|
+
|
|
|
+```
|
|
|
+sudo apt-get install -t jessie-backports python-setuptools
|
|
|
+sudo apt-get install -t jessie-backports python-pyasn1
|
|
|
+```
|
|
|
+
|
|
|
+## Installation
|
|
|
+
|
|
|
+### Method 1 - User install using the PIP package
|
|
|
+
|
|
|
+You can install kalliope on your system:
|
|
|
+```
|
|
|
+sudo pip install kalliope
|
|
|
+```
|
|
|
+
|
|
|
+Or just in your user home:
|
|
|
+```
|
|
|
+pip install --user kalliope
|
|
|
+```
|
|
|
+
|
|
|
+Run Kalliope from a shell:
|
|
|
+```
|
|
|
+kalliope start
|
|
|
+```
|
|
|
+
|
|
|
+### Method 2 - Manual user install using the git repository
|
|
|
+
|
|
|
+Clone the project:
|
|
|
```
|
|
|
-cd
|
|
|
git clone https://github.com/kalliope-project/kalliope.git
|
|
|
```
|
|
|
|
|
|
-Edit `/etc/apt/sources.list` and check that your mirror accept "non-free" package
|
|
|
+Install the project:
|
|
|
```
|
|
|
-deb http://ftp.fr.debian.org/debian/ jessie main contrib non-free
|
|
|
-deb-src http://ftp.fr.debian.org/debian/ jessie main contrib non-free
|
|
|
+sudo python setup.py install
|
|
|
```
|
|
|
|
|
|
-Run the install script.
|
|
|
+Run Kalliope from a shell:
|
|
|
```
|
|
|
-./kalliope/install/install_kalliope.sh
|
|
|
+kalliope start
|
|
|
```
|
|
|
|
|
|
-## Manual install
|
|
|
+### Method 3 - Developer install using Virtualenv
|
|
|
|
|
|
-To make Kalliope work, you will have to install a certain number of libraries:
|
|
|
+Install the `python-virtualenv` package:
|
|
|
```
|
|
|
-sudo apt-get update
|
|
|
-sudo apt-get install git python-pip python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer
|
|
|
+sudo apt-get install python-virtualenv
|
|
|
+```
|
|
|
+
|
|
|
+Clone the project:
|
|
|
+```
|
|
|
+git clone https://github.com/kalliope-project/kalliope.git
|
|
|
+cd kalliope
|
|
|
+```
|
|
|
+
|
|
|
+Generate a local python environment:
|
|
|
+```
|
|
|
+virtualenv venv
|
|
|
+```
|
|
|
+
|
|
|
+Install the project using the local environment:
|
|
|
+```
|
|
|
+venv/bin/pip install --editable .
|
|
|
```
|
|
|
|
|
|
-Clone the project
|
|
|
+Run Kalliope from a shell:
|
|
|
+```
|
|
|
+venv/bin/kalliope start
|
|
|
+```
|
|
|
+
|
|
|
+### Method 4 - Developer, dependencies install only
|
|
|
+
|
|
|
+Clone the project:
|
|
|
```
|
|
|
git clone https://github.com/kalliope-project/kalliope.git
|
|
|
+cd kalliope
|
|
|
+```
|
|
|
+
|
|
|
+Install the python dependencies directly:
|
|
|
+```
|
|
|
+sudo pip install -r install/python_requirements.txt
|
|
|
```
|
|
|
|
|
|
-Install libs
|
|
|
+Run Kalliope from a shell directly:
|
|
|
```
|
|
|
-sudo pip install -r install/files/python_requirements.txt
|
|
|
+python kalliope.py start
|
|
|
```
|
|
|
|
|
|
## Test your env
|
|
|
|
|
|
-To ensure that you can record your voice, run the following command to capture audio input from your microphone
|
|
|
+To ensure that you can record your voice, run the following command to capture audio input from your microphone:
|
|
|
```
|
|
|
rec test.wav
|
|
|
```
|