diff --git a/_modules/index.html b/_modules/index.html index bd4c71f..8983bec 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -5,11 +5,11 @@ Overview: module code — sem 0.1.0 documentation - - - - - + + + + + @@ -65,7 +65,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 diff --git a/_modules/sem/database.html b/_modules/sem/database.html index 669af12..1974b49 100644 --- a/_modules/sem/database.html +++ b/_modules/sem/database.html @@ -5,11 +5,11 @@ sem.database — sem 0.1.0 documentation - - - - - + + + + + @@ -600,7 +600,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 diff --git a/_modules/sem/manager.html b/_modules/sem/manager.html index 716efe2..542d2d1 100644 --- a/_modules/sem/manager.html +++ b/_modules/sem/manager.html @@ -5,11 +5,11 @@ sem.manager — sem 0.1.0 documentation - - - - - + + + + + @@ -381,6 +381,7 @@

Source code for sem.manager

         if show_progress:
             result_generator = tqdm(results, total=len(param_list),
                                     unit='simulation',
+                                    smoothing=0,
                                     desc='Running simulations')
         else:
             result_generator = results
@@ -986,7 +987,7 @@ 
Quick search

       ©2021, Davide Magrin.
       
       |
-      Powered by Sphinx 7.0.0
+      Powered by Sphinx 7.1.2
       & Alabaster 0.7.13
diff --git a/_modules/sem/runner.html b/_modules/sem/runner.html index bb6fedd..c121ca2 100644 --- a/_modules/sem/runner.html +++ b/_modules/sem/runner.html @@ -5,11 +5,11 @@ sem.runner — sem 0.1.0 documentation - - - - - + + + + + @@ -446,7 +446,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 diff --git a/_static/basic.css b/_static/basic.css index 7577acb..cfc60b8 100644 --- a/_static/basic.css +++ b/_static/basic.css @@ -670,6 +670,16 @@ dd { margin-left: 30px; } +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + dl > dd:last-child, dl > dd:last-child > :last-child { margin-bottom: 0; @@ -738,6 +748,14 @@ abbr, acronym { cursor: help; } +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + /* -- code displays --------------------------------------------------------- */ pre { diff --git a/_static/pygments.css b/_static/pygments.css index 691aeb8..0d49244 100644 --- a/_static/pygments.css +++ b/_static/pygments.css @@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #A00000 } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ .highlight .gr { color: #FF0000 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gi { color: #00A000 } /* Generic.Inserted */ diff --git a/api.html b/api.html index ac47d33..71b0f39 100644 --- a/api.html +++ b/api.html @@ -3,14 +3,14 @@ - + API Reference — sem 0.1.0 documentation - - - - - + + + + + @@ -956,7 +956,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 | diff --git a/cli.html b/cli.html index 40a2a1d..b461360 100644 --- a/cli.html +++ b/cli.html @@ -3,14 +3,14 @@ - + Command Line Interface — sem 0.1.0 documentation - - - - - + + + + + @@ -336,7 +336,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 | diff --git a/contributing.html b/contributing.html index 5c51733..24d5428 100644 --- a/contributing.html +++ b/contributing.html @@ -3,14 +3,14 @@ - + Contribution guidelines — sem 0.1.0 documentation - - - - - + + + + + @@ -169,7 +169,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 | diff --git a/detailed-functionality.html b/detailed-functionality.html index a71d3f3..44a2855 100644 --- a/detailed-functionality.html +++ b/detailed-functionality.html @@ -3,14 +3,14 @@ - + Detailed Functionality — sem 0.1.0 documentation - - - - - + + + + + @@ -244,7 +244,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 | diff --git a/examples.html b/examples.html index c905d72..6c08d55 100644 --- a/examples.html +++ b/examples.html @@ -3,14 +3,14 @@ - + Examples walkthrough — sem 0.1.0 documentation - - - - - + + + + + @@ -138,7 +138,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 | diff --git a/genindex.html b/genindex.html index 3ece0f2..25d89c6 100644 --- a/genindex.html +++ b/genindex.html @@ -5,11 +5,11 @@ Index — sem 0.1.0 documentation - - - - - + + + + + @@ -306,7 +306,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 diff --git a/getting-started.html b/getting-started.html index 3cc6efe..1862baa 100644 --- a/getting-started.html +++ b/getting-started.html @@ -3,14 +3,14 @@ - + Getting started — sem 0.1.0 documentation - - - - - + + + + + @@ -305,7 +305,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 | diff --git a/index.html b/index.html index 64ffc19..993ab92 100644 --- a/index.html +++ b/index.html @@ -3,14 +3,14 @@ - + The ns-3 Simulation Execution Manager — sem 0.1.0 documentation - - - - - + + + + + @@ -159,7 +159,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 | diff --git a/installation.html b/installation.html index 625d48c..4fc4bb7 100644 --- a/installation.html +++ b/installation.html @@ -3,14 +3,14 @@ - + Installation — sem 0.1.0 documentation - - - - - + + + + + @@ -112,7 +112,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 | diff --git a/py-modindex.html b/py-modindex.html index 6463dfd..c171b63 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -5,11 +5,11 @@ Python Module Index — sem 0.1.0 documentation - - - - - + + + + + @@ -86,7 +86,7 @@

Quick search

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 diff --git a/search.html b/search.html index 8fd34eb..ffca8b5 100644 --- a/search.html +++ b/search.html @@ -5,12 +5,12 @@ Search — sem 0.1.0 documentation - - + + - - - + + + @@ -85,7 +85,7 @@

Related Topics

©2021, Davide Magrin. | - Powered by Sphinx 7.0.0 + Powered by Sphinx 7.1.2 & Alabaster 0.7.13 diff --git a/searchindex.js b/searchindex.js index ab9c301..f0e5509 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["api", "cli", "contributing", "detailed-functionality", "examples", "getting-started", "index", "installation"], "filenames": ["api.rst", "cli.rst", "contributing.rst", "detailed-functionality.rst", "examples.rst", "getting-started.rst", "index.rst", "installation.rst"], "titles": ["API Reference", "Command Line Interface", "Contribution guidelines", "Detailed Functionality", "Examples walkthrough", "Getting started", "The ns-3 Simulation Execution Manager", "Installation"], "terms": {"class": [0, 2, 5, 6], "sem": [0, 1, 3, 4, 5, 6, 7], "campaign_db": 0, "campaign_runn": 0, "check_repo": 0, "true": [0, 1, 5, 6], "sourc": 0, "thi": [0, 1, 2, 3, 4, 5, 7], "simul": [0, 2, 4], "execut": [0, 1, 2, 3, 5], "manag": [0, 1, 2], "can": [0, 1, 2, 3, 4, 5, 6, 7], "us": [0, 1, 2, 3, 4, 5, 7], "an": [0, 1, 2, 3, 4, 5, 7], "interfac": [0, 2, 3, 5, 6], "access": [0, 3, 5, 6], "result": [0, 2, 4, 6], "campaign": [0, 1, 4, 6], "The": [0, 1, 2, 4, 5, 7], "wrap": 0, "up": [0, 2, 5], "which": [0, 1, 3, 4, 5], "ar": [0, 1, 2, 3, 4, 5, 7], "intern": [0, 5], "also": [0, 1, 2, 3, 5, 7], "public": 0, "member": [0, 3], "variabl": [0, 1, 3, 4], "check_repo_ok": 0, "make": [0, 1, 2, 5], "sure": [0, 1, 2], "n": [0, 1, 2, 3, 5], "3": [0, 1, 2, 3, 5], "repositori": [0, 2, 5, 7], "": [0, 1, 2, 3, 4, 5], "head": [0, 1, 5], "commit": [0, 3], "i": [0, 1, 2, 3, 4, 5, 7], "same": [0, 1, 3, 5, 7], "one": [0, 1, 2, 3, 4, 5, 7], "save": [0, 1, 3, 4, 5, 6], "databas": [0, 1, 5], "clean": [0, 5], "e": [0, 1, 2, 3, 5], "untrack": 0, "modifi": 0, "file": [0, 1, 2, 3, 4, 5, 6], "exist": [0, 1, 3, 5], "create_runn": 0, "script": [0, 1, 3, 4, 5], "runner_typ": 0, "auto": 0, "optim": [0, 1], "skip_configur": 0, "fals": [0, 1, 5, 6], "max_parallel_process": 0, "none": 0, "creat": [0, 1, 2, 3, 6], "from": [0, 1, 2, 3, 5, 6, 7], "string": [0, 1, 4, 5], "contain": [0, 1, 2, 3, 4, 5], "desir": [0, 3, 6], "implement": [0, 3], "return": [0, 3, 4, 5], "paramet": [0, 1, 3, 4, 5, 6], "ns_path": [0, 5], "str": 0, "path": [0, 1, 3, 5, 7], "instal": [0, 1, 3, 5, 6], "emploi": [0, 5], "run": [0, 2, 4, 6], "valu": [0, 1, 3, 4, 5], "sequenti": 0, "local": 0, "parallelrunn": [0, 3], "parallel": [0, 2, 3, 6], "gridrunn": [0, 3], "drmaa": [0, 3, 6], "compat": [0, 6], "task": [0, 3], "schedul": 0, "If": [0, 1, 2, 5], "automat": [0, 1, 2, 5, 6], "pick": 0, "best": [0, 5], "avail": [0, 1, 3, 4, 5, 6, 7], "runner": 0, "otherwis": [0, 5], "bool": 0, "whether": [0, 1, 5], "configur": 0, "build": [0, 1], "skip": [0, 1], "step": [0, 1, 2], "onli": [0, 1, 3, 4, 5], "perform": [0, 1, 2, 3, 5, 6], "compil": [0, 2], "files_in_dictionari": 0, "pars": [0, 1, 3, 4, 5, 6], "function": [0, 2, 4, 5, 6], "dictionari": [0, 1, 3, 4, 5], "entri": [0, 3], "each": [0, 1, 2, 3, 4, 5], "typic": [0, 2, 3], "extern": 0, "get_missing_simul": 0, "param_list": 0, "with_time_estim": 0, "list": [0, 1, 3, 5], "among": [0, 3], "requir": [0, 1, 2, 3, 5, 6, 7], "ones": [0, 3, 5], "all": [0, 1, 2, 3, 5], "combin": [0, 1, 3, 5, 6], "int": 0, "integ": 0, "repres": [0, 1, 3], "how": [0, 3, 4, 5], "mani": [0, 5], "repetit": [0, 1, 5], "want": [0, 1, 2], "alreadi": [0, 1, 3, 5], "featur": [0, 3], "rngrun": [0, 1, 3, 5], "boolean": 0, "get_results_as_datafram": 0, "result_parsing_funct": 0, "column": 0, "param": [0, 1, 3, 4, 5], "param_column": 0, "drop_constant_column": 0, "parallel_pars": 0, "verbos": 0, "panda": [0, 6], "datafram": [0, 6], "user": [0, 1, 3, 4, 7], "specifi": [0, 1, 3, 4, 5], "function_yields_multiple_result": 0, "expect": [0, 1], "output": [0, 1, 2, 3, 4, 5, 6], "should": [0, 2, 5], "equal": [0, 2], "number": [0, 1, 2, 5], "label": [0, 5], "describ": [0, 1, 2, 3], "content": [0, 1, 3, 4], "instead": [0, 1, 3, 5], "multipl": [0, 1, 4, 5, 6], "In": [0, 1, 2, 3, 4, 5, 7], "case": [0, 1, 2, 4, 7], "yield": 0, "row": 0, "length": 0, "comput": [0, 2, 6], "defin": [0, 1, 3, 4, 5], "take": [0, 1, 3, 4, 5], "input": [0, 3], "get_results_as_numpy_arrai": [0, 3], "parameter_spac": 0, "extract_complete_result": 0, "rel": 0, "space": [0, 1, 3, 4, 5], "form": [0, 3, 4], "numpi": [0, 1, 3, 5, 6], "arrai": [0, 1, 5], "dict": 0, "pair": [0, 3, 5], "argument": [0, 3], "gather": [0, 3], "get_results_as_xarrai": [0, 3, 4, 5], "output_label": 0, "xarrai": [0, 3, 4, 5, 6], "data": [0, 1, 2, 3, 4], "structur": [0, 1, 2, 3, 4, 5], "export": [0, 2, 4, 6], "appli": [0, 4], "dimens": 0, "get_spac": 0, "current_result_list": 0, "current_queri": 0, "param_spac": 0, "convert": 0, "specif": [0, 5], "nest": 0, "other": [0, 1, 2], "word": 0, "1": [0, 1, 4, 5, 6], "2": [0, 1, 3, 5], "b": 0, "4": [0, 1, 5], "like": [0, 2, 3, 5], "follow": [0, 1, 2, 3, 4, 5, 7], "where": [0, 1, 5], "first": [0, 1, 2, 3, 5], "second": [0, 5], "easili": [0, 5, 7], "via": [0, 2, 3, 6], "np": [0, 5], "queri": [0, 1, 2, 3], "represent": 0, "call": [0, 1, 2, 3, 4], "metric": [0, 4], "classmethod": 0, "load": [0, 1, 3, 6], "campaign_dir": [0, 3, 5], "note": [0, 1, 2, 3, 5], "compulsori": 0, "when": [0, 1, 2, 3, 6], "method": [0, 2, 3, 4], "order": [0, 1, 2, 3, 5], "addit": [0, 3, 5], "necessari": [0, 1, 3], "object": [0, 2, 4, 5], "assign": 0, "directori": [0, 1, 5, 6], "new": [0, 1, 2, 3, 5, 6], "overwrit": [0, 5], "its": [0, 1, 2, 3, 5, 7], "match": [0, 4], "config": 0, "instanc": [0, 1, 3, 5], "set": [0, 1, 5], "wipe": 0, "place": 0, "furthermor": 0, "initi": [0, 5], "type": [0, 1], "lock": 0, "final": [0, 1, 2, 3, 5], "creation": [0, 2, 3, 5], "git": [0, 2, 5, 6, 7], "allow": [0, 2], "enforc": [0, 6], "reproduc": [0, 6], "avoid": [0, 1], "mix": 0, "come": 0, "differ": [0, 2, 4, 5], "version": [0, 1, 7], "librari": [0, 2, 3, 4, 5, 7], "folder": [0, 2, 3, 4, 5, 7], "delet": 0, "were": [0, 1, 3, 5], "detect": [0, 1], "manual": 0, "out": [0, 1, 3, 5], "run_missing_simul": [0, 3, 4, 5, 6], "condition_checking_funct": 0, "callback": 0, "stop_on_error": 0, "yet": 0, "we": [0, 1, 3, 4, 5], "have": [0, 1, 5], "least": 0, "replic": [0, 1], "addition": [0, 1, 5], "either": [0, 1, 3], "expand": 0, "through": [0, 1, 2, 3, 4, 5], "list_param_combin": [0, 5], "doesn": [0, 3], "t": [0, 3], "kei": [0, 3, 5], "extend": 0, "callbackbas": 0, "trigger": 0, "dure": 0, "stop": [0, 2], "error": [0, 2, 4], "occur": 0, "run_simul": [0, 3, 5], "show_progress": 0, "sever": 0, "doe": [0, 1], "verifi": 0, "just": 0, "item": 0, "show": [0, 1, 2, 4], "progress": [0, 5], "bar": [0, 5], "percentag": [0, 2], "remain": [0, 5], "time": [0, 3, 4, 5], "save_to_fold": [0, 3], "folder_nam": 0, "save_to_mat_fil": [0, 3], "filenam": [0, 1, 3, 4], "mat": [0, 1, 5, 6], "name": [0, 3, 5], "save_to_npy_fil": [0, 3], "format": [0, 1, 2, 3, 5, 6], "space_to_fold": 0, "current_directori": 0, "tree": [0, 5, 6], "system": [0, 3, 7], "configure_and_build": 0, "code": [0, 2, 3, 4, 6], "displai": [0, 5], "standard": [0, 2, 5], "get_available_paramet": 0, "made": 0, "get_build_output": 0, "process": [0, 1, 2, 3, 5, 6], "build_program": 0, "extract": [0, 1, 5], "inform": [0, 1, 2, 3, 5], "need": [0, 1, 3, 4, 5], "draw": 0, "subprocess": 0, "listen": 0, "parameter_list": 0, "data_fold": 0, "certain": 0, "complet": 0, "subfold": 0, "whole": [0, 2], "db": [0, 3, 5, 6], "serv": [0, 1, 3], "A": [0, 1, 5], "scratch": [0, 3, 5], "delete_result": 0, "remov": [0, 7], "base": [0, 3, 6], "id": [0, 1, 3, 4, 5], "get_all_values_of_all_param": 0, "taken": [0, 1], "alwai": 0, "alphabet": 0, "get_commit": 0, "oper": [0, 5], "get_complete_result": [0, 3, 6], "result_id": [0, 1], "files_to_load": 0, "analog": 0, "what": [0, 1, 3, 4], "get_result": [0, 5], "read": [0, 1], "correspond": [0, 1, 3, 5], "incorpor": 0, "them": [0, 1, 3, 5], "under": [0, 1, 3, 5], "file_cont": 0, "document": [0, 1, 2, 3, 4], "param1": [0, 3, 4], "value1": [0, 1, 3], "param2": [0, 3], "value2": [0, 1, 3], "value3": [0, 1, 3], "meta": [0, 1, 3, 4], "elapsed_tim": [0, 1, 3, 4, 5], "value4": 0, "value5": 0, "stdout": [0, 1, 4, 5, 6], "stdout_as_str": 0, "stderr": [0, 1, 4, 6], "stderr_as_str": 0, "file1": 0, "file1_as_str": 0, "includ": 0, "even": 0, "thei": [0, 1, 4], "empti": 0, "get_config": 0, "command": [0, 2, 3, 5, 6, 7], "line": [0, 2, 3, 5, 6], "get_data_dir": 0, "simpli": [0, 1, 3], "campaign_directori": 0, "get_next_rngrun": 0, "next": 0, "get_next_valu": 0, "values_list": 0, "given": 0, "lowest": 0, "do": [0, 1, 3, 5], "appear": 0, "import": [0, 5, 6], "v": 0, "0": [0, 1, 3, 4, 5], "5": [0, 1, 5, 6], "6": [0, 1, 5], "get_param": 0, "toggl": 0, "get_result_fil": 0, "filepath": 0, "associ": [0, 5], "g": [0, 1], "obtain": [0, 1, 4, 5], "fulfil": 0, "some": [0, 3, 4, 5], "must": [0, 2, 3], "interest": [0, 1, 2, 5], "For": [0, 1, 5], "exampl": [0, 1, 2, 3, 5, 6], "Not": 0, "unspecifi": 0, "assum": [0, 5], "free": 0, "ani": [0, 2, 5, 7], "insert": [0, 2, 3], "insert_result": [0, 3], "get_script": 0, "have_same_structur": 0, "d2": 0, "two": [0, 1, 3, 6], "possibli": [0, 5], "check": [0, 3, 5], "d1": 0, "d3": 0, "c": 0, "d4": 0, "d5": 0, "d6": 0, "d": 0, "7": [0, 1, 5, 6], "elaps": 0, "float": [0, 4, 5], "took": 0, "uuid": 0, "uniqu": [0, 3, 5], "identifi": [0, 5], "locat": [0, 5], "It": 0, "json": [0, 1, 3], "ha": 0, "overwritten": 0, "wipe_result": 0, "cannot": 0, "undon": 0, "level": [0, 3], "info": [0, 1, 5], "messag": [0, 1, 3], "debug": [0, 1], "init_callback": 0, "controlled_by_par": 0, "is_controlled_by_par": 0, "awar": 0, "been": 0, "multithread": 0, "thu": 0, "subset": 0, "on_run_end": 0, "sim_uuid": 0, "return_cod": 0, "sim_tim": 0, "finish": [0, 1, 2, 3, 5], "todo": 0, "mayb": [0, 1], "lot": 0, "sens": 0, "sinc": [0, 1, 2, 5], "eventu": 0, "overridden": 0, "fail": 0, "on_run_start": 0, "referenc": 0, "automatic_pars": 0, "dtype": 0, "try": [0, 1, 5], "tabl": [0, 1, 3], "hood": [0, 3, 5], "essenti": [0, 4], "genfromtxt": 0, "pass": [0, 3, 4], "kwarg": 0, "see": [0, 1, 3], "more": [0, 3, 5], "detail": [0, 1, 2, 5, 6, 7], "compute_sensitivity_analysi": 0, "rang": [0, 1, 5], "salib_sample_funct": 0, "sampl": 0, "salib_analyze_funct": 0, "analyz": 0, "100": [0, 1, 3, 5, 6], "sensit": 0, "analysi": [0, 5], "salib": 0, "constant_array_pars": 0, "dummi": 0, "parser": 0, "test": [0, 6], "purpos": [0, 1], "get_bound": 0, "bound": 0, "start": [0, 2, 6, 7], "min": 0, "max": 0, "possibl": [0, 1, 5], "get_command_from_result": 0, "templat": [0, 1], "param_rang": 0, "robust": 0, "salib_param_values_to_param": 0, "stdout_automatic_pars": 0, "matrix": 0, "offer": [1, 4], "tool": 1, "quickli": [1, 4], "scroll": 1, "everyth": 1, "look": 1, "ok": 1, "matlab": [1, 6], "npy": [1, 5, 6], "further": 1, "elabor": [1, 3, 5], "page": [1, 2, 4, 5], "workflow": [1, 5], "write": 1, "python": [1, 2, 3, 4, 5, 6, 7], "reli": 1, "To": [1, 2, 3, 7], "usag": 1, "program": 1, "flag": [1, 2], "option": [1, 7], "arg": 1, "exit": 1, "print": [1, 2, 3, 4, 5], "section": [1, 3, 5], "sub": [1, 2], "visual": [1, 4, 5], "about": [1, 3], "dir": 1, "text": 1, "choic": 1, "prompt": 1, "wifi": [1, 5, 6], "multi": [1, 3, 5, 6], "tos": [1, 5, 6], "channelwidth": [1, 5, 6], "distanc": [1, 5, 6], "mc": [1, 5, 6], "nwifi": [1, 5, 6], "simulationtim": [1, 3, 5, 6], "usert": [1, 5, 6], "useshortguardinterv": [1, 5, 6], "c19d291f35f2a394d03c3fc7c74377b65666e1a4": 1, "after": [1, 2, 3, 4, 5], "ask": 1, "These": 1, "singl": [1, 2, 4, 5], "enclos": 1, "quotat": 1, "mark": [1, 2], "20": [1, 5, 6], "10": [1, 5, 6], "80": 1, "02": [1, 5], "43": 1, "00": [1, 5, 6], "05": 1, "inde": 1, "correct": 1, "respect": 1, "explor": [1, 3, 5], "u": [1, 7], "16": 1, "mean": [1, 3, 5], "At": [1, 5], "point": [1, 5], "sai": 1, "realiz": 1, "effect": [1, 2], "happen": 1, "suffic": 1, "again": 1, "befor": [1, 2, 5], "previous": [1, 5], "ran": 1, "account": 1, "lead": 1, "anoth": 1, "batch": 1, "160": 1, "would": [1, 2], "cover": 1, "entir": 1, "propos": 1, "default": 1, "accept": [1, 3], "press": 1, "enter": 1, "04": 1, "55": 1, "69": 1, "nice": 1, "our": 1, "let": [1, 5], "work": [1, 2, 3, 5], "so": [1, 3, 5], "hide": 1, "hidden": 1, "veri": [1, 3], "long": 1, "enabl": 1, "fairli": 1, "small": 1, "directli": [1, 5, 7], "632506847381592": 1, "fb1bd9be": 1, "b034": 1, "4f36": 1, "9562": 1, "07aa7988a266": 1, "aggreg": [1, 5], "throughput": [1, 4, 5], "18": 1, "9311": 1, "mbit": [1, 5], "ve": 1, "consist": [1, 3, 5], "shown": [1, 3], "here": [1, 2, 3, 4, 7], "printout": 1, "inspect": [1, 4, 5], "wa": [1, 5], "achiev": [1, 4, 6], "previou": [1, 2], "abl": 1, "waf": 1, "gdb": 1, "debugg": 1, "copi": [1, 3], "past": 1, "root": [1, 2], "david": [1, 2], "leav": 1, "store": 1, "compile_command": 1, "successfulli": [1, 2], "352": 1, "confirm": 1, "gener": [1, 2, 3, 5, 6], "One": 1, "now": 1, "extens": [1, 2], "deduc": 1, "tri": 1, "support": [1, 2, 5, 6], "recogn": 1, "howev": [1, 7], "seen": 1, "switch": 1, "off": [1, 5], "keep": 1, "relev": [1, 4, 5], "dimension": 1, "cell": 1, "struct": 1, "link": [1, 3], "non": 1, "variou": [2, 3, 6], "resourc": 2, "those": [2, 3], "who": 2, "get": [2, 6, 7], "develop": [2, 7], "fix": 2, "bug": 2, "updat": [2, 7], "clone": [2, 7], "github": [2, 5, 7], "http": [2, 7], "com": [2, 7], "signetlabdei": [2, 7], "modul": [2, 3], "pipenv": 2, "virtual": 2, "environ": 2, "depend": [2, 7], "enough": [2, 7], "pip": [2, 6], "project": [2, 5, 7], "packag": [2, 7], "dev": [2, 7], "shell": [2, 6], "repl": 2, "interact": [2, 3], "edit": 2, "mode": 2, "pipfil": 2, "chang": 2, "subdirectori": 2, "immedi": 2, "without": [2, 3], "pytest": 2, "By": 2, "procedur": 2, "abov": [2, 3, 5], "you": [2, 3, 5, 7], "download": [2, 7], "xdist": 2, "cov": 2, "coverag": 2, "prefix": 2, "test_": 2, "compon": [2, 3], "test_cli": 2, "py": [2, 5, 6], "click": 2, "facil": [2, 4], "test_databas": 2, "databasemanag": [2, 3, 5, 6], "test_exampl": 2, "test_manag": 2, "campaignmanag": [2, 4, 5, 6], "test_runn": 2, "simulationrunn": [2, 3, 6], "test_util": 2, "util": [2, 6], "provid": [2, 3, 4, 5], "conftest": 2, "hand": 2, "fixtur": 2, "common": 2, "temporari": 2, "share": 2, "between": 2, "x": [2, 5], "home": 2, "test_cli_workflow": 2, "ensur": 2, "failur": 2, "while": [2, 3], "disabl": 2, "captur": 2, "add": 2, "consid": 2, "most": [2, 3, 7], "involv": [2, 3], "o": 2, "speed": 2, "consider": [2, 3], "ad": [2, 3, 5], "report": 2, "html": 2, "docstr": 2, "doctest": 2, "glob": 2, "rst": 2, "doc": [2, 5], "suit": 2, "submit": 2, "pull": 2, "request": [2, 5], "both": [2, 3, 5], "lower": 2, "than": 2, "readi": 2, "submiss": 2, "leverag": [3, 4, 6], "practic": 3, "refer": [3, 5], "primer": 3, "screen": 3, "mai": 3, "influenc": 3, "term": 3, "short": 3, "wai": 3, "collect": [3, 5], "higher": 3, "major": 3, "action": 3, "administr": 3, "precis": [3, 7], "wherea": 3, "still": 3, "view": [3, 6], "Of": 3, "cours": 3, "tinydb": 3, "hash": 3, "12293100357055664": 3, "241ec0ef": 3, "34b3": 3, "466f": 3, "9eb1": 3, "08b736b8afd5": 3, "appperiod": 3, "600": 3, "ndevic": 3, "radiu": 3, "5500": 3, "insid": 3, "separ": 3, "reason": 3, "over": [3, 4, 5], "expens": 3, "could": 3, "inflat": 3, "size": 3, "needlessli": 3, "definit": 3, "simpl": 3, "notabl": 3, "overload": 3, "core": 3, "similarli": 3, "cluster": [3, 6], "As": [3, 5], "state": [3, 5], "realli": 3, "know": 3, "twice": 3, "actual": [3, 5], "miss": 3, "current": [3, 5, 7], "soon": 3, "field": [3, 4, 5], "five": 3, "main": 3, "last": 3, "three": 3, "walk": 4, "explain": 4, "full": 4, "portion": 4, "showcas": 4, "integr": 4, "plot": [4, 5, 6], "everi": 4, "def": [4, 5], "get_average_throughput": [4, 5], "m": 4, "re": [4, 6, 7], "9": [4, 5], "dotal": 4, "group": 4, "reduc": [4, 5], "tupl": 4, "avgthroughput": [4, 5], "goe": 4, "spent": 4, "guid": 5, "illustr": 5, "api": 5, "comprehens": 5, "overview": 5, "thing": 5, "vari": 5, "portabl": 5, "varieti": 5, "go": [5, 6], "vanilla": 5, "few": [5, 6], "wifi_exampl": [5, 6], "instruct": [5, 7], "interpret": 5, "tmp": [5, 6], "valid": 5, "statu": 5, "9386dc7d106fd9241ff151195a0e6e5cb954d363": 5, "retriev": 5, "sha": 5, "param_combin": 5, "81": 5, "later": 5, "indic": 5, "give": 5, "estim": 5, "translat": 5, "09": 5, "63": 5, "notic": 5, "fact": 5, "found": 5, "regardless": 5, "reproduct": 5, "henc": 5, "someth": 5, "turn": 5, "requesttosend": 5, "shortguardinterv": 5, "8": 5, "32": 5, "57": 5, "86": 5, "outsid": 5, "attribut": 5, "len": 5, "771e0511": 5, "43b9": 5, "4e33": 5, "aa6a": 5, "dc4266be24f1": 5, "270819187164307": 5, "49": 5, "2696": 5, "seed": 5, "random": 5, "transform": 5, "averag": 5, "measur": 5, "put": 5, "split": 5, "dataarrai": [5, 6], "8351": 5, "8057": 5, "8163": 5, "11": 5, "849": 5, "8549": 5, "7901": 5, "35": 5, "2868": 5, "3763": 5, "3044": 5, "36": 5, "4903": 5, "4137": 5, "4432": 5, "coordin": 5, "u5": 5, "int64": 5, "appropri": 5, "slice": 5, "matplotlib": 5, "agg": 5, "pyplot": 5, "plt": 5, "iter": 5, "avg": 5, "sel": 5, "std": 5, "eb": 5, "errorbar": 5, "y": 5, "yerr": 5, "sgi": 5, "rt": 5, "xlb": 5, "xlabel": 5, "ylb": 5, "ylabel": 5, "legend": 5, "loc": 5, "savefig": 5, "png": 5, "effici": 6, "altern": 6, "finer": 6, "control": 6, "24": 6, "42": 6, "77": 6, "ndarrai": 6, "codebas": 6, "track": 6, "help": 6, "paradigm": 6, "diagram": 6, "walkthrough": 6, "contribut": 6, "guidelin": 6, "contributor": 6, "framework": 6, "pip3": 7, "latest": 7, "branch": 7, "archiv": 7, "zip": 7, "your": 7, "issu": 7, "uninstal": 7, "setup": 7, "nsnam": 7, "checkout": 7, "releas": 7, "33": 7}, "objects": {"sem": [[0, 0, 1, "", "CampaignManager"], [0, 0, 1, "", "DatabaseManager"], [0, 0, 1, "", "SimulationRunner"], [0, 2, 0, "-", "utils"]], "sem.CampaignManager": [[0, 1, 1, "", "check_repo_ok"], [0, 1, 1, "", "create_runner"], [0, 1, 1, "", "files_in_dictionary"], [0, 1, 1, "", "get_missing_simulations"], [0, 1, 1, "", "get_results_as_dataframe"], [0, 1, 1, "", "get_results_as_numpy_array"], [0, 1, 1, "", "get_results_as_xarray"], [0, 1, 1, "", "get_space"], [0, 1, 1, "", "load"], [0, 1, 1, "", "new"], [0, 1, 1, "", "run_missing_simulations"], [0, 1, 1, "", "run_simulations"], [0, 1, 1, "", "save_to_folders"], [0, 1, 1, "", "save_to_mat_file"], [0, 1, 1, "", "save_to_npy_file"], [0, 1, 1, "", "space_to_folders"]], "sem.DatabaseManager": [[0, 1, 1, "", "delete_result"], [0, 1, 1, "", "get_all_values_of_all_params"], [0, 1, 1, "", "get_commit"], [0, 1, 1, "", "get_complete_results"], [0, 1, 1, "", "get_config"], [0, 1, 1, "", "get_data_dir"], [0, 1, 1, "", "get_next_rngruns"], [0, 1, 1, "", "get_next_values"], [0, 1, 1, "", "get_params"], [0, 1, 1, "", "get_result_files"], [0, 1, 1, "", "get_results"], [0, 1, 1, "", "get_script"], [0, 1, 1, "", "have_same_structure"], [0, 1, 1, "", "insert_result"], [0, 1, 1, "", "load"], [0, 1, 1, "", "new"], [0, 1, 1, "", "wipe_results"]], "sem.SimulationRunner": [[0, 1, 1, "", "configure_and_build"], [0, 1, 1, "", "get_available_parameters"], [0, 1, 1, "", "get_build_output"], [0, 1, 1, "", "run_simulations"]], "sem.utils": [[0, 0, 1, "", "CallbackBase"], [0, 3, 1, "", "automatic_parser"], [0, 3, 1, "", "compute_sensitivity_analysis"], [0, 3, 1, "", "constant_array_parser"], [0, 3, 1, "", "get_bounds"], [0, 3, 1, "", "get_command_from_result"], [0, 3, 1, "", "list_param_combinations"], [0, 3, 1, "", "salib_param_values_to_params"], [0, 3, 1, "", "stdout_automatic_parser"]], "sem.utils.CallbackBase": [[0, 1, 1, "", "init_callback"], [0, 1, 1, "", "is_controlled_by_parent"], [0, 1, 1, "", "on_run_end"], [0, 1, 1, "", "on_run_start"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:module", "3": "py:function"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "module", "Python module"], "3": ["py", "function", "Python function"]}, "titleterms": {"api": [0, 6], "refer": [0, 6], "campaignmanag": [0, 3], "simulationrunn": 0, "databasemanag": 0, "util": 0, "command": 1, "line": 1, "interfac": 1, "get": [1, 3, 5], "help": 1, "run": [1, 3, 5], "simul": [1, 3, 5, 6], "view": 1, "result": [1, 3, 5], "re": 1, "export": [1, 3, 5], "contribut": 2, "guidelin": 2, "sem": 2, "instal": [2, 7], "contributor": 2, "test": 2, "framework": 2, "detail": 3, "function": 3, "The": [3, 6], "campaign": [3, 5], "paradigm": 3, "obtain": 3, "object": 3, "databas": 3, "manag": [3, 6], "briefli": 3, "runner": 3, "singl": 3, "class": 3, "diagram": 3, "exampl": 4, "walkthrough": 4, "wifi_exampl": 4, "py": 4, "start": 5, "creat": 5, "load": 5, "n": [6, 7], "3": [6, 7], "execut": 6, "featur": 6, "highlight": 6, "user": 6, "": 6, "guid": 6, "via": 7, "pip": 7}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 57}, "alltitles": {"API Reference": [[0, "api-reference"], [6, "api-reference"]], "CampaignManager": [[0, "campaignmanager"]], "SimulationRunner": [[0, "simulationrunner"]], "DatabaseManager": [[0, "databasemanager"]], "Utils": [[0, "module-sem.utils"]], "Command Line Interface": [[1, "command-line-interface"]], "Getting help": [[1, "getting-help"]], "Running simulations": [[1, "running-simulations"], [3, "running-simulations"], [5, "running-simulations"]], "Viewing results": [[1, "viewing-results"]], "Getting commands to re-run simulations": [[1, "getting-commands-to-re-run-simulations"]], "Exporting results": [[1, "exporting-results"], [3, "exporting-results"], [5, "exporting-results"]], "Contribution guidelines": [[2, "contribution-guidelines"]], "SEM installation for contributors": [[2, "sem-installation-for-contributors"]], "Testing framework": [[2, "testing-framework"]], "Detailed Functionality": [[3, "detailed-functionality"]], "The simulation campaign paradigm": [[3, "the-simulation-campaign-paradigm"]], "Obtaining a CampaignManager object": [[3, "obtaining-a-campaignmanager-object"]], "Database management, briefly": [[3, "database-management-briefly"]], "Simulation runners, briefly": [[3, "simulation-runners-briefly"]], "Results": [[3, "results"]], "Getting single results": [[3, "getting-single-results"]], "Class diagram": [[3, "class-diagram"]], "Examples walkthrough": [[4, "examples-walkthrough"]], "wifi_example.py": [[4, "wifi-example-py"]], "Getting started": [[5, "getting-started"]], "Creating and loading a simulation campaign": [[5, "creating-and-loading-a-simulation-campaign"]], "The ns-3 Simulation Execution Manager": [[6, "the-ns-3-simulation-execution-manager"]], "Feature highlights": [[6, "feature-highlights"]], "User\u2019s guide": [[6, "user-s-guide"]], "Installation": [[7, "installation"]], "Via pip": [[7, "via-pip"]], "Installing ns-3": [[7, "installing-ns-3"]]}, "indexentries": {"callbackbase (class in sem.utils)": [[0, "sem.utils.CallbackBase"]], "campaignmanager (class in sem)": [[0, "sem.CampaignManager"]], "databasemanager (class in sem)": [[0, "sem.DatabaseManager"]], "simulationrunner (class in sem)": [[0, "sem.SimulationRunner"]], "automatic_parser() (in module sem.utils)": [[0, "sem.utils.automatic_parser"]], "check_repo_ok() (sem.campaignmanager method)": [[0, "sem.CampaignManager.check_repo_ok"]], "compute_sensitivity_analysis() (in module sem.utils)": [[0, "sem.utils.compute_sensitivity_analysis"]], "configure_and_build() (sem.simulationrunner method)": [[0, "sem.SimulationRunner.configure_and_build"]], "constant_array_parser() (in module sem.utils)": [[0, "sem.utils.constant_array_parser"]], "create_runner() (sem.campaignmanager method)": [[0, "sem.CampaignManager.create_runner"]], "delete_result() (sem.databasemanager method)": [[0, "sem.DatabaseManager.delete_result"]], "files_in_dictionary() (sem.campaignmanager method)": [[0, "sem.CampaignManager.files_in_dictionary"]], "get_all_values_of_all_params() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_all_values_of_all_params"]], "get_available_parameters() (sem.simulationrunner method)": [[0, "sem.SimulationRunner.get_available_parameters"]], "get_bounds() (in module sem.utils)": [[0, "sem.utils.get_bounds"]], "get_build_output() (sem.simulationrunner method)": [[0, "sem.SimulationRunner.get_build_output"]], "get_command_from_result() (in module sem.utils)": [[0, "sem.utils.get_command_from_result"]], "get_commit() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_commit"]], "get_complete_results() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_complete_results"]], "get_config() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_config"]], "get_data_dir() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_data_dir"]], "get_missing_simulations() (sem.campaignmanager method)": [[0, "sem.CampaignManager.get_missing_simulations"]], "get_next_rngruns() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_next_rngruns"]], "get_next_values() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_next_values"]], "get_params() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_params"]], "get_result_files() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_result_files"]], "get_results() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_results"]], "get_results_as_dataframe() (sem.campaignmanager method)": [[0, "sem.CampaignManager.get_results_as_dataframe"]], "get_results_as_numpy_array() (sem.campaignmanager method)": [[0, "sem.CampaignManager.get_results_as_numpy_array"]], "get_results_as_xarray() (sem.campaignmanager method)": [[0, "sem.CampaignManager.get_results_as_xarray"]], "get_script() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_script"]], "get_space() (sem.campaignmanager method)": [[0, "sem.CampaignManager.get_space"]], "have_same_structure() (sem.databasemanager method)": [[0, "sem.DatabaseManager.have_same_structure"]], "init_callback() (sem.utils.callbackbase method)": [[0, "sem.utils.CallbackBase.init_callback"]], "insert_result() (sem.databasemanager method)": [[0, "sem.DatabaseManager.insert_result"]], "is_controlled_by_parent() (sem.utils.callbackbase method)": [[0, "sem.utils.CallbackBase.is_controlled_by_parent"]], "list_param_combinations() (in module sem.utils)": [[0, "sem.utils.list_param_combinations"]], "load() (sem.campaignmanager class method)": [[0, "sem.CampaignManager.load"]], "load() (sem.databasemanager class method)": [[0, "sem.DatabaseManager.load"]], "module": [[0, "module-sem.utils"]], "new() (sem.campaignmanager class method)": [[0, "sem.CampaignManager.new"]], "new() (sem.databasemanager class method)": [[0, "sem.DatabaseManager.new"]], "on_run_end() (sem.utils.callbackbase method)": [[0, "sem.utils.CallbackBase.on_run_end"]], "on_run_start() (sem.utils.callbackbase method)": [[0, "sem.utils.CallbackBase.on_run_start"]], "run_missing_simulations() (sem.campaignmanager method)": [[0, "sem.CampaignManager.run_missing_simulations"]], "run_simulations() (sem.campaignmanager method)": [[0, "sem.CampaignManager.run_simulations"]], "run_simulations() (sem.simulationrunner method)": [[0, "sem.SimulationRunner.run_simulations"]], "salib_param_values_to_params() (in module sem.utils)": [[0, "sem.utils.salib_param_values_to_params"]], "save_to_folders() (sem.campaignmanager method)": [[0, "sem.CampaignManager.save_to_folders"]], "save_to_mat_file() (sem.campaignmanager method)": [[0, "sem.CampaignManager.save_to_mat_file"]], "save_to_npy_file() (sem.campaignmanager method)": [[0, "sem.CampaignManager.save_to_npy_file"]], "sem.utils": [[0, "module-sem.utils"]], "space_to_folders() (sem.campaignmanager method)": [[0, "sem.CampaignManager.space_to_folders"]], "stdout_automatic_parser() (in module sem.utils)": [[0, "sem.utils.stdout_automatic_parser"]], "wipe_results() (sem.databasemanager method)": [[0, "sem.DatabaseManager.wipe_results"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["api", "cli", "contributing", "detailed-functionality", "examples", "getting-started", "index", "installation"], "filenames": ["api.rst", "cli.rst", "contributing.rst", "detailed-functionality.rst", "examples.rst", "getting-started.rst", "index.rst", "installation.rst"], "titles": ["API Reference", "Command Line Interface", "Contribution guidelines", "Detailed Functionality", "Examples walkthrough", "Getting started", "The ns-3 Simulation Execution Manager", "Installation"], "terms": {"class": [0, 2, 5, 6], "sem": [0, 1, 3, 4, 5, 6, 7], "campaign_db": 0, "campaign_runn": 0, "check_repo": 0, "true": [0, 1, 5, 6], "sourc": 0, "thi": [0, 1, 2, 3, 4, 5, 7], "simul": [0, 2, 4], "execut": [0, 1, 2, 3, 5], "manag": [0, 1, 2], "can": [0, 1, 2, 3, 4, 5, 6, 7], "us": [0, 1, 2, 3, 4, 5, 7], "an": [0, 1, 2, 3, 4, 5, 7], "interfac": [0, 2, 3, 5, 6], "access": [0, 3, 5, 6], "result": [0, 2, 4, 6], "campaign": [0, 1, 4, 6], "The": [0, 1, 2, 4, 5, 7], "wrap": 0, "up": [0, 2, 5], "which": [0, 1, 3, 4, 5], "ar": [0, 1, 2, 3, 4, 5, 7], "intern": [0, 5], "also": [0, 1, 2, 3, 5, 7], "public": 0, "member": [0, 3], "variabl": [0, 1, 3, 4], "check_repo_ok": 0, "make": [0, 1, 2, 5], "sure": [0, 1, 2], "n": [0, 1, 2, 3, 5], "3": [0, 1, 2, 3, 5], "repositori": [0, 2, 5, 7], "": [0, 1, 2, 3, 4, 5], "head": [0, 1, 5], "commit": [0, 3], "i": [0, 1, 2, 3, 4, 5, 7], "same": [0, 1, 3, 5, 7], "one": [0, 1, 2, 3, 4, 5, 7], "save": [0, 1, 3, 4, 5, 6], "databas": [0, 1, 5], "clean": [0, 5], "e": [0, 1, 2, 3, 5], "untrack": 0, "modifi": 0, "file": [0, 1, 2, 3, 4, 5, 6], "exist": [0, 1, 3, 5], "create_runn": 0, "script": [0, 1, 3, 4, 5], "runner_typ": 0, "auto": 0, "optim": [0, 1], "skip_configur": 0, "fals": [0, 1, 5, 6], "max_parallel_process": 0, "none": 0, "creat": [0, 1, 2, 3, 6], "from": [0, 1, 2, 3, 5, 6, 7], "string": [0, 1, 4, 5], "contain": [0, 1, 2, 3, 4, 5], "desir": [0, 3, 6], "implement": [0, 3], "return": [0, 3, 4, 5], "paramet": [0, 1, 3, 4, 5, 6], "ns_path": [0, 5], "str": 0, "path": [0, 1, 3, 5, 7], "instal": [0, 1, 3, 5, 6], "emploi": [0, 5], "run": [0, 2, 4, 6], "valu": [0, 1, 3, 4, 5], "sequenti": 0, "local": 0, "parallelrunn": [0, 3], "parallel": [0, 2, 3, 6], "gridrunn": [0, 3], "drmaa": [0, 3, 6], "compat": [0, 6], "task": [0, 3], "schedul": 0, "If": [0, 1, 2, 5], "automat": [0, 1, 2, 5, 6], "pick": 0, "best": [0, 5], "avail": [0, 1, 3, 4, 5, 6, 7], "runner": 0, "otherwis": [0, 5], "bool": 0, "whether": [0, 1, 5], "configur": 0, "build": [0, 1], "skip": [0, 1], "step": [0, 1, 2], "onli": [0, 1, 3, 4, 5], "perform": [0, 1, 2, 3, 5, 6], "compil": [0, 2], "files_in_dictionari": 0, "pars": [0, 1, 3, 4, 5, 6], "function": [0, 2, 4, 5, 6], "dictionari": [0, 1, 3, 4, 5], "entri": [0, 3], "each": [0, 1, 2, 3, 4, 5], "typic": [0, 2, 3], "extern": 0, "get_missing_simul": 0, "param_list": 0, "with_time_estim": 0, "list": [0, 1, 3, 5], "among": [0, 3], "requir": [0, 1, 2, 3, 5, 6, 7], "ones": [0, 3, 5], "all": [0, 1, 2, 3, 5], "combin": [0, 1, 3, 5, 6], "int": 0, "integ": 0, "repres": [0, 1, 3], "how": [0, 3, 4, 5], "mani": [0, 5], "repetit": [0, 1, 5], "want": [0, 1, 2], "alreadi": [0, 1, 3, 5], "featur": [0, 3], "rngrun": [0, 1, 3, 5], "boolean": 0, "get_results_as_datafram": 0, "result_parsing_funct": 0, "column": 0, "param": [0, 1, 3, 4, 5], "param_column": 0, "drop_constant_column": 0, "parallel_pars": 0, "verbos": 0, "panda": [0, 6], "datafram": [0, 6], "user": [0, 1, 3, 4, 7], "specifi": [0, 1, 3, 4, 5], "function_yields_multiple_result": 0, "expect": [0, 1], "output": [0, 1, 2, 3, 4, 5, 6], "should": [0, 2, 5], "equal": [0, 2], "number": [0, 1, 2, 5], "label": [0, 5], "describ": [0, 1, 2, 3], "content": [0, 1, 3, 4], "instead": [0, 1, 3, 5], "multipl": [0, 1, 4, 5, 6], "In": [0, 1, 2, 3, 4, 5, 7], "case": [0, 1, 2, 4, 7], "yield": 0, "row": 0, "length": 0, "comput": [0, 2, 6], "defin": [0, 1, 3, 4, 5], "take": [0, 1, 3, 4, 5], "input": [0, 3], "get_results_as_numpy_arrai": [0, 3], "parameter_spac": 0, "extract_complete_result": 0, "rel": 0, "space": [0, 1, 3, 4, 5], "form": [0, 3, 4], "numpi": [0, 1, 3, 5, 6], "arrai": [0, 1, 5], "dict": 0, "pair": [0, 3, 5], "argument": [0, 3], "gather": [0, 3], "get_results_as_xarrai": [0, 3, 4, 5], "output_label": 0, "xarrai": [0, 3, 4, 5, 6], "data": [0, 1, 2, 3, 4], "structur": [0, 1, 2, 3, 4, 5], "export": [0, 2, 4, 6], "appli": [0, 4], "dimens": 0, "get_spac": 0, "current_result_list": 0, "current_queri": 0, "param_spac": 0, "convert": 0, "specif": [0, 5], "nest": 0, "other": [0, 1, 2], "word": 0, "1": [0, 1, 4, 5, 6], "2": [0, 1, 3, 5], "b": 0, "4": [0, 1, 5], "like": [0, 2, 3, 5], "follow": [0, 1, 2, 3, 4, 5, 7], "where": [0, 1, 5], "first": [0, 1, 2, 3, 5], "second": [0, 5], "easili": [0, 5, 7], "via": [0, 2, 3, 6], "np": [0, 5], "queri": [0, 1, 2, 3], "represent": 0, "call": [0, 1, 2, 3, 4], "metric": [0, 4], "classmethod": 0, "load": [0, 1, 3, 6], "campaign_dir": [0, 3, 5], "note": [0, 1, 2, 3, 5], "compulsori": 0, "when": [0, 1, 2, 3, 6], "method": [0, 2, 3, 4], "order": [0, 1, 2, 3, 5], "addit": [0, 3, 5], "necessari": [0, 1, 3], "object": [0, 2, 4, 5], "assign": 0, "directori": [0, 1, 5, 6], "new": [0, 1, 2, 3, 5, 6], "overwrit": [0, 5], "its": [0, 1, 2, 3, 5, 7], "match": [0, 4], "config": 0, "instanc": [0, 1, 3, 5], "set": [0, 1, 5], "wipe": 0, "place": 0, "furthermor": 0, "initi": [0, 5], "type": [0, 1], "lock": 0, "final": [0, 1, 2, 3, 5], "creation": [0, 2, 3, 5], "git": [0, 2, 5, 6, 7], "allow": [0, 2], "enforc": [0, 6], "reproduc": [0, 6], "avoid": [0, 1], "mix": 0, "come": 0, "differ": [0, 2, 4, 5], "version": [0, 1, 7], "librari": [0, 2, 3, 4, 5, 7], "folder": [0, 2, 3, 4, 5, 7], "delet": 0, "were": [0, 1, 3, 5], "detect": [0, 1], "manual": 0, "out": [0, 1, 3, 5], "run_missing_simul": [0, 3, 4, 5, 6], "condition_checking_funct": 0, "callback": 0, "stop_on_error": 0, "yet": 0, "we": [0, 1, 3, 4, 5], "have": [0, 1, 5], "least": 0, "replic": [0, 1], "addition": [0, 1, 5], "either": [0, 1, 3], "expand": 0, "through": [0, 1, 2, 3, 4, 5], "list_param_combin": [0, 5], "doesn": [0, 3], "t": [0, 3], "kei": [0, 3, 5], "extend": 0, "callbackbas": 0, "trigger": 0, "dure": 0, "stop": [0, 2], "error": [0, 2, 4], "occur": 0, "run_simul": [0, 3, 5], "show_progress": 0, "sever": 0, "doe": [0, 1], "verifi": 0, "just": 0, "item": 0, "show": [0, 1, 2, 4], "progress": [0, 5], "bar": [0, 5], "percentag": [0, 2], "remain": [0, 5], "time": [0, 3, 4, 5], "save_to_fold": [0, 3], "folder_nam": 0, "save_to_mat_fil": [0, 3], "filenam": [0, 1, 3, 4], "mat": [0, 1, 5, 6], "name": [0, 3, 5], "save_to_npy_fil": [0, 3], "format": [0, 1, 2, 3, 5, 6], "space_to_fold": 0, "current_directori": 0, "tree": [0, 5, 6], "system": [0, 3, 7], "configure_and_build": 0, "code": [0, 2, 3, 4, 6], "displai": [0, 5], "standard": [0, 2, 5], "get_available_paramet": 0, "made": 0, "get_build_output": 0, "process": [0, 1, 2, 3, 5, 6], "build_program": 0, "extract": [0, 1, 5], "inform": [0, 1, 2, 3, 5], "need": [0, 1, 3, 4, 5], "draw": 0, "subprocess": 0, "listen": 0, "parameter_list": 0, "data_fold": 0, "certain": 0, "complet": 0, "subfold": 0, "whole": [0, 2], "db": [0, 3, 5, 6], "serv": [0, 1, 3], "A": [0, 1, 5], "scratch": [0, 3, 5], "delete_result": 0, "remov": [0, 7], "base": [0, 3, 6], "id": [0, 1, 3, 4, 5], "get_all_values_of_all_param": 0, "taken": [0, 1], "alwai": 0, "alphabet": 0, "get_commit": 0, "oper": [0, 5], "get_complete_result": [0, 3, 6], "result_id": [0, 1], "files_to_load": 0, "analog": 0, "what": [0, 1, 3, 4], "get_result": [0, 5], "read": [0, 1], "correspond": [0, 1, 3, 5], "incorpor": 0, "them": [0, 1, 3, 5], "under": [0, 1, 3, 5], "file_cont": 0, "document": [0, 1, 2, 3, 4], "param1": [0, 3, 4], "value1": [0, 1, 3], "param2": [0, 3], "value2": [0, 1, 3], "value3": [0, 1, 3], "meta": [0, 1, 3, 4], "elapsed_tim": [0, 1, 3, 4, 5], "value4": 0, "value5": 0, "stdout": [0, 1, 4, 5, 6], "stdout_as_str": 0, "stderr": [0, 1, 4, 6], "stderr_as_str": 0, "file1": 0, "file1_as_str": 0, "includ": 0, "even": 0, "thei": [0, 1, 4], "empti": 0, "get_config": 0, "command": [0, 2, 3, 5, 6, 7], "line": [0, 2, 3, 5, 6], "get_data_dir": 0, "simpli": [0, 1, 3], "campaign_directori": 0, "get_next_rngrun": 0, "next": 0, "get_next_valu": 0, "values_list": 0, "given": 0, "lowest": 0, "do": [0, 1, 3, 5], "appear": 0, "import": [0, 5, 6], "v": 0, "0": [0, 1, 3, 4, 5], "5": [0, 1, 5, 6], "6": [0, 1, 5], "get_param": 0, "toggl": 0, "get_result_fil": 0, "filepath": 0, "associ": [0, 5], "g": [0, 1], "obtain": [0, 1, 4, 5], "fulfil": 0, "some": [0, 3, 4, 5], "must": [0, 2, 3], "interest": [0, 1, 2, 5], "For": [0, 1, 5], "exampl": [0, 1, 2, 3, 5, 6], "Not": 0, "unspecifi": 0, "assum": [0, 5], "free": 0, "ani": [0, 2, 5, 7], "insert": [0, 2, 3], "insert_result": [0, 3], "get_script": 0, "have_same_structur": 0, "d2": 0, "two": [0, 1, 3, 6], "possibli": [0, 5], "check": [0, 3, 5], "d1": 0, "d3": 0, "c": 0, "d4": 0, "d5": 0, "d6": 0, "d": 0, "7": [0, 1, 5, 6], "elaps": 0, "float": [0, 4, 5], "took": 0, "uuid": 0, "uniqu": [0, 3, 5], "identifi": [0, 5], "locat": [0, 5], "It": 0, "json": [0, 1, 3], "ha": 0, "overwritten": 0, "wipe_result": 0, "cannot": 0, "undon": 0, "level": [0, 3], "info": [0, 1, 5], "messag": [0, 1, 3], "debug": [0, 1], "init_callback": 0, "controlled_by_par": 0, "is_controlled_by_par": 0, "awar": 0, "been": 0, "multithread": 0, "thu": 0, "subset": 0, "on_run_end": 0, "sim_uuid": 0, "return_cod": 0, "sim_tim": 0, "finish": [0, 1, 2, 3, 5], "todo": 0, "mayb": [0, 1], "lot": 0, "sens": 0, "sinc": [0, 1, 2, 5], "eventu": 0, "overridden": 0, "fail": 0, "on_run_start": 0, "referenc": 0, "automatic_pars": 0, "dtype": 0, "try": [0, 1, 5], "tabl": [0, 1, 3], "hood": [0, 3, 5], "essenti": [0, 4], "genfromtxt": 0, "pass": [0, 3, 4], "kwarg": 0, "see": [0, 1, 3], "more": [0, 3, 5], "detail": [0, 1, 2, 5, 6, 7], "compute_sensitivity_analysi": 0, "rang": [0, 1, 5], "salib_sample_funct": 0, "sampl": 0, "salib_analyze_funct": 0, "analyz": 0, "100": [0, 1, 3, 5, 6], "sensit": 0, "analysi": [0, 5], "salib": 0, "constant_array_pars": 0, "dummi": 0, "parser": 0, "test": [0, 6], "purpos": [0, 1], "get_bound": 0, "bound": 0, "start": [0, 2, 6, 7], "min": 0, "max": 0, "possibl": [0, 1, 5], "get_command_from_result": 0, "templat": [0, 1], "param_rang": 0, "robust": 0, "salib_param_values_to_param": 0, "stdout_automatic_pars": 0, "matrix": 0, "offer": [1, 4], "tool": 1, "quickli": [1, 4], "scroll": 1, "everyth": 1, "look": 1, "ok": 1, "matlab": [1, 6], "npy": [1, 5, 6], "further": 1, "elabor": [1, 3, 5], "page": [1, 2, 4, 5], "workflow": [1, 5], "write": 1, "python": [1, 2, 3, 4, 5, 6, 7], "reli": 1, "To": [1, 2, 3, 7], "usag": 1, "program": 1, "flag": [1, 2], "option": [1, 7], "arg": 1, "exit": 1, "print": [1, 2, 3, 4, 5], "section": [1, 3, 5], "sub": [1, 2], "visual": [1, 4, 5], "about": [1, 3], "dir": 1, "text": 1, "choic": 1, "prompt": 1, "wifi": [1, 5, 6], "multi": [1, 3, 5, 6], "tos": [1, 5, 6], "channelwidth": [1, 5, 6], "distanc": [1, 5, 6], "mc": [1, 5, 6], "nwifi": [1, 5, 6], "simulationtim": [1, 3, 5, 6], "usert": [1, 5, 6], "useshortguardinterv": [1, 5, 6], "c19d291f35f2a394d03c3fc7c74377b65666e1a4": 1, "after": [1, 2, 3, 4, 5], "ask": 1, "These": 1, "singl": [1, 2, 4, 5], "enclos": 1, "quotat": 1, "mark": [1, 2], "20": [1, 5, 6], "10": [1, 5, 6], "80": 1, "02": [1, 5], "43": 1, "00": [1, 5, 6], "05": 1, "inde": 1, "correct": 1, "respect": 1, "explor": [1, 3, 5], "u": [1, 7], "16": 1, "mean": [1, 3, 5], "At": [1, 5], "point": [1, 5], "sai": 1, "realiz": 1, "effect": [1, 2], "happen": 1, "suffic": 1, "again": 1, "befor": [1, 2, 5], "previous": [1, 5], "ran": 1, "account": 1, "lead": 1, "anoth": 1, "batch": 1, "160": 1, "would": [1, 2], "cover": 1, "entir": 1, "propos": 1, "default": 1, "accept": [1, 3], "press": 1, "enter": 1, "04": 1, "55": 1, "69": 1, "nice": 1, "our": 1, "let": [1, 5], "work": [1, 2, 3, 5], "so": [1, 3, 5], "hide": 1, "hidden": 1, "veri": [1, 3], "long": 1, "enabl": 1, "fairli": 1, "small": 1, "directli": [1, 5, 7], "632506847381592": 1, "fb1bd9be": 1, "b034": 1, "4f36": 1, "9562": 1, "07aa7988a266": 1, "aggreg": [1, 5], "throughput": [1, 4, 5], "18": 1, "9311": 1, "mbit": [1, 5], "ve": 1, "consist": [1, 3, 5], "shown": [1, 3], "here": [1, 2, 3, 4, 7], "printout": 1, "inspect": [1, 4, 5], "wa": [1, 5], "achiev": [1, 4, 6], "previou": [1, 2], "abl": 1, "waf": 1, "gdb": 1, "debugg": 1, "copi": [1, 3], "past": 1, "root": [1, 2], "david": [1, 2], "leav": 1, "store": 1, "compile_command": 1, "successfulli": [1, 2], "352": 1, "confirm": 1, "gener": [1, 2, 3, 5, 6], "One": 1, "now": 1, "extens": [1, 2], "deduc": 1, "tri": 1, "support": [1, 2, 5, 6], "recogn": 1, "howev": [1, 7], "seen": 1, "switch": 1, "off": [1, 5], "keep": 1, "relev": [1, 4, 5], "dimension": 1, "cell": 1, "struct": 1, "link": [1, 3], "non": 1, "variou": [2, 3, 6], "resourc": 2, "those": [2, 3], "who": 2, "get": [2, 6, 7], "develop": [2, 7], "fix": 2, "bug": 2, "updat": [2, 7], "clone": [2, 7], "github": [2, 5, 7], "http": [2, 7], "com": [2, 7], "signetlabdei": [2, 7], "modul": [2, 3], "pipenv": 2, "virtual": 2, "environ": 2, "depend": [2, 7], "enough": [2, 7], "pip": [2, 6], "project": [2, 5, 7], "packag": [2, 7], "dev": [2, 7], "shell": [2, 6], "repl": 2, "interact": [2, 3], "edit": 2, "mode": 2, "pipfil": 2, "chang": 2, "subdirectori": 2, "immedi": 2, "without": [2, 3], "pytest": 2, "By": 2, "procedur": 2, "abov": [2, 3, 5], "you": [2, 3, 5, 7], "download": [2, 7], "xdist": 2, "cov": 2, "coverag": 2, "prefix": 2, "test_": 2, "compon": [2, 3], "test_cli": 2, "py": [2, 5, 6], "click": 2, "facil": [2, 4], "test_databas": 2, "databasemanag": [2, 3, 5, 6], "test_exampl": 2, "test_manag": 2, "campaignmanag": [2, 4, 5, 6], "test_runn": 2, "simulationrunn": [2, 3, 6], "test_util": 2, "util": [2, 6], "provid": [2, 3, 4, 5], "conftest": 2, "hand": 2, "fixtur": 2, "common": 2, "temporari": 2, "share": 2, "between": 2, "x": [2, 5], "home": 2, "test_cli_workflow": 2, "ensur": 2, "failur": 2, "while": [2, 3], "disabl": 2, "captur": 2, "add": 2, "consid": 2, "most": [2, 3, 7], "involv": [2, 3], "o": 2, "speed": 2, "consider": [2, 3], "ad": [2, 3, 5], "report": 2, "html": 2, "docstr": 2, "doctest": 2, "glob": 2, "rst": 2, "doc": [2, 5], "suit": 2, "submit": 2, "pull": 2, "request": [2, 5], "both": [2, 3, 5], "lower": 2, "than": 2, "readi": 2, "submiss": 2, "leverag": [3, 4, 6], "practic": 3, "refer": [3, 5], "primer": 3, "screen": 3, "mai": 3, "influenc": 3, "term": 3, "short": 3, "wai": 3, "collect": [3, 5], "higher": 3, "major": 3, "action": 3, "administr": 3, "precis": [3, 7], "wherea": 3, "still": 3, "view": [3, 6], "Of": 3, "cours": 3, "tinydb": 3, "hash": 3, "12293100357055664": 3, "241ec0ef": 3, "34b3": 3, "466f": 3, "9eb1": 3, "08b736b8afd5": 3, "appperiod": 3, "600": 3, "ndevic": 3, "radiu": 3, "5500": 3, "insid": 3, "separ": 3, "reason": 3, "over": [3, 4, 5], "expens": 3, "could": 3, "inflat": 3, "size": 3, "needlessli": 3, "definit": 3, "simpl": 3, "notabl": 3, "overload": 3, "core": 3, "similarli": 3, "cluster": [3, 6], "As": [3, 5], "state": [3, 5], "realli": 3, "know": 3, "twice": 3, "actual": [3, 5], "miss": 3, "current": [3, 5, 7], "soon": 3, "field": [3, 4, 5], "five": 3, "main": 3, "last": 3, "three": 3, "walk": 4, "explain": 4, "full": 4, "portion": 4, "showcas": 4, "integr": 4, "plot": [4, 5, 6], "everi": 4, "def": [4, 5], "get_average_throughput": [4, 5], "m": 4, "re": [4, 6, 7], "9": [4, 5], "dotal": 4, "group": 4, "reduc": [4, 5], "tupl": 4, "avgthroughput": [4, 5], "goe": 4, "spent": 4, "guid": 5, "illustr": 5, "api": 5, "comprehens": 5, "overview": 5, "thing": 5, "vari": 5, "portabl": 5, "varieti": 5, "go": [5, 6], "vanilla": 5, "few": [5, 6], "wifi_exampl": [5, 6], "instruct": [5, 7], "interpret": 5, "tmp": [5, 6], "valid": 5, "statu": 5, "9386dc7d106fd9241ff151195a0e6e5cb954d363": 5, "retriev": 5, "sha": 5, "param_combin": 5, "81": 5, "later": 5, "indic": 5, "give": 5, "estim": 5, "translat": 5, "09": 5, "63": 5, "notic": 5, "fact": 5, "found": 5, "regardless": 5, "reproduct": 5, "henc": 5, "someth": 5, "turn": 5, "requesttosend": 5, "shortguardinterv": 5, "8": 5, "32": 5, "57": 5, "86": 5, "outsid": 5, "attribut": 5, "len": 5, "771e0511": 5, "43b9": 5, "4e33": 5, "aa6a": 5, "dc4266be24f1": 5, "270819187164307": 5, "49": 5, "2696": 5, "seed": 5, "random": 5, "transform": 5, "averag": 5, "measur": 5, "put": 5, "split": 5, "dataarrai": [5, 6], "8351": 5, "8057": 5, "8163": 5, "11": 5, "849": 5, "8549": 5, "7901": 5, "35": 5, "2868": 5, "3763": 5, "3044": 5, "36": 5, "4903": 5, "4137": 5, "4432": 5, "coordin": 5, "u5": 5, "int64": 5, "appropri": 5, "slice": 5, "matplotlib": 5, "agg": 5, "pyplot": 5, "plt": 5, "iter": 5, "avg": 5, "sel": 5, "std": 5, "eb": 5, "errorbar": 5, "y": 5, "yerr": 5, "sgi": 5, "rt": 5, "xlb": 5, "xlabel": 5, "ylb": 5, "ylabel": 5, "legend": 5, "loc": 5, "savefig": 5, "png": 5, "effici": 6, "altern": 6, "finer": 6, "control": 6, "24": 6, "42": 6, "77": 6, "ndarrai": 6, "codebas": 6, "track": 6, "help": 6, "paradigm": 6, "diagram": 6, "walkthrough": 6, "contribut": 6, "guidelin": 6, "contributor": 6, "framework": 6, "pip3": 7, "latest": 7, "branch": 7, "archiv": 7, "zip": 7, "your": 7, "issu": 7, "uninstal": 7, "setup": 7, "nsnam": 7, "checkout": 7, "releas": 7, "33": 7}, "objects": {"sem": [[0, 0, 1, "", "CampaignManager"], [0, 0, 1, "", "DatabaseManager"], [0, 0, 1, "", "SimulationRunner"], [0, 2, 0, "-", "utils"]], "sem.CampaignManager": [[0, 1, 1, "", "check_repo_ok"], [0, 1, 1, "", "create_runner"], [0, 1, 1, "", "files_in_dictionary"], [0, 1, 1, "", "get_missing_simulations"], [0, 1, 1, "", "get_results_as_dataframe"], [0, 1, 1, "", "get_results_as_numpy_array"], [0, 1, 1, "", "get_results_as_xarray"], [0, 1, 1, "", "get_space"], [0, 1, 1, "", "load"], [0, 1, 1, "", "new"], [0, 1, 1, "", "run_missing_simulations"], [0, 1, 1, "", "run_simulations"], [0, 1, 1, "", "save_to_folders"], [0, 1, 1, "", "save_to_mat_file"], [0, 1, 1, "", "save_to_npy_file"], [0, 1, 1, "", "space_to_folders"]], "sem.DatabaseManager": [[0, 1, 1, "", "delete_result"], [0, 1, 1, "", "get_all_values_of_all_params"], [0, 1, 1, "", "get_commit"], [0, 1, 1, "", "get_complete_results"], [0, 1, 1, "", "get_config"], [0, 1, 1, "", "get_data_dir"], [0, 1, 1, "", "get_next_rngruns"], [0, 1, 1, "", "get_next_values"], [0, 1, 1, "", "get_params"], [0, 1, 1, "", "get_result_files"], [0, 1, 1, "", "get_results"], [0, 1, 1, "", "get_script"], [0, 1, 1, "", "have_same_structure"], [0, 1, 1, "", "insert_result"], [0, 1, 1, "", "load"], [0, 1, 1, "", "new"], [0, 1, 1, "", "wipe_results"]], "sem.SimulationRunner": [[0, 1, 1, "", "configure_and_build"], [0, 1, 1, "", "get_available_parameters"], [0, 1, 1, "", "get_build_output"], [0, 1, 1, "", "run_simulations"]], "sem.utils": [[0, 0, 1, "", "CallbackBase"], [0, 3, 1, "", "automatic_parser"], [0, 3, 1, "", "compute_sensitivity_analysis"], [0, 3, 1, "", "constant_array_parser"], [0, 3, 1, "", "get_bounds"], [0, 3, 1, "", "get_command_from_result"], [0, 3, 1, "", "list_param_combinations"], [0, 3, 1, "", "salib_param_values_to_params"], [0, 3, 1, "", "stdout_automatic_parser"]], "sem.utils.CallbackBase": [[0, 1, 1, "", "init_callback"], [0, 1, 1, "", "is_controlled_by_parent"], [0, 1, 1, "", "on_run_end"], [0, 1, 1, "", "on_run_start"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:module", "3": "py:function"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "module", "Python module"], "3": ["py", "function", "Python function"]}, "titleterms": {"api": [0, 6], "refer": [0, 6], "campaignmanag": [0, 3], "simulationrunn": 0, "databasemanag": 0, "util": 0, "command": 1, "line": 1, "interfac": 1, "get": [1, 3, 5], "help": 1, "run": [1, 3, 5], "simul": [1, 3, 5, 6], "view": 1, "result": [1, 3, 5], "re": 1, "export": [1, 3, 5], "contribut": 2, "guidelin": 2, "sem": 2, "instal": [2, 7], "contributor": 2, "test": 2, "framework": 2, "detail": 3, "function": 3, "The": [3, 6], "campaign": [3, 5], "paradigm": 3, "obtain": 3, "object": 3, "databas": 3, "manag": [3, 6], "briefli": 3, "runner": 3, "singl": 3, "class": 3, "diagram": 3, "exampl": 4, "walkthrough": 4, "wifi_exampl": 4, "py": 4, "start": 5, "creat": 5, "load": 5, "n": [6, 7], "3": [6, 7], "execut": 6, "featur": 6, "highlight": 6, "user": 6, "": 6, "guid": 6, "via": 7, "pip": 7}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 58}, "alltitles": {"API Reference": [[0, "api-reference"], [6, "api-reference"]], "CampaignManager": [[0, "campaignmanager"]], "SimulationRunner": [[0, "simulationrunner"]], "DatabaseManager": [[0, "databasemanager"]], "Utils": [[0, "module-sem.utils"]], "Command Line Interface": [[1, "command-line-interface"]], "Getting help": [[1, "getting-help"]], "Running simulations": [[1, "running-simulations"], [3, "running-simulations"], [5, "running-simulations"]], "Viewing results": [[1, "viewing-results"]], "Getting commands to re-run simulations": [[1, "getting-commands-to-re-run-simulations"]], "Exporting results": [[1, "exporting-results"], [3, "exporting-results"], [5, "exporting-results"]], "Contribution guidelines": [[2, "contribution-guidelines"]], "SEM installation for contributors": [[2, "sem-installation-for-contributors"]], "Testing framework": [[2, "testing-framework"]], "Detailed Functionality": [[3, "detailed-functionality"]], "The simulation campaign paradigm": [[3, "the-simulation-campaign-paradigm"]], "Obtaining a CampaignManager object": [[3, "obtaining-a-campaignmanager-object"]], "Database management, briefly": [[3, "database-management-briefly"]], "Simulation runners, briefly": [[3, "simulation-runners-briefly"]], "Results": [[3, "results"]], "Getting single results": [[3, "getting-single-results"]], "Class diagram": [[3, "class-diagram"]], "Examples walkthrough": [[4, "examples-walkthrough"]], "wifi_example.py": [[4, "wifi-example-py"]], "Getting started": [[5, "getting-started"]], "Creating and loading a simulation campaign": [[5, "creating-and-loading-a-simulation-campaign"]], "The ns-3 Simulation Execution Manager": [[6, "the-ns-3-simulation-execution-manager"]], "Feature highlights": [[6, "feature-highlights"]], "User\u2019s guide": [[6, "user-s-guide"]], "Installation": [[7, "installation"]], "Via pip": [[7, "via-pip"]], "Installing ns-3": [[7, "installing-ns-3"]]}, "indexentries": {"callbackbase (class in sem.utils)": [[0, "sem.utils.CallbackBase"]], "campaignmanager (class in sem)": [[0, "sem.CampaignManager"]], "databasemanager (class in sem)": [[0, "sem.DatabaseManager"]], "simulationrunner (class in sem)": [[0, "sem.SimulationRunner"]], "automatic_parser() (in module sem.utils)": [[0, "sem.utils.automatic_parser"]], "check_repo_ok() (sem.campaignmanager method)": [[0, "sem.CampaignManager.check_repo_ok"]], "compute_sensitivity_analysis() (in module sem.utils)": [[0, "sem.utils.compute_sensitivity_analysis"]], "configure_and_build() (sem.simulationrunner method)": [[0, "sem.SimulationRunner.configure_and_build"]], "constant_array_parser() (in module sem.utils)": [[0, "sem.utils.constant_array_parser"]], "create_runner() (sem.campaignmanager method)": [[0, "sem.CampaignManager.create_runner"]], "delete_result() (sem.databasemanager method)": [[0, "sem.DatabaseManager.delete_result"]], "files_in_dictionary() (sem.campaignmanager method)": [[0, "sem.CampaignManager.files_in_dictionary"]], "get_all_values_of_all_params() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_all_values_of_all_params"]], "get_available_parameters() (sem.simulationrunner method)": [[0, "sem.SimulationRunner.get_available_parameters"]], "get_bounds() (in module sem.utils)": [[0, "sem.utils.get_bounds"]], "get_build_output() (sem.simulationrunner method)": [[0, "sem.SimulationRunner.get_build_output"]], "get_command_from_result() (in module sem.utils)": [[0, "sem.utils.get_command_from_result"]], "get_commit() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_commit"]], "get_complete_results() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_complete_results"]], "get_config() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_config"]], "get_data_dir() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_data_dir"]], "get_missing_simulations() (sem.campaignmanager method)": [[0, "sem.CampaignManager.get_missing_simulations"]], "get_next_rngruns() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_next_rngruns"]], "get_next_values() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_next_values"]], "get_params() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_params"]], "get_result_files() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_result_files"]], "get_results() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_results"]], "get_results_as_dataframe() (sem.campaignmanager method)": [[0, "sem.CampaignManager.get_results_as_dataframe"]], "get_results_as_numpy_array() (sem.campaignmanager method)": [[0, "sem.CampaignManager.get_results_as_numpy_array"]], "get_results_as_xarray() (sem.campaignmanager method)": [[0, "sem.CampaignManager.get_results_as_xarray"]], "get_script() (sem.databasemanager method)": [[0, "sem.DatabaseManager.get_script"]], "get_space() (sem.campaignmanager method)": [[0, "sem.CampaignManager.get_space"]], "have_same_structure() (sem.databasemanager method)": [[0, "sem.DatabaseManager.have_same_structure"]], "init_callback() (sem.utils.callbackbase method)": [[0, "sem.utils.CallbackBase.init_callback"]], "insert_result() (sem.databasemanager method)": [[0, "sem.DatabaseManager.insert_result"]], "is_controlled_by_parent() (sem.utils.callbackbase method)": [[0, "sem.utils.CallbackBase.is_controlled_by_parent"]], "list_param_combinations() (in module sem.utils)": [[0, "sem.utils.list_param_combinations"]], "load() (sem.campaignmanager class method)": [[0, "sem.CampaignManager.load"]], "load() (sem.databasemanager class method)": [[0, "sem.DatabaseManager.load"]], "module": [[0, "module-sem.utils"]], "new() (sem.campaignmanager class method)": [[0, "sem.CampaignManager.new"]], "new() (sem.databasemanager class method)": [[0, "sem.DatabaseManager.new"]], "on_run_end() (sem.utils.callbackbase method)": [[0, "sem.utils.CallbackBase.on_run_end"]], "on_run_start() (sem.utils.callbackbase method)": [[0, "sem.utils.CallbackBase.on_run_start"]], "run_missing_simulations() (sem.campaignmanager method)": [[0, "sem.CampaignManager.run_missing_simulations"]], "run_simulations() (sem.campaignmanager method)": [[0, "sem.CampaignManager.run_simulations"]], "run_simulations() (sem.simulationrunner method)": [[0, "sem.SimulationRunner.run_simulations"]], "salib_param_values_to_params() (in module sem.utils)": [[0, "sem.utils.salib_param_values_to_params"]], "save_to_folders() (sem.campaignmanager method)": [[0, "sem.CampaignManager.save_to_folders"]], "save_to_mat_file() (sem.campaignmanager method)": [[0, "sem.CampaignManager.save_to_mat_file"]], "save_to_npy_file() (sem.campaignmanager method)": [[0, "sem.CampaignManager.save_to_npy_file"]], "sem.utils": [[0, "module-sem.utils"]], "space_to_folders() (sem.campaignmanager method)": [[0, "sem.CampaignManager.space_to_folders"]], "stdout_automatic_parser() (in module sem.utils)": [[0, "sem.utils.stdout_automatic_parser"]], "wipe_results() (sem.databasemanager method)": [[0, "sem.DatabaseManager.wipe_results"]]}}) \ No newline at end of file