diff options
| author | Sander Vrijders <sander.vrijders@ugent.be> | 2018-03-27 16:40:59 +0200 |
|---|---|---|
| committer | Sander Vrijders <sander.vrijders@ugent.be> | 2018-03-28 16:41:40 +0200 |
| commit | e694075c7fdcc9c4579d55b792da7a1391401b35 (patch) | |
| tree | cc75c83e5ef17133c2f9e754be3eb0ebee4d6984 /rumba/prototypes/ouroboros.py | |
| parent | a1bddf0ab2cd7bee30b1f0dc1575c0b8c532e157 (diff) | |
| download | rumba-e694075c7fdcc9c4579d55b792da7a1391401b35.tar.gz rumba-e694075c7fdcc9c4579d55b792da7a1391401b35.zip | |
testbeds, prototypes, model: Add docstrings
This adds docstrings for methods of in the testbeds, prototypes and
certain things in the model.
Diffstat (limited to 'rumba/prototypes/ouroboros.py')
| -rw-r--r-- | rumba/prototypes/ouroboros.py | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/rumba/prototypes/ouroboros.py b/rumba/prototypes/ouroboros.py index 97f6e1a..dfbde9b 100644 --- a/rumba/prototypes/ouroboros.py +++ b/rumba/prototypes/ouroboros.py @@ -38,11 +38,21 @@ import rumba.testbeds.dockertb as docker logger = log.get_logger(__name__) -# An experiment over the Ouroboros implementation class Experiment(mod.Experiment): + """ + Represents an Ouroboros experiment. + """ def __init__(self, testbed, nodes=None, git_repo='git://ouroboros.ilabt.imec.be/ouroboros', git_branch='master'): + """ + Initializes the experiment class. + + :param testbed: The testbed to run the experiment on. + :param nodes: The list of nodes. + :param git_repo: The git repository to use for installation. + :param git_branch: The branch of the git repository to use. + """ mod.Experiment.__init__(self, testbed, nodes, git_repo, git_branch) self.r_ipcps = dict() |