Skip to content
Snippets Groups Projects
Select Git revision
  • master default protected
  • beta
  • CI-timeout-fix
  • v1.3.1 protected
  • v1.3.0 protected
  • v1.2.3 protected
  • v1.2.2 protected
  • v1.2.1 protected
  • v1.2.0 protected
  • v1.1.0 protected
  • v1.0.1 protected
  • v1.0.0 protected
  • v0.6.2 protected
  • v0.6.1 protected
  • v0.6.0 protected
  • v0.5.4 protected
  • v0.5.3 protected
  • v0.5.2 protected
  • v0.5.1 protected
  • v0.5.0 protected
  • v0.4.2 protected
  • v0.4.1 protected
  • v0.4.0 protected
23 results
Compare
Name Last commit Last update
doc/api
fractalis
tests
.bumpversion.cfg
.gitignore
.gitlab-ci.yml
LICENSE
MANIFEST.in
README.md
manage.py
requirements.txt
setup.cfg
setup.py
README.md

Build Status Coverage Report

About

This is the back-end component of the Fractalis project. It is a computational node that is responsible for the MicroETL process and the execution of analytical tasks.

Demo

Please have a look at this playlist to see a demo of the visual aspects of Fractalis: Playlist.

Installation (Docker)

The easiest and most convenient way to deploy Fractalis is using Docker. All necessary information can be found here Fractalis-Docker.

Installation (Manual)

If you do not want to use docker or want a higher level of control of the several components, that's fine. In fact it isn't difficult to setup Fractalis manually. We highly recommend having a look at the CI File that is used to setup a very simple environment in which tests can be executed. For a more advanced setup in production please follow these steps:

  • Install and run Redis, which is available for most Linux distributions. This instance must be accessible by the web service and the workers.
  • Install and run RabbitMQ, which is available in most Linux distributions. This instance must be accessible by the web service and the workers.
  • Install Fractalis via pip3 install fractalis. Please note that Fractalis requires Python3.4 or higher. This must be installed on all machines that will run the web service or the workers.
  • Install required all required R packages. We won't list these packages excplicitely, as they can change frequently. Please refer instead to the CI File, which is always up-to-date, as a new version of Fractalis is only released when this script works. This must be installed on all machines that will run the web service or the workers.
  • Run and expose the Fractalis web service with whatever tools you want. We recommend gunicorn and nginx, but others should work, too. Here is an example how we run the Fractalis web service in the Dockerfile.web. You likely want to use nginx on top of that.
  • Run workers on any machine that you want. (For a simple setup this can be the very same machine that the web service runs on). Here is an example how we run a Fractalis worker in the Dockerfile.worker

Configuration

All setups, manual, docker, or any future setup method will always rely on the environment variable FRACTALIS_CONFIG for configuration. This variable must be a) a valid python file (.py) and b) be available on all instances that host a Fractalis web service or a Fractalis worker. Use the default settings as an example for your own configuration file. Please note, that all this files combines Flask Settings, Celery Settings, and Fractalis Settings, which are all listed and documented within this file. A word of warning: Please don't overwrite default settings if you don't know what you are doing. This might have severe implications for security or might cause Fractalis to not work correctly.

Add support for new services

Support for other services is exclusively implemented within this folder. We recommend looking at the ada example implementation. Just make sure you use the class inheritance (ETL, ETLHandler) correctly, and you will get readable error messages if something goes wrong.

Citation

Manuscript is in preparation.