README.rst 2.49 KB
Newer Older
SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
1 2 3
**************************************************
EnOSlib: Surviving the ☆homoterogeneous☆ world
**************************************************
SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
4

SIMONIN Matthieu's avatar
doc  
SIMONIN Matthieu committed
5
|Build Status| |License| |Pypi| |Pepy| |Chat|
SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
6

SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
7 8 9 10 11 12

What the ☆homoterogeneous☆ ?
----------------------------

Distributed systems practitioners on bare-metal testbeds know it: resources
(e.g. computes, networks) on a bare-metal infrastructure may have these slight
SIMONIN Matthieu's avatar
doc  
SIMONIN Matthieu committed
13
differences between each other that experimental code can become hairy. For
SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
such code, achieving practical portability (e.g changing the infrastructure
parameters) is thus a tedious time consuming task.


☆Homoterogeneous☆ has been coined to express the gap between the idea
we have of a computing infrastructure, where resources have
static/predictable setup, and the reality of interacting with them on a daily
basis.

EnOSlib smoothes the experimenter's code dealing with various platforms (e.g.
local machine, scientific testbed, virtualized environments). It helps in
deploying various piece of software (e.g instrumentation, observability
tools). It also integrates well with interactive development environment like
Jupyter.

SIMONIN Matthieu's avatar
doc  
SIMONIN Matthieu committed
29 30
The software
------------
SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
31

SIMONIN Matthieu's avatar
doc  
SIMONIN Matthieu committed
32
EnOSlib has been initially developed in the context of the `Discovery
SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
33
<https://beyondtheclouds.github.io/>`_ initiative and is released under the
SIMONIN Matthieu's avatar
doc  
SIMONIN Matthieu committed
34 35 36
GPLv3 licence. It's a library written in Python: you are free to import it in
your code and cherry-pick any of its functions.

SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
37

SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
38 39 40 41 42 43 44 45
.. hint::

   You can install EnOSlib with pip:

   .. code-block ::

      pip install enoslib

46 47 48 49 50 51 52
   For developping EnOSlib or get the *in development* version:

   .. code-block ::

      git clone https://gitlab.inria.fr/discovery/enoslib.git
      cd enoslib && pip install -U -e .

SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
53

SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
54 55 56 57 58 59 60
Links
-----

- Documentation: https://discovery.gitlabpages.inria.fr/enoslib/
- Source: https://gitlab.inria.fr/discovery/enoslib
- Chat: https://framateam.org/enoslib

SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
61

SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
62 63 64
.. |Build Status| image:: https://gitlab.inria.fr/discovery/enoslib/badges/master/pipeline.svg
   :target: https://gitlab.inria.fr/discovery/enoslib/pipelines

SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
65 66
.. |License| image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg
   :target: https://www.gnu.org/licenses/gpl-3.0
SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
67

SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
68
.. |Pypi| image:: https://badge.fury.io/py/enoslib.svg
SIMONIN Matthieu's avatar
SIMONIN Matthieu committed
69 70
   :target: https://badge.fury.io/py/enoslib

SIMONIN Matthieu's avatar
doc  
SIMONIN Matthieu committed
71 72 73 74 75 76
.. |Pepy| image:: https://pepy.tech/badge/enoslib/week
   :target: https://pepy.tech/project/enoslib


.. |Chat| image:: https://img.shields.io/badge/mattermost-enoslib-blueviolet
   :target: https://framateam.org/enoslib/channels/town-square
77