From fec629dbb860e8883764050d423662821387cad9 Mon Sep 17 00:00:00 2001 From: luav Date: Tue, 22 May 2018 22:40:48 +0200 Subject: [PATCH] Installation described --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index cafcd20..0a02480 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ BibTeX: ## Content - [Overview](#overview) +- [Installation](#installation) - [Requirements](#requirements) - [API](#api) - [Job](#job) @@ -68,6 +69,19 @@ Demo of the WebUI for the Jobs and Tasks tracing and profiling: Exactly the same fully funcitonal interface is accessible from the console using [w3m](http://w3m.sourceforge.net/) or other terminal browsers: ![WebUI Console, Falures page (root)](images/webui_console.png) +## Installation + +Include the following modules: +- [mpepool](mpepool.py) - execution pool with load balancer, the only mandatory module, +- [mpewui](mpewui.py) - optional WebUI for the interactive profiling of the scheduled Jobs and Tasks. + +or just install everything from the [pypi repository](https://pypi.org/project/pyexpool/): +```sh +$ pip install pyexpool +``` + +> Additionally, [hwloc / lstopo](http://www.admin-magazine.com/HPC/Articles/hwloc-Which-Processor-Is-Running-Your-Service) should be installed if customized CPU affinity masking and cach control are required, see [Requirements](#requirements) section. + ## Requirements