Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/msimonin/execo

** This is not the official execo repository **, please see http://execo.gforge.inria.fr if you want the latest up-to-date code
https://github.com/msimonin/execo

Last synced: 5 months ago
JSON representation

** This is not the official execo repository **, please see http://execo.gforge.inria.fr if you want the latest up-to-date code

Awesome Lists containing this project

README 

          
********************************************

Readme / documentation for the execo package

********************************************



Execo offers a Python API for asynchronous control of local or remote,

standalone or parallel, unix processes. It is especially well suited

for quickly and easily scripting workflows of parallel/distributed

operations on local or remote hosts: automate a scientific workflow,

conduct computer science experiments, perform automated tests,

etc. The core python package is ``execo``. The ``execo_g5k`` package

provides a set of tools and extensions for the `Grid5000

`_ testbed. The ``execo_engine`` package

provides tools to ease the development of computer sciences

experiments.



License

=======



Execo is copyright INRIA Rhone-Alpes, Service Experimentation et

Developpement.



Execo is free software: you can redistribute it and/or modify it under

the terms of the GNU General Public License as published by the Free

Software Foundation, either version 3 of the License, or (at your

option) any later version.



Execo is distributed in the hope that it will be useful, but WITHOUT

ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

for more details.



You should have received a copy of the GNU General Public License

along with Execo.  If not, see 



Versions

========



latest stable version: v2.6.3 (2017-11-29)



Installation instructions

=========================



useful links

------------



- home page:  http://execo.gforge.inria.fr



- documentation pages:



  - latest stable release:

    http://execo.gforge.inria.fr/doc/latest-stable



  - development version: http://execo.gforge.inria.fr/doc/dev



- package download: http://execo.gforge.inria.fr/downloads or

  https://gforge.inria.fr/frs/?group_id=2901



- mailing lists:



  - execo-users@lists.gforge.inria.fr for execo users

    (https://lists.gforge.inria.fr/mailman/listinfo/execo-users)



  - execo-devel@lists.gforge.inria.fr to discuss execo development

    (https://lists.gforge.inria.fr/mailman/listinfo/execo-devel)



  - execo-commits@lists.gforge.inria.fr to be notified of commits

    (https://lists.gforge.inria.fr/mailman/listinfo/execo-commits)



- bug tracker: http://bugzilla.inria.fr - product: execo



- code repository: git://scm.gforge.inria.fr/execo/execo.git



- project page on INRIA Forge: http://gforge.inria.fr/projects/execo/



platforms

---------



- works on linux (primary development platform), darwin (macosx)



- should work on bsd (not tested)



- don't know on windows or cygwin (not tested)



prerequisites

-------------



execo installation absolutely requires ``python`` 2.6 / 2.7 or

>=3.2. ``execo_g5k`` needs ``python-requests``. Optionnal packages are

(debian package names, in order of decreasing importance):



- under python 2.6, ``python-argparse`` is needed for

  `execo_engine.engine.Engine`



- ``python-keyring`` for allowing storage of `execo_g5k.api_utils` api

  password in the desktop environment keyring (allowing asking it only

  once).



- ``python-psycopg2`` for optimized interface to Grid5000 OAR planning.



- ``sphinx-doc``, ``graphviz`` for building the documentation (usually

  not needed for regular users).



- ``python-matplotlib`` (>= 1.2.0) for some graphical representations.



- ``python-networkx``, ``python-pygraphviz``, ``graphviz`` for module

  ``execo_g5k.topology``. Later versions of networkx (at least v1.11)

  also require ``python-pydotplus``, but this dependency is not

  explicitely listed in the debian package (as of July 2017).



At runtime, connecting to remote hosts requires ``ssh``, ``scp`` or

similar connection tools, and optionnaly ``taktuk`` (probably >=

3.6. http://taktuk.gforge.inria.fr/). `execo.action.ChainPut` requires

bourne shell and ``netcat`` on remote hosts.



installation

------------



To install execo from a source package (.tar.gz) or from the git

tree::



 $ python setup.py install [--user]



to build documentation (if sphinx is available)::



 $ python setup.py build_doc



to install documentation (if sphinx is available)::



 $ python setup.py install_doc



It is possible to install execo automatically with ``pip`` or

``easy_install``::



 $ pip install --user execo



or::



 $ easy_install --user execo



It is possible to generate a debian package. For example, in the execo

package toplevel dir, run (the .deb will be generated in ../)::



 $ debuild --no-tgz-check -b -i -I -k



Usage

=====



See html documentation for module execo and execo_g5k at

http://execo.gforge.inria.fr/doc/



Bugs

====



Execo is regularly used to perform advanced experiments and

administration / monitoring tasks, in and outside Grid5000. We

actively fix bugs. Bugs should be reported to http://bugzilla.inria.fr

(product: execo)



Publications

============



Matthieu Imbert, Laurent Pouilloux, Jonathan Rouzaud-Cornabas, Adrien

Lèbre, Takahiro Hirofuchi "`Using the EXECO toolbox to perform

automatic and reproducible cloud experiments

`_" *1st International Workshop on

UsiNg and building ClOud Testbeds UNICO, collocated with IEEE CloudCom

2013* 2013



How to contribute

=================



- start contributing by sending clean patches or report bugs.



- stay consistent with the coding and naming style



- code must be compatible with python 2.6, 2.7 and 3.2+ (see

  http://execo.gforge.inria.fr/doc/latest-stable/python2-python3.html)



- use the core systems provided (eg. the configuration system, the tty

  coloring system, the logger, etc.) instead of developing your own.



- provide documented code (internal documentation as well as user

  documentation where needed)



- ask a core developer before adding a dependency or dealing with

  threads, signals (particularly: creating threads)



- indent with spaces, not tabs. one level of indentation is four

  spaces (if needed: use ``reindent.py -rnv .`` in execo top

  directory)



- recommended commit messages format:



  ``[] : commit message``.



  -  can be execo, execo_g5k, execo_engine. Omit if

    commit is not specific to a module.



  -  is free form but should indicate which part(s) of the

    module the commit affects. Omit if a commit is not specific to a

    module part.