Skip to content
Snippets Groups Projects
Commit 28ac4117 authored by Francesco Siddi's avatar Francesco Siddi
Browse files

Updated README.md

parent aca2210e
No related branches found
No related tags found
No related merge requests found
# flamenco 2.0 # Flamenco 2.0
Development repo for flamenco 2.0 (originally known as brender). Flamenco is a Free and Open Source Job distribution system for render farms. Development repo for Flamenco 2.0 (originally known as brender). Flamenco is a Free and Open Source Job distribution system for render farms.
Warning: we are going to stay in alpha stage until the end of February 2015. Warning: we are going to stay in alpha stage until the end of February 2015.
## Developer installation ## Developer installation
In order to install flamenco, we recommend to set up a Python virtual environment. In order to install Flamenco, we recommend to set up a Python virtual environment.
``` ```
$ sudo easy_install virtualenv $ sudo easy_install virtualenv
...@@ -18,10 +18,10 @@ On Linux this might work better: ...@@ -18,10 +18,10 @@ On Linux this might work better:
$ sudo apt-get install python-virtualenv $ sudo apt-get install python-virtualenv
``` ```
Once you have virtualenv installed, just fire up a shell and create your own environment. You may want to create this folder inside of the flamenco folder: Once you have virtualenv installed, just fire up a shell and create your own environment. You may want to create this folder inside of the Flamenco folder:
``` ```
$ cd flamenco $ cd Flamenco
$ virtualenv venv $ virtualenv venv
New python executable in venv/bin/python New python executable in venv/bin/python
Installing distribute............done. Installing distribute............done.
...@@ -57,7 +57,7 @@ Databases are managed by `MySQL` or `SQLite`. ...@@ -57,7 +57,7 @@ Databases are managed by `MySQL` or `SQLite`.
Psutil is needed for gathering system usage/performance stats on the worker. Ideally psutil is needed only on the workers. Psutil is needed for gathering system usage/performance stats on the worker. Ideally psutil is needed only on the workers.
## Initialize flamenco ## Initialize Flamenco
First you need to initialize the server and manager's databases: First you need to initialize the server and manager's databases:
``` ```
...@@ -66,7 +66,7 @@ $ cd manager; ./manage.py db upgrade ...@@ -66,7 +66,7 @@ $ cd manager; ./manage.py db upgrade
``` ```
## Running flamenco ## Running Flamenco
It's pretty simple. Move into each node folder and run - in four different terminals: It's pretty simple. Move into each node folder and run - in four different terminals:
``` ```
...@@ -86,7 +86,7 @@ At the moment we are still using the original `brender` folder, which will be re ...@@ -86,7 +86,7 @@ At the moment we are still using the original `brender` folder, which will be re
* `manager` containing the manager files (manage clusters) * `manager` containing the manager files (manage clusters)
* `dashboard` containing the dashboard (web interface to talk to the server) * `dashboard` containing the dashboard (web interface to talk to the server)
This structure explains also the naming conventions adopted to distinguish the different parts of flamenco. This structure explains also the naming conventions adopted to distinguish the different parts of Flamenco.
Each folder contains an individual Flask application. Server, Manager and Worker exchange JSON formatted messages between each other via a Rest API. Each folder contains an individual Flask application. Server, Manager and Worker exchange JSON formatted messages between each other via a Rest API.
Dashboard connects to the Server only and accepts connections from clients (Browsers). Dashboard connects to the Server only and accepts connections from clients (Browsers).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment