To run WAVES-core, it’s strongly recommended that you setup a dedicated user, because WAVES-core run with saga-python, and this module need to create some directories you might not be able to create (.radical and .saga) with another user (such as www-data)


WAVES-core was initially developed with Python 2.7 and Django 1.11 and is currently not tested on latest version (Python 3 and Django 2.0).

You can install WAVES-core either as a stand alone application, or inside any existing Django project

0. Prerequisites


In order to install WAVES-core you will need:
  • python 2.7.X (WAVES-core is not yet compatible with python 3.5)
  • pip package manager (required packages : python-pip python-dev build-essential)
  • A web server: Apache or NGINX
  • A database backend (Mysql or Postgres) but by default WAVES-core runs with sqlite

WAVES is developed with Django. You may need to know a little about it.

1. Install WAVES-core as stand alone application

1.1. Clone repository:

Current version is latest (latest)

user@host:$ git clone [your_app]
user@host:$ cd [your_app]


To checkout a particular version:

user@host:~your_app$ git checkout tags/[VERSION]

1.2. Install dependencies:

user@host:~your_app$ virtualenv .venv
user@host:~your_app$ source .venv/bin/activate
(.venv) user@host:~your_app$ pip install -r requirements.txt

You might need other dependencies if working with other DB layout than sqlite.

1.3. Install database:

(.venv) user@host:~your_app$ ./ check
(.venv) user@host:~your_app$ ./ makemigrations wcore (may only display "No changes detected in app 'wcore'")
(.venv) user@host:~your_app$ ./ migrate
(.venv) user@host:~your_app$ ./ createsuperuser (then follow instructions)

1.4. If everything is ok:

You can start your test server and job queue like this:

(.venv) user@host:~your_app$ ./ runserver
(.venv) user@host:~your_app$ ./ crontab add

Go to to setup your services WAVES-core comes with default front pages visible at

See also

Django crontab for other crontab setup


From previous release, a known bug occured while using wqueue command. This bug block you from using this daemon queue. Please use “crontab” instead, and contact us if you experience issues.

1.5.(optional) Use celery and redis as job queue

Using the combination of waves job queue and crontab can have some limitations. For example, with this configuration, the minimum refresh interval is one minute. If you need smaller refresh interval you can use the combination of celery and redis as an asynchronous job queue.

1.5.1. Install the redis server

Redis is an in-memory database that allows to store the tasks.

user@host:~your_app$ sudo apt-get install redis-server

1.5.2. Install dependencies

(.venv) user@host:~your_app$ pip install django-celery-beat==1.5.0
(.venv) user@host:~your_app$ pip install celery==4.3.0
(.venv) user@host:~your_app$ pip install redis==3.2.1

1.5.3. Launch job queue

(.venv) user@host:~your_app$ celery -A waves_core worker -l INFO
(.venv) user@host:~your_app$ celery -A waves_core beat -l INFO --scheduler django_celery_beat.schedulers:DatabaseScheduler

If the command crontab add was launched before, it is necessary to remove the crontab task:

(.venv) user@host:~your_app$ ./ crontab remove

1.5.4. Add “django celery beat” to the project

Thanks to “django celery beat” library, you can configure the recurrent tasks directly in the administrator area. According to add this application to the project, you need to add the application in the configuration file (~your_app/waves_core/


1.5.5. Add periodic tasks to the database

Apply Django database migrations so that the necessary tables are created. Then, add some entries in the database with default configuration.

(.venv) user@host:~your_app$ ./ migrate
(.venv) user@host:~your_app$ ./ loaddata fixtures_celery_beat.json

Visit the Django-Admin interface to set up some periodic tasks.

In the periodic tasks pannel, the available tasks are job_queue and purge_jobs, two functions present in the file of wcore application. Configure each of them with the desired intervals and saved.

2. Install WAVES-core inside existing Django project

To create a Django project, have a look at Django tutorial

2.0. Setup a virtualenv for your project:

virtualenv ~/.venv/[waves_env]

2.1. Install waves package:

Use pip to install waves-core as third party package.

pip install waves-core

If you want to install the latest development version (at your own risk :-))
pip install -e git+

2.2. Activate WAVES-core in settings:

WAVES-core application has minimum dependencies to:

Optionally, WAVES-core can use:

Add required dependencies to your INSTALLED_APPS, you should at least find these in your project:

    'polymorphic', # mandatory
    'waves.wcore', # mandatory
    'waves.authentication', # mandatory if API token access needed
    'crispy_forms', # mandatory
    'rest_framework', # mandatory
    'rest_framework.authtoken', # optional see
    'corsheaders', # optional see
    'adminsortable2', # optional see

2.3. Include the services urls in your project

url(r'^waves/', include('waves.wcore.urls', namespace='wcore'))
url(r'^waves/api/', include('waves.wcore.api.urls', namespace='wapi'))

2.4. Create your database:

python makemigrations wcore
python migrate wcore
python check

2.5. Extra configuration:

Depending on your needs, you might want to expose WAVES API to any registered user, if so have a look at: Corsheader to allow cross-origin Resource Sharing

Some WAVES-core API services requires authentication, see DRF authentication for authenticating methods API POST calls


WAVES-core allows simple “api_key” authentication with standard Token Authentication processes, to use it simply add ‘waves.authentication’ in INSTALLED_APPS.

This then allow to call WAVES API services with a api_key:
  • with Authorization token header
  • with GET / POST parameter with api_key value.

Each authenticated api service need a valid Authorization header as explained here:

To use this service with apache in mod_wsgi: please mind to enable “WSGIPassAuthorization On” parameter in conf

3. Use other than SqlLite default DB layer

You may need to install the Python and MySQL development headers and libraries like so:

  • sudo apt-get install python-dev default-libmysqlclient-dev # Debian / Ubuntu
  • sudo yum install python-devel mysql-devel # Red Hat / CentOS
  • brew install mysql-connector-c # macOS (Homebrew) (Currently, it has bug. See below)

On Windows, there are binary wheels you can install without MySQLConnector/C or MSVC.

Then install pip mysql package in your virtualenv:

pip install mysqlclient