Skip to content

Commit fec629d

Browse files
committed
Installation described
1 parent 258d830 commit fec629d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ BibTeX:
1919

2020
## Content <!-- omit in toc -->
2121
- [Overview](#overview)
22+
- [Installation](#installation)
2223
- [Requirements](#requirements)
2324
- [API](#api)
2425
- [Job](#job)
@@ -68,6 +69,19 @@ Demo of the WebUI for the Jobs and Tasks tracing and profiling:
6869
Exactly the same fully funcitonal interface is accessible from the console using [w3m](http://w3m.sourceforge.net/) or other terminal browsers:
6970
![WebUI Console, Falures page (root)](images/webui_console.png)
7071

72+
## Installation
73+
74+
Include the following modules:
75+
- [mpepool](mpepool.py) - execution pool with load balancer, the only mandatory module,
76+
- [mpewui](mpewui.py) - optional WebUI for the interactive profiling of the scheduled Jobs and Tasks.
77+
78+
or just install everything from the [pypi repository](https://pypi.org/project/pyexpool/):
79+
```sh
80+
$ pip install pyexpool
81+
```
82+
83+
> 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.
84+
7185

7286
## Requirements
7387

0 commit comments

Comments
 (0)