diff --git a/0.1.31/_modules/index.html b/0.1.31/_modules/index.html index c35c6cb..fd41492 100644 --- a/0.1.31/_modules/index.html +++ b/0.1.31/_modules/index.html @@ -102,7 +102,7 @@

All modules for which code is available

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/_modules/mdacli/cli.html b/0.1.31/_modules/mdacli/cli.html index b685f69..82fdad0 100644 --- a/0.1.31/_modules/mdacli/cli.html +++ b/0.1.31/_modules/mdacli/cli.html @@ -247,7 +247,7 @@

Source code for mdacli.cli

 
   

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/_modules/mdacli/colors.html b/0.1.31/_modules/mdacli/colors.html index 20985d8..d62cd2c 100644 --- a/0.1.31/_modules/mdacli/colors.html +++ b/0.1.31/_modules/mdacli/colors.html @@ -314,7 +314,7 @@

Source code for mdacli.colors

 
   

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/_modules/mdacli/libcli.html b/0.1.31/_modules/mdacli/libcli.html index d02d39b..3380f62 100644 --- a/0.1.31/_modules/mdacli/libcli.html +++ b/0.1.31/_modules/mdacli/libcli.html @@ -958,7 +958,7 @@

Source code for mdacli.libcli

 
   

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/_modules/mdacli/logger.html b/0.1.31/_modules/mdacli/logger.html index 68af96d..2759bc5 100644 --- a/0.1.31/_modules/mdacli/logger.html +++ b/0.1.31/_modules/mdacli/logger.html @@ -165,7 +165,7 @@

Source code for mdacli.logger

 
   

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/_modules/mdacli/save.html b/0.1.31/_modules/mdacli/save.html index 90b2f64..94f00ff 100644 --- a/0.1.31/_modules/mdacli/save.html +++ b/0.1.31/_modules/mdacli/save.html @@ -553,7 +553,7 @@

Source code for mdacli.save

 
   

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/_modules/mdacli/utils.html b/0.1.31/_modules/mdacli/utils.html index 2637fcc..8888189 100644 --- a/0.1.31/_modules/mdacli/utils.html +++ b/0.1.31/_modules/mdacli/utils.html @@ -369,7 +369,7 @@

Source code for mdacli.utils

 
   

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/api.html b/0.1.31/api.html index 3c8d315..a2bd874 100644 --- a/0.1.31/api.html +++ b/0.1.31/api.html @@ -127,7 +127,7 @@

API library documentation

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/api/cli.html b/0.1.31/api/cli.html index 795c5d3..0785451 100644 --- a/0.1.31/api/cli.html +++ b/0.1.31/api/cli.html @@ -106,7 +106,7 @@

The toplevel command line interface.

-mdacli.cli.cli(name, module_list, base_class=<Mock name='mock.AnalysisBase' id='140462186230400'>, version='', description='', skip_modules=None, ignore_warnings=False)[source]
+mdacli.cli.cli(name, module_list, base_class=<Mock name='mock.AnalysisBase' id='140423703360128'>, version='', description='', skip_modules=None, ignore_warnings=False)[source]

Create the command-line interface.

This function creates a command line interface with a given name based on a module list.

@@ -160,7 +160,7 @@

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/api/colors.html b/0.1.31/api/colors.html index e13fc72..b099c97 100644 --- a/0.1.31/api/colors.html +++ b/0.1.31/api/colors.html @@ -330,7 +330,7 @@

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/api/libcli.html b/0.1.31/api/libcli.html index eed94c4..dfc82dc 100644 --- a/0.1.31/api/libcli.html +++ b/0.1.31/api/libcli.html @@ -427,7 +427,7 @@

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/api/logger.html b/0.1.31/api/logger.html index 12abcfb..cd634da 100644 --- a/0.1.31/api/logger.html +++ b/0.1.31/api/logger.html @@ -136,7 +136,7 @@

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/api/save.html b/0.1.31/api/save.html index 5bf2427..93e3dd7 100644 --- a/0.1.31/api/save.html +++ b/0.1.31/api/save.html @@ -344,7 +344,7 @@

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/api/utils.html b/0.1.31/api/utils.html index 8be2bed..d1dfc33 100644 --- a/0.1.31/api/utils.html +++ b/0.1.31/api/utils.html @@ -204,7 +204,7 @@

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/authors.html b/0.1.31/authors.html index ac3ca85..5e87b53 100644 --- a/0.1.31/authors.html +++ b/0.1.31/authors.html @@ -110,7 +110,7 @@

Authors

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/changelog.html b/0.1.31/changelog.html index 9e2edd1..c341651 100644 --- a/0.1.31/changelog.html +++ b/0.1.31/changelog.html @@ -352,7 +352,7 @@

v0.1.0 (2021-11-18)

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/contributing.html b/0.1.31/contributing.html index b2e3f14..bb7816d 100644 --- a/0.1.31/contributing.html +++ b/0.1.31/contributing.html @@ -251,7 +251,7 @@

Pull Request

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/genindex.html b/0.1.31/genindex.html index b59a5a5..ab5cb51 100644 --- a/0.1.31/genindex.html +++ b/0.1.31/genindex.html @@ -437,7 +437,7 @@

Y

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/index.html b/0.1.31/index.html index b3d061b..8942c4a 100644 --- a/0.1.31/index.html +++ b/0.1.31/index.html @@ -198,7 +198,7 @@

Available modules

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/installation.html b/0.1.31/installation.html index 082e297..e32251c 100644 --- a/0.1.31/installation.html +++ b/0.1.31/installation.html @@ -143,7 +143,7 @@

conda

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/philosophy.html b/0.1.31/philosophy.html index 9c0cb44..e9ac197 100644 --- a/0.1.31/philosophy.html +++ b/0.1.31/philosophy.html @@ -155,7 +155,7 @@

Philosophy and approach

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/py-modindex.html b/0.1.31/py-modindex.html index c7fbb6d..bf4eaca 100644 --- a/0.1.31/py-modindex.html +++ b/0.1.31/py-modindex.html @@ -146,7 +146,7 @@

Python Module Index

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/readme.html b/0.1.31/readme.html index d6e7446..8ee2d8b 100644 --- a/0.1.31/readme.html +++ b/0.1.31/readme.html @@ -193,7 +193,7 @@

Available modules

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/search.html b/0.1.31/search.html index b27879d..fb8e1f8 100644 --- a/0.1.31/search.html +++ b/0.1.31/search.html @@ -109,7 +109,7 @@

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/0.1.31/searchindex.js b/0.1.31/searchindex.js index 74753ae..716e176 100644 --- a/0.1.31/searchindex.js +++ b/0.1.31/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API library documentation": [[0, "api-library-documentation"]], "Add your fork as remote": [[9, "add-your-fork-as-remote"]], "Authors": [[7, "authors"]], "Available modules": [[10, "available-modules"], [13, "available-modules"]], "Changelog": [[8, "changelog"]], "Clone the main project to your computer": [[9, "clone-the-main-project-to-your-computer"]], "Coloring": [[2, "module-mdacli.colors"]], "Contributing": [[9, "contributing"]], "Create a new branch and start developing": [[9, "create-a-new-branch-and-start-developing"]], "Fork this repository": [[9, "fork-this-repository"]], "High-Level API": [[1, "module-mdacli.cli"]], "Install for developers": [[9, "install-for-developers"]], "Installation": [[11, "installation"]], "Logging": [[4, "module-mdacli.logger"]], "MDAnalysis command line interface": [[10, "mdanalysis-command-line-interface"], [13, "mdanalysis-command-line-interface"]], "Philosophy and approach": [[12, "philosophy-and-approach"]], "Pull Request": [[9, "pull-request"]], "Pull Request your changes": [[9, "pull-request-your-changes"]], "Results Saving": [[5, "module-mdacli.save"]], "Running tests with tox": [[9, "running-tests-with-tox"]], "Support functions for CLI": [[3, "module-mdacli.libcli"]], "Update CHANGELOG": [[9, "update-changelog"]], "Usage": [[14, "usage"]], "Utilities": [[6, "module-mdacli.utils"]], "conda": [[11, "conda"]], "pip": [[11, "pip"]], "v0.1.0 (2021-11-18)": [[8, "v0-1-0-2021-11-18"]], "v0.1.1 (2021-11-18)": [[8, "v0-1-1-2021-11-18"]], "v0.1.10 (2022-01-18)": [[8, "v0-1-10-2022-01-18"]], "v0.1.11 (2022-01-19)": [[8, "v0-1-11-2022-01-19"]], "v0.1.12 (2022-01-19)": [[8, "v0-1-12-2022-01-19"]], "v0.1.13 (2022-02-16)": [[8, "v0-1-13-2022-02-16"]], "v0.1.14 (2022-02-17)": [[8, "v0-1-14-2022-02-17"]], "v0.1.15 (2022-02-25)": [[8, "v0-1-15-2022-02-25"]], "v0.1.16 (2022-02-25)": [[8, "v0-1-16-2022-02-25"]], "v0.1.17 (2022-04-07)": [[8, "v0-1-17-2022-04-07"]], "v0.1.18 (2022-04-12)": [[8, "v0-1-18-2022-04-12"]], "v0.1.19 (2022-04-12)": [[8, "v0-1-19-2022-04-12"]], "v0.1.2 (2021-11-18)": [[8, "v0-1-2-2021-11-18"]], "v0.1.20 (2022-04-13)": [[8, "v0-1-20-2022-04-13"]], "v0.1.21 (2022-04-22)": [[8, "v0-1-21-2022-04-22"]], "v0.1.22 (2023-01-27)": [[8, "v0-1-22-2023-01-27"]], "v0.1.23 (2023-01-27)": [[8, "v0-1-23-2023-01-27"]], "v0.1.24 (2023-01-27)": [[8, "v0-1-24-2023-01-27"]], "v0.1.25 (2023-02-21)": [[8, "v0-1-25-2023-02-21"]], "v0.1.26 (2023-06-27)": [[8, "v0-1-26-2023-06-27"]], "v0.1.27 (2023-08-25)": [[8, "v0-1-27-2023-08-25"]], "v0.1.28 (2023-09-29)": [[8, "v0-1-28-2023-09-29"]], "v0.1.29 (2024-03-21)": [[8, "v0-1-29-2024-03-21"]], "v0.1.3 (2021-11-24)": [[8, "v0-1-3-2021-11-24"]], "v0.1.30 (2024-04-03)": [[8, "v0-1-30-2024-04-03"]], "v0.1.31 (2024-07-08)": [[8, "v0-1-31-2024-07-08"]], "v0.1.4 (2021-11-24)": [[8, "v0-1-4-2021-11-24"]], "v0.1.5 (2021-12-01)": [[8, "v0-1-5-2021-12-01"]], "v0.1.6 (2021-12-01)": [[8, "v0-1-6-2021-12-01"]], "v0.1.7 (2021-12-18)": [[8, "v0-1-7-2021-12-18"]], "v0.1.8 (2022-01-16)": [[8, "v0-1-8-2022-01-16"]], "v0.1.9 (2022-01-16)": [[8, "v0-1-9-2022-01-16"]]}, "docnames": ["api", "api/cli", "api/colors", "api/libcli", "api/logger", "api/save", "api/utils", "authors", "changelog", "contributing", "index", "installation", "philosophy", "readme", "usage"], "envversion": {"sphinx": 61, "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.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "api/cli.rst", "api/colors.rst", "api/libcli.rst", "api/logger.rst", "api/save.rst", "api/utils.rst", "authors.rst", "changelog.rst", "contributing.rst", "index.rst", "installation.rst", "philosophy.rst", "readme.rst", "usage.rst"], "indexentries": {"add_cli_universe() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_cli_universe", false]], "add_output_group() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_output_group", false]], "add_run_group() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_run_group", false]], "blue (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.blue", false]], "bold (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.bold", false]], "cli() (in module mdacli.cli)": [[1, "mdacli.cli.cli", false]], "convert_analysis_parameters() (in module mdacli.libcli)": [[3, "mdacli.libcli.convert_analysis_parameters", false]], "convert_str_time() (in module mdacli.utils)": [[6, "mdacli.utils.convert_str_time", false]], "create_cli() (in module mdacli.libcli)": [[3, "mdacli.libcli.create_cli", false]], "create_universe() (in module mdacli.libcli)": [[3, "mdacli.libcli.create_universe", false]], "debug() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.debug", false]], "emphasise (class in mdacli.colors)": [[2, "mdacli.colors.Emphasise", false]], "emphasise() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.emphasise", false]], "error() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.error", false]], "find_classes_in_modules() (in module mdacli.libcli)": [[3, "mdacli.libcli.find_classes_in_modules", false]], "find_cls_members() (in module mdacli.libcli)": [[3, "mdacli.libcli.find_cls_members", false]], "get_1d_arrays() (in module mdacli.save)": [[5, "mdacli.save.get_1D_arrays", false]], "get_cli_input() (in module mdacli.save)": [[5, "mdacli.save.get_cli_input", false]], "gray (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.gray", false]], "green (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.green", false]], "header() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.header", false]], "info() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.info", false]], "init_base_argparse() (in module mdacli.libcli)": [[3, "mdacli.libcli.init_base_argparse", false]], "is_1d_array() (in module mdacli.save)": [[5, "mdacli.save.is_1d_array", false]], "is_2d_array() (in module mdacli.save)": [[5, "mdacli.save.is_2d_array", false]], "is_3d_array() (in module mdacli.save)": [[5, "mdacli.save.is_3d_array", false]], "is_dimension_array() (in module mdacli.save)": [[5, "mdacli.save.is_dimension_array", false]], "is_higher_dimension_array() (in module mdacli.save)": [[5, "mdacli.save.is_higher_dimension_array", false]], "is_serializable() (in module mdacli.save)": [[5, "mdacli.save.is_serializable", false]], "kwargsdict (class in mdacli.libcli)": [[3, "mdacli.libcli.KwargsDict", false]], "mdacli.cli": [[1, "module-mdacli.cli", false]], "mdacli.colors": [[2, "module-mdacli.colors", false]], "mdacli.libcli": [[3, "module-mdacli.libcli", false]], "mdacli.logger": [[4, "module-mdacli.logger", false]], "mdacli.save": [[5, "module-mdacli.save", false]], "mdacli.utils": [[6, "module-mdacli.utils", false]], "module": [[1, "module-mdacli.cli", false], [2, "module-mdacli.colors", false], [3, "module-mdacli.libcli", false], [4, "module-mdacli.logger", false], [5, "module-mdacli.save", false], [6, "module-mdacli.utils", false]], "ok() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.ok", false]], "parse_callable_signature() (in module mdacli.utils)": [[6, "mdacli.utils.parse_callable_signature", false]], "parse_docs() (in module mdacli.utils)": [[6, "mdacli.utils.parse_docs", false]], "pink (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.pink", false]], "red (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.red", false]], "remove_files() (in module mdacli.save)": [[5, "mdacli.save.remove_files", false]], "return_with_remove() (in module mdacli.save)": [[5, "mdacli.save.return_with_remove", false]], "run_analysis() (in module mdacli.libcli)": [[3, "mdacli.libcli.run_analysis", false]], "save() (in module mdacli.save)": [[5, "mdacli.save.save", false]], "save_1d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_1D_arrays", false]], "save_2d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_2D_arrays", false]], "save_3d_array_to_2d_csv() (in module mdacli.save)": [[5, "mdacli.save.save_3D_array_to_2D_csv", false]], "save_3d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_3D_arrays", false]], "save_files_to_zip() (in module mdacli.save)": [[5, "mdacli.save.save_files_to_zip", false]], "save_higher_dim_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_higher_dim_arrays", false]], "save_json_serializables() (in module mdacli.save)": [[5, "mdacli.save.save_json_serializables", false]], "save_result_array() (in module mdacli.save)": [[5, "mdacli.save.save_result_array", false]], "save_results_object() (in module mdacli.save)": [[5, "mdacli.save.save_Results_object", false]], "save_to_json() (in module mdacli.save)": [[5, "mdacli.save.save_to_json", false]], "savetxt_w_command() (in module mdacli.save)": [[5, "mdacli.save.savetxt_w_command", false]], "setup_clients() (in module mdacli.libcli)": [[3, "mdacli.libcli.setup_clients", false]], "setup_logging() (in module mdacli.logger)": [[4, "mdacli.logger.setup_logging", false]], "split_argparse_into_groups() (in module mdacli.libcli)": [[3, "mdacli.libcli.split_argparse_into_groups", false]], "split_time_unit() (in module mdacli.utils)": [[6, "mdacli.utils.split_time_unit", false]], "stack_1d_arrays_list() (in module mdacli.save)": [[5, "mdacli.save.stack_1d_arrays_list", false]], "try_to_squeeze_me() (in module mdacli.save)": [[5, "mdacli.save.try_to_squeeze_me", false]], "turquoise (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.turquoise", false]], "underline (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.underline", false]], "warning() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.warning", false]], "yellow (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.yellow", false]]}, "objects": {"mdacli": [[1, 0, 0, "-", "cli"], [2, 0, 0, "-", "colors"], [3, 0, 0, "-", "libcli"], [4, 0, 0, "-", "logger"], [5, 0, 0, "-", "save"], [6, 0, 0, "-", "utils"]], "mdacli.cli": [[1, 1, 1, "", "cli"]], "mdacli.colors": [[2, 2, 1, "", "Emphasise"]], "mdacli.colors.Emphasise": [[2, 3, 1, "", "blue"], [2, 3, 1, "", "bold"], [2, 4, 1, "", "debug"], [2, 4, 1, "", "emphasise"], [2, 4, 1, "", "error"], [2, 3, 1, "", "gray"], [2, 3, 1, "", "green"], [2, 4, 1, "", "header"], [2, 4, 1, "", "info"], [2, 4, 1, "", "ok"], [2, 3, 1, "", "pink"], [2, 3, 1, "", "red"], [2, 3, 1, "", "turquoise"], [2, 3, 1, "", "underline"], [2, 4, 1, "", "warning"], [2, 3, 1, "", "yellow"]], "mdacli.libcli": [[3, 2, 1, "", "KwargsDict"], [3, 1, 1, "", "add_cli_universe"], [3, 1, 1, "", "add_output_group"], [3, 1, 1, "", "add_run_group"], [3, 1, 1, "", "convert_analysis_parameters"], [3, 1, 1, "", "create_cli"], [3, 1, 1, "", "create_universe"], [3, 1, 1, "", "find_classes_in_modules"], [3, 1, 1, "", "find_cls_members"], [3, 1, 1, "", "init_base_argparse"], [3, 1, 1, "", "run_analysis"], [3, 1, 1, "", "setup_clients"], [3, 1, 1, "", "split_argparse_into_groups"]], "mdacli.logger": [[4, 1, 1, "", "setup_logging"]], "mdacli.save": [[5, 1, 1, "", "get_1D_arrays"], [5, 1, 1, "", "get_cli_input"], [5, 1, 1, "", "is_1d_array"], [5, 1, 1, "", "is_2d_array"], [5, 1, 1, "", "is_3d_array"], [5, 1, 1, "", "is_dimension_array"], [5, 1, 1, "", "is_higher_dimension_array"], [5, 1, 1, "", "is_serializable"], [5, 1, 1, "", "remove_files"], [5, 1, 1, "", "return_with_remove"], [5, 1, 1, "", "save"], [5, 1, 1, "", "save_1D_arrays"], [5, 1, 1, "", "save_2D_arrays"], [5, 1, 1, "", "save_3D_array_to_2D_csv"], [5, 1, 1, "", "save_3D_arrays"], [5, 1, 1, "", "save_Results_object"], [5, 1, 1, "", "save_files_to_zip"], [5, 1, 1, "", "save_higher_dim_arrays"], [5, 1, 1, "", "save_json_serializables"], [5, 1, 1, "", "save_result_array"], [5, 1, 1, "", "save_to_json"], [5, 1, 1, "", "savetxt_w_command"], [5, 1, 1, "", "stack_1d_arrays_list"], [5, 1, 1, "", "try_to_squeeze_me"]], "mdacli.utils": [[6, 1, 1, "", "convert_str_time"], [6, 1, 1, "", "parse_callable_signature"], [6, 1, 1, "", "parse_docs"], [6, 1, 1, "", "split_time_unit"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "terms": {"": [3, 6, 9, 12, 14], "0": 3, "01": 9, "1": [2, 3, 5], "109": 8, "114": 8, "140462186230400": 1, "14deb97bef6df9bc6553": 2, "1900": 9, "1d": [5, 12], "1darrai": 5, "1m": 2, "2": [5, 6], "2d": [5, 12], "2darr": 5, "2nd": 14, "3": [3, 5], "30": 4, "31519997": 3, "3d": 5, "3darr": 5, "3rd": 14, "4": [5, 14], "4m": 2, "6": 3, "65": 8, "68": 8, "70": 8, "75": 8, "78": 8, "80": 8, "81": 8, "82": 8, "83": 8, "85": 8, "86": 8, "88": 8, "90": 3, "90m": 2, "91m": 2, "92m": 2, "93m": 2, "94m": 2, "95m": 2, "96m": 2, "A": [0, 3, 4, 5, 6, 10, 12, 13, 14], "For": [4, 9, 10, 13, 14], "If": [3, 4, 5, 6, 9, 11, 12], "It": 9, "Not": 9, "One": 6, "Or": 11, "That": 9, "The": [0, 1, 2, 3, 5, 6, 9, 12, 14], "These": 9, "To": [10, 11, 13, 14], "With": 12, "__all__": 1, "__authors__": 8, "__doc__": 1, "__init__": 6, "__version__": 1, "about": [5, 10, 13, 14], "absolut": 3, "accept": 9, "accor": 5, "accord": 3, "accordingli": 8, "account": 9, "achiev": 14, "across": [10, 13], "action": [8, 9], "activ": 11, "actual": [3, 12, 14], "ad": [3, 6, 8, 12], "add": [3, 5, 8], "add_argu": 8, "add_cli_univers": 3, "add_output_group": 3, "add_run_group": 3, "addit": [5, 9, 14], "adjust": 12, "advanc": 0, "after": [3, 9, 14], "align": [10, 13], "aligntraj": [10, 13], "all": [3, 5, 9, 12, 14], "allow": 8, "along": 5, "alreadi": [6, 9, 11], "also": [3, 9, 11, 12, 14], "altern": 3, "alwai": 9, "an": [3, 6, 9, 10, 12, 13, 14], "analysi": [1, 3, 5, 8, 10, 12, 13, 14], "analysis_cal": 3, "analysis_class_pars": 3, "analysis_paramet": 3, "analysisbas": [1, 3, 12], "analysisfromfunct": 1, "analyz": 12, "anaylsi": 1, "anaylysi": 3, "angl": [3, 10, 13], "ani": [3, 6, 9, 11, 12], "anlysi": 3, "ap": 3, "appear": 9, "appli": [5, 9, 12], "ar": [3, 4, 5, 6, 9, 10, 11, 12, 13, 14], "archiv": 5, "arg": 8, "arg_grouped_dict": 3, "argpars": [3, 10, 12, 13], "argument": [3, 8, 12], "argumentpars": 3, "argumentspars": 3, "around": 12, "arr": 5, "arr_nam": 5, "arrai": [5, 12, 14], "ask": 14, "assert": 5, "assum": 6, "atom": [3, 10, 13, 14], "atom_styl": 3, "atomgroup": [3, 8, 10, 13, 14], "attempt": 3, "attract": 12, "attribut": [2, 5], "author": 9, "automat": [11, 12], "avail": [2, 3, 14], "averag": [10, 13], "averagestructur": [10, 13], "avoid": 9, "b": 9, "banner": 8, "bare": 14, "base": [1, 3, 5, 6, 8, 9, 10, 12, 13], "base_class": 1, "basic": [3, 10, 13], "bcolor": 2, "becaus": [3, 9], "beckstein": 7, "befor": 9, "begin": 3, "bellow": 9, "belong": [1, 3], "between": [10, 13, 14], "blue": 2, "bold": 2, "bond": 3, "bool": [1, 3, 5], "boolean": 8, "both": 12, "box": 8, "build": [1, 9, 12], "bullet": 9, "bump2vers": 8, "bumpvers": 8, "bunch": 14, "c": [7, 9, 11], "calcul": [10, 13, 14], "callabl": 6, "callable_obj": 6, "can": [3, 6, 9, 11, 12, 14], "canon": 8, "case": 9, "categori": 3, "cd": 9, "cell": 3, "certain": [3, 5], "certifi": 9, "cfg": 8, "chain": 3, "challeng": 12, "chang": [3, 8, 14], "charg": 3, "charmm": 3, "check": [5, 8], "checkout": 9, "choic": [3, 8], "ci": [8, 9], "cl": [1, 3], "class": [1, 2, 3, 6, 8, 10, 12, 13, 14], "classifi": 8, "clever": 12, "cli": [0, 1, 6, 8, 10, 12, 13], "cli_pars": 3, "client": [3, 14], "clone": 11, "close": [10, 13], "closecontactgnmanalysi": [10, 13], "code": [1, 9, 12], "codebas": 12, "codecov": 8, "color": 0, "column": 14, "com": [2, 3, 6, 9, 11], "combin": [6, 12], "command": [0, 1, 3, 5, 9, 12, 14], "commit": 9, "commun": 9, "complet": 8, "complex": 14, "compon": [10, 13], "compress": 5, "comput": [10, 13], "conda": [8, 9], "conflict": 9, "const": 3, "contact": [1, 10, 11, 13], "contain": [1, 3, 5, 6, 12, 14], "continu": 9, "contribut": [8, 10, 13], "contributor": 9, "conveni": 6, "convert": [3, 6, 8], "convert_analysis_paramet": 3, "convert_str_tim": 6, "coordin": [3, 10, 13], "copi": 12, "core": [3, 12], "correct": [3, 8, 9], "correctli": 9, "correspond": [5, 14], "could": [2, 3, 6, 12], "crd": 3, "creat": [1, 3, 4, 5, 12], "create_cli": [3, 8], "create_univers": 3, "creation": [3, 6, 8], "csv": [5, 12, 14], "current": [10, 13, 14], "custom": 3, "customis": 3, "dai": 12, "danger": 2, "data": [3, 5, 12, 14], "dcd": 3, "ddict": 5, "debug": [2, 3, 4, 8, 14], "decor": 2, "decorated_messag": 2, "default": [3, 5, 14], "defin": [3, 5], "degre": 3, "densiti": [10, 13], "densityanalysi": [10, 13], "dep": [9, 11], "depend": [8, 11], "deploi": 8, "deploy": 8, "desc": 6, "describ": 9, "descript": [1, 3, 6, 8, 10, 13], "design": 3, "desir": 2, "dest": 3, "detail": [4, 6, 14], "detect": [8, 12], "develop": [0, 10, 11, 12, 13], "dict": [3, 5, 6], "dictionari": [3, 5, 6, 12], "did": 9, "dielectricconst": [10, 13], "dihedr": [1, 8, 10, 13], "dim": 5, "dimens": [3, 5, 8], "dimension": [5, 12, 14], "dimes": 3, "dipol": [10, 13], "direct": 12, "directli": [5, 11, 14], "directori": 14, "disabl": 8, "disk": 5, "displac": [10, 13], "displai": 4, "distanc": [10, 13], "distancematrix": [10, 13], "distribut": [10, 13, 14], "divid": 3, "do": [8, 9], "doc": [3, 8, 9], "docstr": [6, 8, 12], "document": [8, 9, 10, 13, 14], "doe": [0, 3, 6], "don": [9, 11], "done": 3, "doubl": 5, "doubt": 11, "downstream": 12, "dt": 6, "dump": [12, 14], "e": [3, 9, 12, 14], "each": [3, 5, 10, 12, 13, 14], "earli": [9, 10, 13], "easi": 9, "easier": 12, "effect": 3, "effort": 12, "eg": 3, "einstein": [10, 13], "einsteinmsd": [10, 13], "either": [3, 12], "element": 3, "els": [3, 5], "emphais": 2, "emphasis": 2, "empti": 3, "emul": 14, "encapsul": 9, "end": 3, "engag": 9, "environ": [4, 9, 11], "error": [2, 4], "especi": 9, "etc": [2, 14], "even": 14, "everi": 3, "everyth": [5, 11], "evolv": 12, "exactli": 9, "exampl": [1, 2, 4, 9, 14], "execut": [3, 5], "exist": [3, 12], "expect": 3, "experi": 12, "expert": 11, "explain": [9, 14], "explanatori": 9, "extend": 6, "extens": [3, 5], "extra_list": 5, "extract": 6, "f": [1, 12, 14], "face": 12, "fail": [8, 9], "fals": [1, 3], "feedback": 9, "fetch": 9, "ff": 9, "file": [3, 4, 5, 8, 9, 10, 12, 13, 14], "filenam": 4, "filesuffix": 5, "fill": 3, "final": 9, "find": 3, "find_classes_in_modul": 3, "find_cls_memb": 3, "finish": 9, "first": [9, 11], "fix": 8, "flag": [3, 9, 12, 14], "flexibl": 8, "float": [3, 6], "fly": 12, "fname": 5, "follow": [3, 6, 9, 10, 13], "fomat": 5, "forg": [9, 11], "form": 9, "format": [3, 6], "found": [3, 6], "fprefix": 5, "frame": [3, 6, 8, 10, 12, 13], "framework": 12, "friend": 9, "from": [0, 1, 2, 3, 4, 5, 6, 8, 9, 11, 12, 14], "fsuffix": 5, "function": [0, 1, 4, 5, 6, 9, 10, 13, 14], "funtion": 3, "g": 3, "g1": 14, "g2": 14, "gener": [3, 8, 12], "get": 5, "get_1d_arrai": 5, "get_cli_input": 5, "gist": 2, "git": 9, "github": [2, 7, 8, 9, 11], "give": 9, "given": [1, 3, 4, 6, 10, 13], "gnm": [10, 13], "gnmanalysi": [10, 13], "go": 9, "goal": 0, "goe": 9, "good": 9, "got": 5, "grai": 2, "great": 2, "green": 2, "gro": 3, "gromac": [3, 12, 14], "grorup": 3, "group": [3, 10, 13, 14], "guess": 3, "guid": 9, "guidelin": 9, "h": [10, 13, 14], "ha": [3, 5, 6], "handl": 8, "happen": [6, 14], "have": [9, 11, 14], "header": [2, 5, 14], "helan": [10, 13], "helix": [10, 13], "help": [3, 8, 10, 12, 13, 14], "helper": 6, "henrik": 7, "here": 9, "high": [0, 12], "higher": [5, 12, 14], "hole": [10, 13], "holeanalysi": [10, 13], "hopefulli": 9, "how": [3, 9, 12, 14], "howev": [9, 12], "http": [2, 3, 6, 8, 9, 11], "hydrogenbondanalysi": 1, "i": [1, 2, 3, 5, 6, 9, 10, 11, 12, 13, 14], "id": 1, "ignor": [1, 3, 5, 9], "ignore_warn": [1, 3], "implement": 9, "import": [1, 3, 9], "improv": 8, "includ": 3, "incompat": 9, "indent": 5, "indexerror": [3, 6], "individu": [3, 9], "ine": 3, "info": [2, 4, 5], "inform": [3, 6, 10, 13, 14], "init_base_argpars": 3, "initi": [8, 12], "initil": 3, "inludc": 4, "inplac": 3, "input": [3, 5, 6], "insid": [9, 12], "inspect": [6, 12], "inspir": 12, "instal": [8, 10, 13, 14], "instanc": [3, 4, 5], "instead": 0, "instruct": [8, 14], "int": [4, 6], "integ": [6, 8], "integr": [8, 9], "interact": 9, "interfac": [0, 1, 3, 12], "interface_nam": 3, "intermolecular": [10, 13], "intern": 0, "interpret": 9, "interrdf": [10, 13, 14], "interrdf_": 1, "interrdf_count_bins_rdf": 14, "introduc": 8, "is_1d_arrai": 5, "is_2d_arrai": 5, "is_3d_arrai": 5, "is_dimension_arrai": 5, "is_higher_dimension_arrai": 5, "is_serializ": 5, "isort": 8, "issu": [9, 11], "item": 5, "iter": 3, "its": [6, 12, 14], "itself": 12, "janin": [10, 13], "jdict": 5, "joao": 7, "json": [3, 5, 12, 14], "json_dict": 5, "jsonarg": 5, "just": [11, 12], "j\u00e4ger": 7, "kei": [3, 5, 6], "keyword": 3, "klass": 6, "known": 12, "kwarg": 5, "kwargsdict": 3, "lab": 12, "lammp": 3, "last": 9, "later": 11, "least": 12, "length": [3, 5], "level": [0, 4, 8], "libcli": [3, 8], "librari": 12, "like": [5, 9], "lili": 7, "limit": [8, 12], "line": [0, 1, 3, 5, 6, 12, 14], "linear": [10, 13], "lineardens": [10, 13], "link": 8, "lint": 9, "list": [1, 3, 5, 8, 9, 14], "list_1d": 5, "load": 3, "local": 9, "locat": 12, "loch": 7, "log": [0, 3, 14], "logfil": [3, 4, 14], "logger": 4, "logic": [3, 8], "logobj": 4, "long": 8, "loop": 12, "lowercas": 8, "lzabil": 6, "m": [1, 7, 9], "machin": 9, "maco": 8, "madcli": 9, "mai": [3, 9], "maico": 12, "main": [3, 6], "make": [8, 9, 12], "manag": 5, "mandatori": 3, "mandatory_analysis_paramet": 3, "mani": 12, "manual": 8, "map": 5, "mass": 3, "matrix": 8, "md": [10, 13], "mda": [8, 10, 12, 13, 14], "mdacli": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14], "mdacli_result": 5, "mdanalysi": [1, 3, 5, 8, 9, 11, 12, 14], "mean": [10, 13], "member": 3, "merg": 9, "messag": [2, 4, 9, 10, 13], "metavar": 3, "method": [6, 9], "might": 0, "min_ndim": 5, "mock": 1, "mod": 3, "mode": 3, "modul": [1, 3, 8, 14], "module_list": 1, "module_nam": 3, "moment": [10, 13], "more": [8, 10, 12, 13, 14], "most": 9, "move": 8, "multidimension": 5, "must": 3, "my": [2, 9], "myfork": 9, "namd": 3, "name": [1, 3, 4, 5, 6, 8, 9, 10, 13, 14], "namespac": 3, "narg": 3, "ndarrai": [3, 5], "ndim": 5, "need": [0, 3, 8, 9], "new": [3, 8, 12], "next": 9, "nice": 9, "no_entry_sign": 9, "non": 5, "none": [1, 3, 4, 5, 8], "nor": 3, "note": [3, 5], "now": 9, "np": [3, 5], "nt": 8, "num": 5, "number": [5, 6, 8, 14], "numpi": [3, 5], "numpydocstr": 6, "o": 14, "obj": 4, "object": [3, 5, 6, 12], "observ": [10, 13], "ok": 2, "oliv": 7, "ommit": 1, "onc": 9, "one": [3, 5], "onli": [0, 3, 4, 9, 10, 13], "onlin": [9, 14], "open": [9, 14], "oper": 5, "option": [3, 5, 8, 14], "option_str": 3, "optional_analysis_paramet": 3, "order": 3, "org": 8, "organ": 5, "origin": 5, "other": 14, "our": [9, 12], "out_extra": 5, "out_list": 5, "output": [3, 14], "output_directori": 3, "output_paramet": 3, "output_prefix": 3, "overview": [10, 13], "ow": 14, "own": [9, 14], "oxygen": 14, "p": 6, "packag": [8, 9], "page": [0, 8, 10, 13, 14], "pair": [10, 13], "pairwis": [10, 13], "paramet": [1, 2, 3, 4, 5, 6, 8, 12, 14], "parent": [3, 12], "pars": [3, 6, 8], "parsabl": 8, "parse_callable_signatur": 6, "parse_doc": 6, "parser": [3, 6, 12], "partial": 3, "pass": [3, 9], "pca": [10, 13], "pdb": 3, "peopl": 12, "per": 3, "perform": [3, 9, 10, 13], "permiss": 8, "persistencelength": 1, "phase": 9, "philip": 7, "pink": 2, "pip": 9, "pipelin": 9, "pkg": 3, "place": 9, "pleas": [9, 11], "pluge": 11, "point": 3, "popul": 3, "posit": 8, "possibl": 3, "possibli": 9, "potenti": 2, "power": 9, "pr": 9, "pre": 14, "prefix": [5, 14], "present": [3, 6, 9], "previou": 9, "princip": [10, 13], "print": [2, 3], "pro": 9, "probabl": 3, "problem": 12, "procedur": 14, "process": [3, 9, 12], "profil": [10, 13], "program": [3, 10, 13], "progress": [10, 13], "project": [10, 12, 13], "proper": 5, "protoread": 3, "provid": [3, 12, 14], "psf": 3, "pullrequest": 9, "push": 9, "py": [4, 8, 9, 11], "py3": 8, "pyproject": 8, "python": [8, 9, 11, 12], "question": 3, "r": 6, "radial": 14, "rais": [3, 6], "ramachandran": [10, 13], "rdf": 14, "read": [3, 9], "reader": 3, "readm": 8, "real": 9, "red": 2, "reenabl": 8, "refer": [0, 3, 8, 9, 10, 13], "reference_univers": 3, "reference_universe_paramet": 3, "reflect": 9, "regex": [6, 8], "regex101": 6, "regular": 0, "regularli": 12, "rel": 3, "relat": [10, 13], "relax": 9, "releas": 8, "remov": [5, 8], "remove_fil": 5, "renam": 8, "replac": 8, "repositori": 11, "requir": [3, 6, 8, 14], "result": [0, 12, 14], "return": [2, 3, 5, 6], "return_with_remov": 5, "review": 9, "right": 9, "rigid": 14, "rm": [10, 13], "rmsd": [10, 13], "rmsf": [10, 13], "root": 4, "routin": 12, "row": [5, 14], "rst": [8, 9], "run": [3, 6, 8, 10, 13, 14], "run_analsi": 8, "run_analysi": [3, 8], "run_paramet": 3, "safe": 9, "same": [3, 5, 9, 11, 12], "sampl": 14, "save": [0, 3, 8, 12, 14], "save_1d_arrai": 5, "save_2d_arrai": 5, "save_3d_arrai": 5, "save_3d_array_to_2d_csv": 5, "save_files_to_zip": 5, "save_higher_dim_arrai": 5, "save_json_serializ": 5, "save_result": 8, "save_result_arrai": 5, "save_results_object": 5, "save_to_json": 5, "savetxt_w_command": 5, "scientist": 12, "script": 12, "search": 3, "see": [2, 3, 6, 9, 14], "select": [3, 10, 12, 13, 14], "select_atom": 3, "seri": 3, "serializ": 5, "serv": 5, "set": [3, 4, 8, 9, 14], "setup": [8, 9, 11], "setup_cli": 3, "setup_log": [4, 8], "sever": 12, "shape": 3, "shortest": 5, "shortli": 9, "should": [1, 3, 9, 11], "show": 12, "signatur": 6, "similar": 14, "simpl": [10, 12, 13, 14], "simplifi": 8, "simul": 12, "sinc": [3, 9, 12], "singl": [3, 5, 8], "skip_mod": 1, "skip_modul": 1, "slightli": 11, "smile": 9, "smile_cat": 9, "so": [6, 9, 11, 12, 14], "solv": 12, "some": [9, 12, 14], "sometim": 12, "sort_kei": 5, "sourc": [1, 2, 3, 4, 5, 6], "spc": 14, "special": 3, "specif": [0, 9], "specifi": [4, 10, 13], "split": [3, 5, 6], "split_argparse_into_group": 3, "split_time_unit": 6, "squar": [10, 13], "squeez": 5, "stack": 5, "stack_1d_arrays_list": 5, "stackoverflow": 3, "stage": [10, 13], "stai": 12, "start": [3, 6, 8, 12], "static": 2, "step": [3, 6, 9], "stop": [3, 8], "storage_dict": 6, "store": [3, 5, 12, 14], "str": [1, 2, 3, 4, 5, 6], "stream": 3, "strict": 6, "string": [1, 2, 3, 5, 6, 14], "structur": [10, 12, 13], "student": 12, "style": [2, 8, 9], "sub": 3, "sub_pars": 3, "subclass": 3, "subdictinari": 6, "submit": 9, "subpars": 3, "subset": 5, "subtitl": 9, "suffix": 3, "suitabl": 3, "summari": 6, "suppli": 3, "support": [0, 8, 10, 13], "syntax": 12, "t": [9, 11], "tabl": [3, 5], "taken": [2, 5], "task": 9, "taurenmd": 12, "teixeira": 7, "term": 3, "termin": 14, "test": 8, "thei": [5, 12], "them": [9, 12], "therefor": 12, "thezip": 5, "thi": [1, 2, 3, 6, 10, 12, 13, 14], "thread": 8, "through": [10, 12, 13], "time": [3, 6, 8, 9], "titl": [3, 9], "togeth": [5, 11, 14], "toml": 8, "tool": [10, 11, 13], "top": 11, "toplevel": 1, "topol": 14, "topolgi": 14, "topologi": [3, 12], "topology_format": 3, "topologyreaderbas": 3, "tox": 8, "tox_": 9, "tpr": 14, "traj": 14, "trajectori": [3, 8, 10, 12, 13, 14], "trajectory_format": 3, "translat": 8, "trr": [3, 14], "true": [1, 5], "try": 5, "try_to_squeeze_m": 5, "tupl": 6, "turquois": 2, "tuvokki": 2, "twice": 9, "two": 14, "type": [3, 5, 6, 8, 12], "typo": 8, "u": [9, 11], "under": 9, "underlin": 2, "unit": [3, 6], "univers": [3, 12], "up": [1, 3, 9, 12], "updat": [8, 11], "upgrad": 11, "upload": 8, "upstream": 9, "url": 8, "us": [0, 3, 6, 8, 9, 10, 11, 12, 13, 14], "usag": 0, "user": [0, 12], "usernam": 9, "util": 0, "v": 14, "v2": 9, "valu": [5, 6, 8], "valueerror": [3, 6], "variabl": [2, 12], "vebos": 3, "vector": 3, "verbos": [3, 14], "veri": [0, 9, 12], "verifi": 9, "version": [1, 3, 9], "vertic": 5, "via": 9, "volumetr": [10, 13], "vx": 9, "wai": [3, 9, 12], "wang": 7, "want": [0, 11], "warn": [1, 2, 3, 4, 14], "water": 14, "waterbridgeanalysi": 1, "we": [5, 9, 12], "webpag": 7, "welcom": [9, 10, 13], "well": 9, "were": 12, "what": 3, "when": [1, 6, 9], "where": [3, 5, 6], "which": [1, 3, 5, 6, 11, 12], "whole": 9, "window": 8, "wish": 9, "within": 12, "without": [5, 12], "work": [3, 10, 13], "workflow": 9, "wrapper": 12, "write": 12, "x": [5, 6, 9], "x1b": 2, "xdarr": 5, "xplor": 3, "xtc": 3, "xyz": 3, "yai": 2, "yellow": 2, "yet": 6, "you": [9, 11, 14], "your": [10, 11, 13, 14], "zip": [5, 12, 14], "zipit": 5, "zipnam": 5, "\u03c7_1": [10, 13], "\u03c7_2": [10, 13], "\u03c8": [10, 13], "\u03d5": [10, 13]}, "titles": ["API library documentation", "High-Level API", "Coloring", "Support functions for CLI", "Logging", "Results Saving", "Utilities", "Authors", "Changelog", "Contributing", "MDAnalysis command line interface", "Installation", "Philosophy and approach", "MDAnalysis command line interface", "Usage"], "titleterms": {"0": 8, "01": 8, "02": 8, "03": 8, "04": 8, "06": 8, "07": 8, "08": 8, "09": 8, "1": 8, "10": 8, "11": 8, "12": 8, "13": 8, "14": 8, "15": 8, "16": 8, "17": 8, "18": 8, "19": 8, "2": 8, "20": 8, "2021": 8, "2022": 8, "2023": 8, "2024": 8, "21": 8, "22": 8, "23": 8, "24": 8, "25": 8, "26": 8, "27": 8, "28": 8, "29": 8, "3": 8, "30": 8, "31": 8, "4": 8, "5": 8, "6": 8, "7": 8, "8": 8, "9": 8, "add": 9, "api": [0, 1], "approach": 12, "author": 7, "avail": [10, 13], "branch": 9, "chang": 9, "changelog": [8, 9], "cli": 3, "clone": 9, "color": 2, "command": [10, 13], "comput": 9, "conda": 11, "contribut": 9, "creat": 9, "develop": 9, "document": 0, "fork": 9, "function": 3, "high": 1, "instal": [9, 11], "interfac": [10, 13], "level": 1, "librari": 0, "line": [10, 13], "log": 4, "main": 9, "mdanalysi": [10, 13], "modul": [10, 13], "new": 9, "philosophi": 12, "pip": 11, "project": 9, "pull": 9, "remot": 9, "repositori": 9, "request": 9, "result": 5, "run": 9, "save": 5, "start": 9, "support": 3, "test": 9, "thi": 9, "tox": 9, "updat": 9, "usag": 14, "util": 6, "v0": 8, "your": 9}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API library documentation": [[0, "api-library-documentation"]], "Add your fork as remote": [[9, "add-your-fork-as-remote"]], "Authors": [[7, "authors"]], "Available modules": [[10, "available-modules"], [13, "available-modules"]], "Changelog": [[8, "changelog"]], "Clone the main project to your computer": [[9, "clone-the-main-project-to-your-computer"]], "Coloring": [[2, "module-mdacli.colors"]], "Contributing": [[9, "contributing"]], "Create a new branch and start developing": [[9, "create-a-new-branch-and-start-developing"]], "Fork this repository": [[9, "fork-this-repository"]], "High-Level API": [[1, "module-mdacli.cli"]], "Install for developers": [[9, "install-for-developers"]], "Installation": [[11, "installation"]], "Logging": [[4, "module-mdacli.logger"]], "MDAnalysis command line interface": [[10, "mdanalysis-command-line-interface"], [13, "mdanalysis-command-line-interface"]], "Philosophy and approach": [[12, "philosophy-and-approach"]], "Pull Request": [[9, "pull-request"]], "Pull Request your changes": [[9, "pull-request-your-changes"]], "Results Saving": [[5, "module-mdacli.save"]], "Running tests with tox": [[9, "running-tests-with-tox"]], "Support functions for CLI": [[3, "module-mdacli.libcli"]], "Update CHANGELOG": [[9, "update-changelog"]], "Usage": [[14, "usage"]], "Utilities": [[6, "module-mdacli.utils"]], "conda": [[11, "conda"]], "pip": [[11, "pip"]], "v0.1.0 (2021-11-18)": [[8, "v0-1-0-2021-11-18"]], "v0.1.1 (2021-11-18)": [[8, "v0-1-1-2021-11-18"]], "v0.1.10 (2022-01-18)": [[8, "v0-1-10-2022-01-18"]], "v0.1.11 (2022-01-19)": [[8, "v0-1-11-2022-01-19"]], "v0.1.12 (2022-01-19)": [[8, "v0-1-12-2022-01-19"]], "v0.1.13 (2022-02-16)": [[8, "v0-1-13-2022-02-16"]], "v0.1.14 (2022-02-17)": [[8, "v0-1-14-2022-02-17"]], "v0.1.15 (2022-02-25)": [[8, "v0-1-15-2022-02-25"]], "v0.1.16 (2022-02-25)": [[8, "v0-1-16-2022-02-25"]], "v0.1.17 (2022-04-07)": [[8, "v0-1-17-2022-04-07"]], "v0.1.18 (2022-04-12)": [[8, "v0-1-18-2022-04-12"]], "v0.1.19 (2022-04-12)": [[8, "v0-1-19-2022-04-12"]], "v0.1.2 (2021-11-18)": [[8, "v0-1-2-2021-11-18"]], "v0.1.20 (2022-04-13)": [[8, "v0-1-20-2022-04-13"]], "v0.1.21 (2022-04-22)": [[8, "v0-1-21-2022-04-22"]], "v0.1.22 (2023-01-27)": [[8, "v0-1-22-2023-01-27"]], "v0.1.23 (2023-01-27)": [[8, "v0-1-23-2023-01-27"]], "v0.1.24 (2023-01-27)": [[8, "v0-1-24-2023-01-27"]], "v0.1.25 (2023-02-21)": [[8, "v0-1-25-2023-02-21"]], "v0.1.26 (2023-06-27)": [[8, "v0-1-26-2023-06-27"]], "v0.1.27 (2023-08-25)": [[8, "v0-1-27-2023-08-25"]], "v0.1.28 (2023-09-29)": [[8, "v0-1-28-2023-09-29"]], "v0.1.29 (2024-03-21)": [[8, "v0-1-29-2024-03-21"]], "v0.1.3 (2021-11-24)": [[8, "v0-1-3-2021-11-24"]], "v0.1.30 (2024-04-03)": [[8, "v0-1-30-2024-04-03"]], "v0.1.31 (2024-07-08)": [[8, "v0-1-31-2024-07-08"]], "v0.1.4 (2021-11-24)": [[8, "v0-1-4-2021-11-24"]], "v0.1.5 (2021-12-01)": [[8, "v0-1-5-2021-12-01"]], "v0.1.6 (2021-12-01)": [[8, "v0-1-6-2021-12-01"]], "v0.1.7 (2021-12-18)": [[8, "v0-1-7-2021-12-18"]], "v0.1.8 (2022-01-16)": [[8, "v0-1-8-2022-01-16"]], "v0.1.9 (2022-01-16)": [[8, "v0-1-9-2022-01-16"]]}, "docnames": ["api", "api/cli", "api/colors", "api/libcli", "api/logger", "api/save", "api/utils", "authors", "changelog", "contributing", "index", "installation", "philosophy", "readme", "usage"], "envversion": {"sphinx": 61, "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.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "api/cli.rst", "api/colors.rst", "api/libcli.rst", "api/logger.rst", "api/save.rst", "api/utils.rst", "authors.rst", "changelog.rst", "contributing.rst", "index.rst", "installation.rst", "philosophy.rst", "readme.rst", "usage.rst"], "indexentries": {"add_cli_universe() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_cli_universe", false]], "add_output_group() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_output_group", false]], "add_run_group() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_run_group", false]], "blue (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.blue", false]], "bold (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.bold", false]], "cli() (in module mdacli.cli)": [[1, "mdacli.cli.cli", false]], "convert_analysis_parameters() (in module mdacli.libcli)": [[3, "mdacli.libcli.convert_analysis_parameters", false]], "convert_str_time() (in module mdacli.utils)": [[6, "mdacli.utils.convert_str_time", false]], "create_cli() (in module mdacli.libcli)": [[3, "mdacli.libcli.create_cli", false]], "create_universe() (in module mdacli.libcli)": [[3, "mdacli.libcli.create_universe", false]], "debug() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.debug", false]], "emphasise (class in mdacli.colors)": [[2, "mdacli.colors.Emphasise", false]], "emphasise() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.emphasise", false]], "error() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.error", false]], "find_classes_in_modules() (in module mdacli.libcli)": [[3, "mdacli.libcli.find_classes_in_modules", false]], "find_cls_members() (in module mdacli.libcli)": [[3, "mdacli.libcli.find_cls_members", false]], "get_1d_arrays() (in module mdacli.save)": [[5, "mdacli.save.get_1D_arrays", false]], "get_cli_input() (in module mdacli.save)": [[5, "mdacli.save.get_cli_input", false]], "gray (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.gray", false]], "green (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.green", false]], "header() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.header", false]], "info() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.info", false]], "init_base_argparse() (in module mdacli.libcli)": [[3, "mdacli.libcli.init_base_argparse", false]], "is_1d_array() (in module mdacli.save)": [[5, "mdacli.save.is_1d_array", false]], "is_2d_array() (in module mdacli.save)": [[5, "mdacli.save.is_2d_array", false]], "is_3d_array() (in module mdacli.save)": [[5, "mdacli.save.is_3d_array", false]], "is_dimension_array() (in module mdacli.save)": [[5, "mdacli.save.is_dimension_array", false]], "is_higher_dimension_array() (in module mdacli.save)": [[5, "mdacli.save.is_higher_dimension_array", false]], "is_serializable() (in module mdacli.save)": [[5, "mdacli.save.is_serializable", false]], "kwargsdict (class in mdacli.libcli)": [[3, "mdacli.libcli.KwargsDict", false]], "mdacli.cli": [[1, "module-mdacli.cli", false]], "mdacli.colors": [[2, "module-mdacli.colors", false]], "mdacli.libcli": [[3, "module-mdacli.libcli", false]], "mdacli.logger": [[4, "module-mdacli.logger", false]], "mdacli.save": [[5, "module-mdacli.save", false]], "mdacli.utils": [[6, "module-mdacli.utils", false]], "module": [[1, "module-mdacli.cli", false], [2, "module-mdacli.colors", false], [3, "module-mdacli.libcli", false], [4, "module-mdacli.logger", false], [5, "module-mdacli.save", false], [6, "module-mdacli.utils", false]], "ok() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.ok", false]], "parse_callable_signature() (in module mdacli.utils)": [[6, "mdacli.utils.parse_callable_signature", false]], "parse_docs() (in module mdacli.utils)": [[6, "mdacli.utils.parse_docs", false]], "pink (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.pink", false]], "red (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.red", false]], "remove_files() (in module mdacli.save)": [[5, "mdacli.save.remove_files", false]], "return_with_remove() (in module mdacli.save)": [[5, "mdacli.save.return_with_remove", false]], "run_analysis() (in module mdacli.libcli)": [[3, "mdacli.libcli.run_analysis", false]], "save() (in module mdacli.save)": [[5, "mdacli.save.save", false]], "save_1d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_1D_arrays", false]], "save_2d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_2D_arrays", false]], "save_3d_array_to_2d_csv() (in module mdacli.save)": [[5, "mdacli.save.save_3D_array_to_2D_csv", false]], "save_3d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_3D_arrays", false]], "save_files_to_zip() (in module mdacli.save)": [[5, "mdacli.save.save_files_to_zip", false]], "save_higher_dim_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_higher_dim_arrays", false]], "save_json_serializables() (in module mdacli.save)": [[5, "mdacli.save.save_json_serializables", false]], "save_result_array() (in module mdacli.save)": [[5, "mdacli.save.save_result_array", false]], "save_results_object() (in module mdacli.save)": [[5, "mdacli.save.save_Results_object", false]], "save_to_json() (in module mdacli.save)": [[5, "mdacli.save.save_to_json", false]], "savetxt_w_command() (in module mdacli.save)": [[5, "mdacli.save.savetxt_w_command", false]], "setup_clients() (in module mdacli.libcli)": [[3, "mdacli.libcli.setup_clients", false]], "setup_logging() (in module mdacli.logger)": [[4, "mdacli.logger.setup_logging", false]], "split_argparse_into_groups() (in module mdacli.libcli)": [[3, "mdacli.libcli.split_argparse_into_groups", false]], "split_time_unit() (in module mdacli.utils)": [[6, "mdacli.utils.split_time_unit", false]], "stack_1d_arrays_list() (in module mdacli.save)": [[5, "mdacli.save.stack_1d_arrays_list", false]], "try_to_squeeze_me() (in module mdacli.save)": [[5, "mdacli.save.try_to_squeeze_me", false]], "turquoise (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.turquoise", false]], "underline (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.underline", false]], "warning() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.warning", false]], "yellow (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.yellow", false]]}, "objects": {"mdacli": [[1, 0, 0, "-", "cli"], [2, 0, 0, "-", "colors"], [3, 0, 0, "-", "libcli"], [4, 0, 0, "-", "logger"], [5, 0, 0, "-", "save"], [6, 0, 0, "-", "utils"]], "mdacli.cli": [[1, 1, 1, "", "cli"]], "mdacli.colors": [[2, 2, 1, "", "Emphasise"]], "mdacli.colors.Emphasise": [[2, 3, 1, "", "blue"], [2, 3, 1, "", "bold"], [2, 4, 1, "", "debug"], [2, 4, 1, "", "emphasise"], [2, 4, 1, "", "error"], [2, 3, 1, "", "gray"], [2, 3, 1, "", "green"], [2, 4, 1, "", "header"], [2, 4, 1, "", "info"], [2, 4, 1, "", "ok"], [2, 3, 1, "", "pink"], [2, 3, 1, "", "red"], [2, 3, 1, "", "turquoise"], [2, 3, 1, "", "underline"], [2, 4, 1, "", "warning"], [2, 3, 1, "", "yellow"]], "mdacli.libcli": [[3, 2, 1, "", "KwargsDict"], [3, 1, 1, "", "add_cli_universe"], [3, 1, 1, "", "add_output_group"], [3, 1, 1, "", "add_run_group"], [3, 1, 1, "", "convert_analysis_parameters"], [3, 1, 1, "", "create_cli"], [3, 1, 1, "", "create_universe"], [3, 1, 1, "", "find_classes_in_modules"], [3, 1, 1, "", "find_cls_members"], [3, 1, 1, "", "init_base_argparse"], [3, 1, 1, "", "run_analysis"], [3, 1, 1, "", "setup_clients"], [3, 1, 1, "", "split_argparse_into_groups"]], "mdacli.logger": [[4, 1, 1, "", "setup_logging"]], "mdacli.save": [[5, 1, 1, "", "get_1D_arrays"], [5, 1, 1, "", "get_cli_input"], [5, 1, 1, "", "is_1d_array"], [5, 1, 1, "", "is_2d_array"], [5, 1, 1, "", "is_3d_array"], [5, 1, 1, "", "is_dimension_array"], [5, 1, 1, "", "is_higher_dimension_array"], [5, 1, 1, "", "is_serializable"], [5, 1, 1, "", "remove_files"], [5, 1, 1, "", "return_with_remove"], [5, 1, 1, "", "save"], [5, 1, 1, "", "save_1D_arrays"], [5, 1, 1, "", "save_2D_arrays"], [5, 1, 1, "", "save_3D_array_to_2D_csv"], [5, 1, 1, "", "save_3D_arrays"], [5, 1, 1, "", "save_Results_object"], [5, 1, 1, "", "save_files_to_zip"], [5, 1, 1, "", "save_higher_dim_arrays"], [5, 1, 1, "", "save_json_serializables"], [5, 1, 1, "", "save_result_array"], [5, 1, 1, "", "save_to_json"], [5, 1, 1, "", "savetxt_w_command"], [5, 1, 1, "", "stack_1d_arrays_list"], [5, 1, 1, "", "try_to_squeeze_me"]], "mdacli.utils": [[6, 1, 1, "", "convert_str_time"], [6, 1, 1, "", "parse_callable_signature"], [6, 1, 1, "", "parse_docs"], [6, 1, 1, "", "split_time_unit"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "terms": {"": [3, 6, 9, 12, 14], "0": 3, "01": 9, "1": [2, 3, 5], "109": 8, "114": 8, "140423703360128": 1, "14deb97bef6df9bc6553": 2, "1900": 9, "1d": [5, 12], "1darrai": 5, "1m": 2, "2": [5, 6], "2d": [5, 12], "2darr": 5, "2nd": 14, "3": [3, 5], "30": 4, "31519997": 3, "3d": 5, "3darr": 5, "3rd": 14, "4": [5, 14], "4m": 2, "6": 3, "65": 8, "68": 8, "70": 8, "75": 8, "78": 8, "80": 8, "81": 8, "82": 8, "83": 8, "85": 8, "86": 8, "88": 8, "90": 3, "90m": 2, "91m": 2, "92m": 2, "93m": 2, "94m": 2, "95m": 2, "96m": 2, "A": [0, 3, 4, 5, 6, 10, 12, 13, 14], "For": [4, 9, 10, 13, 14], "If": [3, 4, 5, 6, 9, 11, 12], "It": 9, "Not": 9, "One": 6, "Or": 11, "That": 9, "The": [0, 1, 2, 3, 5, 6, 9, 12, 14], "These": 9, "To": [10, 11, 13, 14], "With": 12, "__all__": 1, "__authors__": 8, "__doc__": 1, "__init__": 6, "__version__": 1, "about": [5, 10, 13, 14], "absolut": 3, "accept": 9, "accor": 5, "accord": 3, "accordingli": 8, "account": 9, "achiev": 14, "across": [10, 13], "action": [8, 9], "activ": 11, "actual": [3, 12, 14], "ad": [3, 6, 8, 12], "add": [3, 5, 8], "add_argu": 8, "add_cli_univers": 3, "add_output_group": 3, "add_run_group": 3, "addit": [5, 9, 14], "adjust": 12, "advanc": 0, "after": [3, 9, 14], "align": [10, 13], "aligntraj": [10, 13], "all": [3, 5, 9, 12, 14], "allow": 8, "along": 5, "alreadi": [6, 9, 11], "also": [3, 9, 11, 12, 14], "altern": 3, "alwai": 9, "an": [3, 6, 9, 10, 12, 13, 14], "analysi": [1, 3, 5, 8, 10, 12, 13, 14], "analysis_cal": 3, "analysis_class_pars": 3, "analysis_paramet": 3, "analysisbas": [1, 3, 12], "analysisfromfunct": 1, "analyz": 12, "anaylsi": 1, "anaylysi": 3, "angl": [3, 10, 13], "ani": [3, 6, 9, 11, 12], "anlysi": 3, "ap": 3, "appear": 9, "appli": [5, 9, 12], "ar": [3, 4, 5, 6, 9, 10, 11, 12, 13, 14], "archiv": 5, "arg": 8, "arg_grouped_dict": 3, "argpars": [3, 10, 12, 13], "argument": [3, 8, 12], "argumentpars": 3, "argumentspars": 3, "around": 12, "arr": 5, "arr_nam": 5, "arrai": [5, 12, 14], "ask": 14, "assert": 5, "assum": 6, "atom": [3, 10, 13, 14], "atom_styl": 3, "atomgroup": [3, 8, 10, 13, 14], "attempt": 3, "attract": 12, "attribut": [2, 5], "author": 9, "automat": [11, 12], "avail": [2, 3, 14], "averag": [10, 13], "averagestructur": [10, 13], "avoid": 9, "b": 9, "banner": 8, "bare": 14, "base": [1, 3, 5, 6, 8, 9, 10, 12, 13], "base_class": 1, "basic": [3, 10, 13], "bcolor": 2, "becaus": [3, 9], "beckstein": 7, "befor": 9, "begin": 3, "bellow": 9, "belong": [1, 3], "between": [10, 13, 14], "blue": 2, "bold": 2, "bond": 3, "bool": [1, 3, 5], "boolean": 8, "both": 12, "box": 8, "build": [1, 9, 12], "bullet": 9, "bump2vers": 8, "bumpvers": 8, "bunch": 14, "c": [7, 9, 11], "calcul": [10, 13, 14], "callabl": 6, "callable_obj": 6, "can": [3, 6, 9, 11, 12, 14], "canon": 8, "case": 9, "categori": 3, "cd": 9, "cell": 3, "certain": [3, 5], "certifi": 9, "cfg": 8, "chain": 3, "challeng": 12, "chang": [3, 8, 14], "charg": 3, "charmm": 3, "check": [5, 8], "checkout": 9, "choic": [3, 8], "ci": [8, 9], "cl": [1, 3], "class": [1, 2, 3, 6, 8, 10, 12, 13, 14], "classifi": 8, "clever": 12, "cli": [0, 1, 6, 8, 10, 12, 13], "cli_pars": 3, "client": [3, 14], "clone": 11, "close": [10, 13], "closecontactgnmanalysi": [10, 13], "code": [1, 9, 12], "codebas": 12, "codecov": 8, "color": 0, "column": 14, "com": [2, 3, 6, 9, 11], "combin": [6, 12], "command": [0, 1, 3, 5, 9, 12, 14], "commit": 9, "commun": 9, "complet": 8, "complex": 14, "compon": [10, 13], "compress": 5, "comput": [10, 13], "conda": [8, 9], "conflict": 9, "const": 3, "contact": [1, 10, 11, 13], "contain": [1, 3, 5, 6, 12, 14], "continu": 9, "contribut": [8, 10, 13], "contributor": 9, "conveni": 6, "convert": [3, 6, 8], "convert_analysis_paramet": 3, "convert_str_tim": 6, "coordin": [3, 10, 13], "copi": 12, "core": [3, 12], "correct": [3, 8, 9], "correctli": 9, "correspond": [5, 14], "could": [2, 3, 6, 12], "crd": 3, "creat": [1, 3, 4, 5, 12], "create_cli": [3, 8], "create_univers": 3, "creation": [3, 6, 8], "csv": [5, 12, 14], "current": [10, 13, 14], "custom": 3, "customis": 3, "dai": 12, "danger": 2, "data": [3, 5, 12, 14], "dcd": 3, "ddict": 5, "debug": [2, 3, 4, 8, 14], "decor": 2, "decorated_messag": 2, "default": [3, 5, 14], "defin": [3, 5], "degre": 3, "densiti": [10, 13], "densityanalysi": [10, 13], "dep": [9, 11], "depend": [8, 11], "deploi": 8, "deploy": 8, "desc": 6, "describ": 9, "descript": [1, 3, 6, 8, 10, 13], "design": 3, "desir": 2, "dest": 3, "detail": [4, 6, 14], "detect": [8, 12], "develop": [0, 10, 11, 12, 13], "dict": [3, 5, 6], "dictionari": [3, 5, 6, 12], "did": 9, "dielectricconst": [10, 13], "dihedr": [1, 8, 10, 13], "dim": 5, "dimens": [3, 5, 8], "dimension": [5, 12, 14], "dimes": 3, "dipol": [10, 13], "direct": 12, "directli": [5, 11, 14], "directori": 14, "disabl": 8, "disk": 5, "displac": [10, 13], "displai": 4, "distanc": [10, 13], "distancematrix": [10, 13], "distribut": [10, 13, 14], "divid": 3, "do": [8, 9], "doc": [3, 8, 9], "docstr": [6, 8, 12], "document": [8, 9, 10, 13, 14], "doe": [0, 3, 6], "don": [9, 11], "done": 3, "doubl": 5, "doubt": 11, "downstream": 12, "dt": 6, "dump": [12, 14], "e": [3, 9, 12, 14], "each": [3, 5, 10, 12, 13, 14], "earli": [9, 10, 13], "easi": 9, "easier": 12, "effect": 3, "effort": 12, "eg": 3, "einstein": [10, 13], "einsteinmsd": [10, 13], "either": [3, 12], "element": 3, "els": [3, 5], "emphais": 2, "emphasis": 2, "empti": 3, "emul": 14, "encapsul": 9, "end": 3, "engag": 9, "environ": [4, 9, 11], "error": [2, 4], "especi": 9, "etc": [2, 14], "even": 14, "everi": 3, "everyth": [5, 11], "evolv": 12, "exactli": 9, "exampl": [1, 2, 4, 9, 14], "execut": [3, 5], "exist": [3, 12], "expect": 3, "experi": 12, "expert": 11, "explain": [9, 14], "explanatori": 9, "extend": 6, "extens": [3, 5], "extra_list": 5, "extract": 6, "f": [1, 12, 14], "face": 12, "fail": [8, 9], "fals": [1, 3], "feedback": 9, "fetch": 9, "ff": 9, "file": [3, 4, 5, 8, 9, 10, 12, 13, 14], "filenam": 4, "filesuffix": 5, "fill": 3, "final": 9, "find": 3, "find_classes_in_modul": 3, "find_cls_memb": 3, "finish": 9, "first": [9, 11], "fix": 8, "flag": [3, 9, 12, 14], "flexibl": 8, "float": [3, 6], "fly": 12, "fname": 5, "follow": [3, 6, 9, 10, 13], "fomat": 5, "forg": [9, 11], "form": 9, "format": [3, 6], "found": [3, 6], "fprefix": 5, "frame": [3, 6, 8, 10, 12, 13], "framework": 12, "friend": 9, "from": [0, 1, 2, 3, 4, 5, 6, 8, 9, 11, 12, 14], "fsuffix": 5, "function": [0, 1, 4, 5, 6, 9, 10, 13, 14], "funtion": 3, "g": 3, "g1": 14, "g2": 14, "gener": [3, 8, 12], "get": 5, "get_1d_arrai": 5, "get_cli_input": 5, "gist": 2, "git": 9, "github": [2, 7, 8, 9, 11], "give": 9, "given": [1, 3, 4, 6, 10, 13], "gnm": [10, 13], "gnmanalysi": [10, 13], "go": 9, "goal": 0, "goe": 9, "good": 9, "got": 5, "grai": 2, "great": 2, "green": 2, "gro": 3, "gromac": [3, 12, 14], "grorup": 3, "group": [3, 10, 13, 14], "guess": 3, "guid": 9, "guidelin": 9, "h": [10, 13, 14], "ha": [3, 5, 6], "handl": 8, "happen": [6, 14], "have": [9, 11, 14], "header": [2, 5, 14], "helan": [10, 13], "helix": [10, 13], "help": [3, 8, 10, 12, 13, 14], "helper": 6, "henrik": 7, "here": 9, "high": [0, 12], "higher": [5, 12, 14], "hole": [10, 13], "holeanalysi": [10, 13], "hopefulli": 9, "how": [3, 9, 12, 14], "howev": [9, 12], "http": [2, 3, 6, 8, 9, 11], "hydrogenbondanalysi": 1, "i": [1, 2, 3, 5, 6, 9, 10, 11, 12, 13, 14], "id": 1, "ignor": [1, 3, 5, 9], "ignore_warn": [1, 3], "implement": 9, "import": [1, 3, 9], "improv": 8, "includ": 3, "incompat": 9, "indent": 5, "indexerror": [3, 6], "individu": [3, 9], "ine": 3, "info": [2, 4, 5], "inform": [3, 6, 10, 13, 14], "init_base_argpars": 3, "initi": [8, 12], "initil": 3, "inludc": 4, "inplac": 3, "input": [3, 5, 6], "insid": [9, 12], "inspect": [6, 12], "inspir": 12, "instal": [8, 10, 13, 14], "instanc": [3, 4, 5], "instead": 0, "instruct": [8, 14], "int": [4, 6], "integ": [6, 8], "integr": [8, 9], "interact": 9, "interfac": [0, 1, 3, 12], "interface_nam": 3, "intermolecular": [10, 13], "intern": 0, "interpret": 9, "interrdf": [10, 13, 14], "interrdf_": 1, "interrdf_count_bins_rdf": 14, "introduc": 8, "is_1d_arrai": 5, "is_2d_arrai": 5, "is_3d_arrai": 5, "is_dimension_arrai": 5, "is_higher_dimension_arrai": 5, "is_serializ": 5, "isort": 8, "issu": [9, 11], "item": 5, "iter": 3, "its": [6, 12, 14], "itself": 12, "janin": [10, 13], "jdict": 5, "joao": 7, "json": [3, 5, 12, 14], "json_dict": 5, "jsonarg": 5, "just": [11, 12], "j\u00e4ger": 7, "kei": [3, 5, 6], "keyword": 3, "klass": 6, "known": 12, "kwarg": 5, "kwargsdict": 3, "lab": 12, "lammp": 3, "last": 9, "later": 11, "least": 12, "length": [3, 5], "level": [0, 4, 8], "libcli": [3, 8], "librari": 12, "like": [5, 9], "lili": 7, "limit": [8, 12], "line": [0, 1, 3, 5, 6, 12, 14], "linear": [10, 13], "lineardens": [10, 13], "link": 8, "lint": 9, "list": [1, 3, 5, 8, 9, 14], "list_1d": 5, "load": 3, "local": 9, "locat": 12, "loch": 7, "log": [0, 3, 14], "logfil": [3, 4, 14], "logger": 4, "logic": [3, 8], "logobj": 4, "long": 8, "loop": 12, "lowercas": 8, "lzabil": 6, "m": [1, 7, 9], "machin": 9, "maco": 8, "madcli": 9, "mai": [3, 9], "maico": 12, "main": [3, 6], "make": [8, 9, 12], "manag": 5, "mandatori": 3, "mandatory_analysis_paramet": 3, "mani": 12, "manual": 8, "map": 5, "mass": 3, "matrix": 8, "md": [10, 13], "mda": [8, 10, 12, 13, 14], "mdacli": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14], "mdacli_result": 5, "mdanalysi": [1, 3, 5, 8, 9, 11, 12, 14], "mean": [10, 13], "member": 3, "merg": 9, "messag": [2, 4, 9, 10, 13], "metavar": 3, "method": [6, 9], "might": 0, "min_ndim": 5, "mock": 1, "mod": 3, "mode": 3, "modul": [1, 3, 8, 14], "module_list": 1, "module_nam": 3, "moment": [10, 13], "more": [8, 10, 12, 13, 14], "most": 9, "move": 8, "multidimension": 5, "must": 3, "my": [2, 9], "myfork": 9, "namd": 3, "name": [1, 3, 4, 5, 6, 8, 9, 10, 13, 14], "namespac": 3, "narg": 3, "ndarrai": [3, 5], "ndim": 5, "need": [0, 3, 8, 9], "new": [3, 8, 12], "next": 9, "nice": 9, "no_entry_sign": 9, "non": 5, "none": [1, 3, 4, 5, 8], "nor": 3, "note": [3, 5], "now": 9, "np": [3, 5], "nt": 8, "num": 5, "number": [5, 6, 8, 14], "numpi": [3, 5], "numpydocstr": 6, "o": 14, "obj": 4, "object": [3, 5, 6, 12], "observ": [10, 13], "ok": 2, "oliv": 7, "ommit": 1, "onc": 9, "one": [3, 5], "onli": [0, 3, 4, 9, 10, 13], "onlin": [9, 14], "open": [9, 14], "oper": 5, "option": [3, 5, 8, 14], "option_str": 3, "optional_analysis_paramet": 3, "order": 3, "org": 8, "organ": 5, "origin": 5, "other": 14, "our": [9, 12], "out_extra": 5, "out_list": 5, "output": [3, 14], "output_directori": 3, "output_paramet": 3, "output_prefix": 3, "overview": [10, 13], "ow": 14, "own": [9, 14], "oxygen": 14, "p": 6, "packag": [8, 9], "page": [0, 8, 10, 13, 14], "pair": [10, 13], "pairwis": [10, 13], "paramet": [1, 2, 3, 4, 5, 6, 8, 12, 14], "parent": [3, 12], "pars": [3, 6, 8], "parsabl": 8, "parse_callable_signatur": 6, "parse_doc": 6, "parser": [3, 6, 12], "partial": 3, "pass": [3, 9], "pca": [10, 13], "pdb": 3, "peopl": 12, "per": 3, "perform": [3, 9, 10, 13], "permiss": 8, "persistencelength": 1, "phase": 9, "philip": 7, "pink": 2, "pip": 9, "pipelin": 9, "pkg": 3, "place": 9, "pleas": [9, 11], "pluge": 11, "point": 3, "popul": 3, "posit": 8, "possibl": 3, "possibli": 9, "potenti": 2, "power": 9, "pr": 9, "pre": 14, "prefix": [5, 14], "present": [3, 6, 9], "previou": 9, "princip": [10, 13], "print": [2, 3], "pro": 9, "probabl": 3, "problem": 12, "procedur": 14, "process": [3, 9, 12], "profil": [10, 13], "program": [3, 10, 13], "progress": [10, 13], "project": [10, 12, 13], "proper": 5, "protoread": 3, "provid": [3, 12, 14], "psf": 3, "pullrequest": 9, "push": 9, "py": [4, 8, 9, 11], "py3": 8, "pyproject": 8, "python": [8, 9, 11, 12], "question": 3, "r": 6, "radial": 14, "rais": [3, 6], "ramachandran": [10, 13], "rdf": 14, "read": [3, 9], "reader": 3, "readm": 8, "real": 9, "red": 2, "reenabl": 8, "refer": [0, 3, 8, 9, 10, 13], "reference_univers": 3, "reference_universe_paramet": 3, "reflect": 9, "regex": [6, 8], "regex101": 6, "regular": 0, "regularli": 12, "rel": 3, "relat": [10, 13], "relax": 9, "releas": 8, "remov": [5, 8], "remove_fil": 5, "renam": 8, "replac": 8, "repositori": 11, "requir": [3, 6, 8, 14], "result": [0, 12, 14], "return": [2, 3, 5, 6], "return_with_remov": 5, "review": 9, "right": 9, "rigid": 14, "rm": [10, 13], "rmsd": [10, 13], "rmsf": [10, 13], "root": 4, "routin": 12, "row": [5, 14], "rst": [8, 9], "run": [3, 6, 8, 10, 13, 14], "run_analsi": 8, "run_analysi": [3, 8], "run_paramet": 3, "safe": 9, "same": [3, 5, 9, 11, 12], "sampl": 14, "save": [0, 3, 8, 12, 14], "save_1d_arrai": 5, "save_2d_arrai": 5, "save_3d_arrai": 5, "save_3d_array_to_2d_csv": 5, "save_files_to_zip": 5, "save_higher_dim_arrai": 5, "save_json_serializ": 5, "save_result": 8, "save_result_arrai": 5, "save_results_object": 5, "save_to_json": 5, "savetxt_w_command": 5, "scientist": 12, "script": 12, "search": 3, "see": [2, 3, 6, 9, 14], "select": [3, 10, 12, 13, 14], "select_atom": 3, "seri": 3, "serializ": 5, "serv": 5, "set": [3, 4, 8, 9, 14], "setup": [8, 9, 11], "setup_cli": 3, "setup_log": [4, 8], "sever": 12, "shape": 3, "shortest": 5, "shortli": 9, "should": [1, 3, 9, 11], "show": 12, "signatur": 6, "similar": 14, "simpl": [10, 12, 13, 14], "simplifi": 8, "simul": 12, "sinc": [3, 9, 12], "singl": [3, 5, 8], "skip_mod": 1, "skip_modul": 1, "slightli": 11, "smile": 9, "smile_cat": 9, "so": [6, 9, 11, 12, 14], "solv": 12, "some": [9, 12, 14], "sometim": 12, "sort_kei": 5, "sourc": [1, 2, 3, 4, 5, 6], "spc": 14, "special": 3, "specif": [0, 9], "specifi": [4, 10, 13], "split": [3, 5, 6], "split_argparse_into_group": 3, "split_time_unit": 6, "squar": [10, 13], "squeez": 5, "stack": 5, "stack_1d_arrays_list": 5, "stackoverflow": 3, "stage": [10, 13], "stai": 12, "start": [3, 6, 8, 12], "static": 2, "step": [3, 6, 9], "stop": [3, 8], "storage_dict": 6, "store": [3, 5, 12, 14], "str": [1, 2, 3, 4, 5, 6], "stream": 3, "strict": 6, "string": [1, 2, 3, 5, 6, 14], "structur": [10, 12, 13], "student": 12, "style": [2, 8, 9], "sub": 3, "sub_pars": 3, "subclass": 3, "subdictinari": 6, "submit": 9, "subpars": 3, "subset": 5, "subtitl": 9, "suffix": 3, "suitabl": 3, "summari": 6, "suppli": 3, "support": [0, 8, 10, 13], "syntax": 12, "t": [9, 11], "tabl": [3, 5], "taken": [2, 5], "task": 9, "taurenmd": 12, "teixeira": 7, "term": 3, "termin": 14, "test": 8, "thei": [5, 12], "them": [9, 12], "therefor": 12, "thezip": 5, "thi": [1, 2, 3, 6, 10, 12, 13, 14], "thread": 8, "through": [10, 12, 13], "time": [3, 6, 8, 9], "titl": [3, 9], "togeth": [5, 11, 14], "toml": 8, "tool": [10, 11, 13], "top": 11, "toplevel": 1, "topol": 14, "topolgi": 14, "topologi": [3, 12], "topology_format": 3, "topologyreaderbas": 3, "tox": 8, "tox_": 9, "tpr": 14, "traj": 14, "trajectori": [3, 8, 10, 12, 13, 14], "trajectory_format": 3, "translat": 8, "trr": [3, 14], "true": [1, 5], "try": 5, "try_to_squeeze_m": 5, "tupl": 6, "turquois": 2, "tuvokki": 2, "twice": 9, "two": 14, "type": [3, 5, 6, 8, 12], "typo": 8, "u": [9, 11], "under": 9, "underlin": 2, "unit": [3, 6], "univers": [3, 12], "up": [1, 3, 9, 12], "updat": [8, 11], "upgrad": 11, "upload": 8, "upstream": 9, "url": 8, "us": [0, 3, 6, 8, 9, 10, 11, 12, 13, 14], "usag": 0, "user": [0, 12], "usernam": 9, "util": 0, "v": 14, "v2": 9, "valu": [5, 6, 8], "valueerror": [3, 6], "variabl": [2, 12], "vebos": 3, "vector": 3, "verbos": [3, 14], "veri": [0, 9, 12], "verifi": 9, "version": [1, 3, 9], "vertic": 5, "via": 9, "volumetr": [10, 13], "vx": 9, "wai": [3, 9, 12], "wang": 7, "want": [0, 11], "warn": [1, 2, 3, 4, 14], "water": 14, "waterbridgeanalysi": 1, "we": [5, 9, 12], "webpag": 7, "welcom": [9, 10, 13], "well": 9, "were": 12, "what": 3, "when": [1, 6, 9], "where": [3, 5, 6], "which": [1, 3, 5, 6, 11, 12], "whole": 9, "window": 8, "wish": 9, "within": 12, "without": [5, 12], "work": [3, 10, 13], "workflow": 9, "wrapper": 12, "write": 12, "x": [5, 6, 9], "x1b": 2, "xdarr": 5, "xplor": 3, "xtc": 3, "xyz": 3, "yai": 2, "yellow": 2, "yet": 6, "you": [9, 11, 14], "your": [10, 11, 13, 14], "zip": [5, 12, 14], "zipit": 5, "zipnam": 5, "\u03c7_1": [10, 13], "\u03c7_2": [10, 13], "\u03c8": [10, 13], "\u03d5": [10, 13]}, "titles": ["API library documentation", "High-Level API", "Coloring", "Support functions for CLI", "Logging", "Results Saving", "Utilities", "Authors", "Changelog", "Contributing", "MDAnalysis command line interface", "Installation", "Philosophy and approach", "MDAnalysis command line interface", "Usage"], "titleterms": {"0": 8, "01": 8, "02": 8, "03": 8, "04": 8, "06": 8, "07": 8, "08": 8, "09": 8, "1": 8, "10": 8, "11": 8, "12": 8, "13": 8, "14": 8, "15": 8, "16": 8, "17": 8, "18": 8, "19": 8, "2": 8, "20": 8, "2021": 8, "2022": 8, "2023": 8, "2024": 8, "21": 8, "22": 8, "23": 8, "24": 8, "25": 8, "26": 8, "27": 8, "28": 8, "29": 8, "3": 8, "30": 8, "31": 8, "4": 8, "5": 8, "6": 8, "7": 8, "8": 8, "9": 8, "add": 9, "api": [0, 1], "approach": 12, "author": 7, "avail": [10, 13], "branch": 9, "chang": 9, "changelog": [8, 9], "cli": 3, "clone": 9, "color": 2, "command": [10, 13], "comput": 9, "conda": 11, "contribut": 9, "creat": 9, "develop": 9, "document": 0, "fork": 9, "function": 3, "high": 1, "instal": [9, 11], "interfac": [10, 13], "level": 1, "librari": 0, "line": [10, 13], "log": 4, "main": 9, "mdanalysi": [10, 13], "modul": [10, 13], "new": 9, "philosophi": 12, "pip": 11, "project": 9, "pull": 9, "remot": 9, "repositori": 9, "request": 9, "result": 5, "run": 9, "save": 5, "start": 9, "support": 3, "test": 9, "thi": 9, "tox": 9, "updat": 9, "usag": 14, "util": 6, "v0": 8, "your": 9}}) \ No newline at end of file diff --git a/0.1.31/usage.html b/0.1.31/usage.html index 7a3459f..729b94b 100644 --- a/0.1.31/usage.html +++ b/0.1.31/usage.html @@ -151,7 +151,7 @@

Usage

© Copyright 2021, Philip Loche, Joao MC Teixeira and Oliver Beckstein. - Last updated on Jul 08, 2024. + Last updated on Jul 09, 2024.

diff --git a/dev/_modules/index.html b/dev/_modules/index.html index a22f018..fd41492 100644 --- a/dev/_modules/index.html +++ b/dev/_modules/index.html @@ -3,7 +3,7 @@ - Overview: module code — mdacli 0.1.32 documentation + Overview: module code — mdacli 0.1.31 documentation @@ -17,13 +17,13 @@ - + @@ -42,7 +42,7 @@
- 0.1.32 + 0.1.31
@@ -129,7 +129,7 @@

All modules for which code is available

aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/dev/_modules/mdacli/cli.html b/dev/_modules/mdacli/cli.html index 78d6d83..82fdad0 100644 --- a/dev/_modules/mdacli/cli.html +++ b/dev/_modules/mdacli/cli.html @@ -3,7 +3,7 @@ - mdacli.cli — mdacli 0.1.32 documentation + mdacli.cli — mdacli 0.1.31 documentation @@ -17,13 +17,13 @@ - + @@ -42,7 +42,7 @@
- 0.1.32 + 0.1.31
@@ -274,7 +274,7 @@

Source code for mdacli.cli

      aria-label="versions">
     
       
-        0.1.32
+        0.1.31
       
     
 
diff --git a/dev/_modules/mdacli/colors.html b/dev/_modules/mdacli/colors.html
index f7f432e..d62cd2c 100644
--- a/dev/_modules/mdacli/colors.html
+++ b/dev/_modules/mdacli/colors.html
@@ -3,7 +3,7 @@
 
   
   
-  mdacli.colors — mdacli 0.1.32 documentation
+  mdacli.colors — mdacli 0.1.31 documentation
       
       
       
@@ -17,13 +17,13 @@
   
         
         
-        
+        
         
         
         
     
     
     
      
@@ -42,7 +42,7 @@
               
           
               
- 0.1.32 + 0.1.31
@@ -341,7 +341,7 @@

Source code for mdacli.colors

      aria-label="versions">
     
       
-        0.1.32
+        0.1.31
       
     
 
diff --git a/dev/_modules/mdacli/libcli.html b/dev/_modules/mdacli/libcli.html
index 9ffc26f..3380f62 100644
--- a/dev/_modules/mdacli/libcli.html
+++ b/dev/_modules/mdacli/libcli.html
@@ -3,7 +3,7 @@
 
   
   
-  mdacli.libcli — mdacli 0.1.32 documentation
+  mdacli.libcli — mdacli 0.1.31 documentation
       
       
       
@@ -17,13 +17,13 @@
   
         
         
-        
+        
         
         
         
     
     
     
      
@@ -42,7 +42,7 @@
               
           
               
- 0.1.32 + 0.1.31
@@ -985,7 +985,7 @@

Source code for mdacli.libcli

      aria-label="versions">
     
       
-        0.1.32
+        0.1.31
       
     
 
diff --git a/dev/_modules/mdacli/logger.html b/dev/_modules/mdacli/logger.html
index 2594940..2759bc5 100644
--- a/dev/_modules/mdacli/logger.html
+++ b/dev/_modules/mdacli/logger.html
@@ -3,7 +3,7 @@
 
   
   
-  mdacli.logger — mdacli 0.1.32 documentation
+  mdacli.logger — mdacli 0.1.31 documentation
       
       
       
@@ -17,13 +17,13 @@
   
         
         
-        
+        
         
         
         
     
     
     
      
@@ -42,7 +42,7 @@
               
           
               
- 0.1.32 + 0.1.31
@@ -95,60 +95,20 @@

Source code for mdacli.logger

 # Released under the GNU Public Licence, v2 or any higher version
 # SPDX-License-Identifier: GPL-2.0-or-later
 """Logging."""
+
 import contextlib
 import logging
 import sys
-import warnings
-from pathlib import Path
-from typing import List, Optional, Union
 
 from .colors import Emphasise
 
 
-
-[docs] -def check_suffix(filename: Union[str, Path], suffix: str) -> Union[str, Path]: - """Check the suffix of a file name and adds if it not existing. - - If ``filename`` does not end with ``suffix`` the ``suffix`` is added and a - warning will be issued. - - Parameters - ---------- - filename : Name of the file to be checked. - suffix : Expected filesuffix i.e. ``.txt``. - - Returns - ------- - Checked and probably extended file name. - """ - path_filename = Path(filename) - - if path_filename.suffix != suffix: - warnings.warn( - f"The file name should have a '{suffix}' extension. The user " - f"requested the file with name '{filename}', but it will be saved " - f"as '{filename}{suffix}'.", - stacklevel=1, - ) - path_filename = path_filename.parent / (path_filename.name + suffix) - - if type(filename) is str: - return str(path_filename) - else: - return path_filename
- - -
[docs] @contextlib.contextmanager -def setup_logging( - logobj: logging.Logger, - logfile: Optional[Union[str, Path]] = None, - level: int = logging.WARNING, -): - """Create a logging environment for a given ``log_obj``. +def setup_logging(logobj, logfile=None, level=logging.WARNING): + """ + Create a logging environment for a given logobj. Parameters ---------- @@ -159,52 +119,39 @@

Source code for mdacli.logger

     level : int
         Set the root logger level to the specified level. If for example set
         to :py:obj:`logging.DEBUG` detailed debug logs inludcing filename and
-        function name are displayed. For :py:obj:`logging.INFO` only the
-        message logged from errors, warnings and infos will be displayed.
+        function name are displayed. For :py:obj:`logging.INFO only the message
+        logged from errors, warnings and infos will be displayed.
     """
     try:
-        format = ""
         if level == logging.DEBUG:
-            format += "[{levelname}]:{filename}:{funcName}:{lineno} - "
-        format += "{message}"
-
-        formatter = logging.Formatter(format, style="{")
-        handlers: List[Union[logging.StreamHandler, logging.FileHandler]] = []
+            format = (
+                "[{levelname}] {filename}:{name}:{funcName}:{lineno}: "
+                "{message}"
+            )
+        else:
+            format = "{message}"
 
-        stream_handler = logging.StreamHandler(sys.stdout)
-        stream_handler.setFormatter(formatter)
-        handlers.append(stream_handler)
+        logging.basicConfig(format=format,
+                            handlers=[logging.StreamHandler(sys.stdout)],
+                            level=level,
+                            style='{')
 
         if logfile:
-            logfile = check_suffix(filename=logfile, suffix=".log")
-            file_handler = logging.FileHandler(
-                filename=str(logfile), encoding="utf-8")
-            file_handler.setFormatter(formatter)
-            handlers.append(file_handler)
+            logfile += ".log" * (not logfile.endswith("log"))
+            handler = logging.FileHandler(filename=logfile, encoding='utf-8')
+            handler.setFormatter(logging.Formatter(format, style='{'))
+            logobj.addHandler(handler)
         else:
             logging.addLevelName(logging.INFO, Emphasise.info("INFO"))
             logging.addLevelName(logging.DEBUG, Emphasise.debug("DEBUG"))
             logging.addLevelName(logging.WARNING, Emphasise.warning("WARNING"))
             logging.addLevelName(logging.ERROR, Emphasise.error("ERROR"))
-
-        logging.basicConfig(
-            format=format, handlers=handlers, level=level, style="{")
-        logging.captureWarnings(True)
-
-        if logfile:
-            abs_path = str(Path(logfile).absolute().resolve())
-            logobj.info(f"This log is also available at {abs_path!r}.")
-        else:
-            logobj.debug("Logging to file is disabled.")
-
-        for handler in handlers:
-            logobj.addHandler(handler)
+            logobj.info('Logging to file is disabled.')
 
         yield
-
     finally:
+        handlers = logobj.handlers[:]
         for handler in handlers:
-            handler.flush()
             handler.close()
             logobj.removeHandler(handler)
@@ -245,7 +192,7 @@

Source code for mdacli.logger

      aria-label="versions">
     
       
-        0.1.32
+        0.1.31
       
     
 
diff --git a/dev/_modules/mdacli/save.html b/dev/_modules/mdacli/save.html
index d68e06c..94f00ff 100644
--- a/dev/_modules/mdacli/save.html
+++ b/dev/_modules/mdacli/save.html
@@ -3,7 +3,7 @@
 
   
   
-  mdacli.save — mdacli 0.1.32 documentation
+  mdacli.save — mdacli 0.1.31 documentation
       
       
       
@@ -17,13 +17,13 @@
   
         
         
-        
+        
         
         
         
     
     
     
      
@@ -42,7 +42,7 @@
               
           
               
- 0.1.32 + 0.1.31
@@ -580,7 +580,7 @@

Source code for mdacli.save

      aria-label="versions">
     
       
-        0.1.32
+        0.1.31
       
     
 
diff --git a/dev/_modules/mdacli/utils.html b/dev/_modules/mdacli/utils.html
index 8863210..8888189 100644
--- a/dev/_modules/mdacli/utils.html
+++ b/dev/_modules/mdacli/utils.html
@@ -3,7 +3,7 @@
 
   
   
-  mdacli.utils — mdacli 0.1.32 documentation
+  mdacli.utils — mdacli 0.1.31 documentation
       
       
       
@@ -17,13 +17,13 @@
   
         
         
-        
+        
         
         
         
     
     
     
      
@@ -42,7 +42,7 @@
               
           
               
- 0.1.32 + 0.1.31
@@ -396,7 +396,7 @@

Source code for mdacli.utils

      aria-label="versions">
     
       
-        0.1.32
+        0.1.31
       
     
 
diff --git a/dev/_static/documentation_options.js b/dev/_static/documentation_options.js
index e673888..ef6aebe 100644
--- a/dev/_static/documentation_options.js
+++ b/dev/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.1.32',
+    VERSION: '0.1.31',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
diff --git a/dev/_static/opensearch.xml b/dev/_static/opensearch.xml
index 479fda6..82ff9e2 100644
--- a/dev/_static/opensearch.xml
+++ b/dev/_static/opensearch.xml
@@ -1,11 +1,11 @@
 
 
   mdacli
-  Search mdacli 0.1.32 documentation
+  Search mdacli 0.1.31 documentation
   utf-8
   
-  mdacli 0.1.32 documentation
+  mdacli 0.1.31 documentation
   https://mdacli.mdanalysis.org//_static/mdanalysis-logo.ico
   
 
\ No newline at end of file
diff --git a/dev/api.html b/dev/api.html
index 4f06a71..a2bd874 100644
--- a/dev/api.html
+++ b/dev/api.html
@@ -4,7 +4,7 @@
   
 
   
-  API library documentation — mdacli 0.1.32 documentation
+  API library documentation — mdacli 0.1.31 documentation
       
       
       
@@ -18,13 +18,13 @@
   
         
         
-        
+        
         
         
         
     
     
     
     
@@ -45,7 +45,7 @@
               
           
               
- 0.1.32 + 0.1.31
@@ -154,7 +154,7 @@

API library documentation - 0.1.32 + 0.1.31 diff --git a/dev/api/cli.html b/dev/api/cli.html index 2f4db5b..0785451 100644 --- a/dev/api/cli.html +++ b/dev/api/cli.html @@ -4,7 +4,7 @@ - High-Level API — mdacli 0.1.32 documentation + High-Level API — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
- 0.1.32 + 0.1.31
@@ -106,7 +106,7 @@

The toplevel command line interface.

-mdacli.cli.cli(name, module_list, base_class=<Mock name='mock.AnalysisBase' id='139825847530112'>, version='', description='', skip_modules=None, ignore_warnings=False)[source]
+mdacli.cli.cli(name, module_list, base_class=<Mock name='mock.AnalysisBase' id='140423703360128'>, version='', description='', skip_modules=None, ignore_warnings=False)[source]

Create the command-line interface.

This function creates a command line interface with a given name based on a module list.

@@ -187,7 +187,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/dev/api/colors.html b/dev/api/colors.html index 2e90659..b099c97 100644 --- a/dev/api/colors.html +++ b/dev/api/colors.html @@ -4,7 +4,7 @@ - Coloring — mdacli 0.1.32 documentation + Coloring — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
- 0.1.32 + 0.1.31
@@ -357,7 +357,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/dev/api/libcli.html b/dev/api/libcli.html index 93f94d6..dfc82dc 100644 --- a/dev/api/libcli.html +++ b/dev/api/libcli.html @@ -4,7 +4,7 @@ - Support functions for CLI — mdacli 0.1.32 documentation + Support functions for CLI — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
- 0.1.32 + 0.1.31
@@ -454,7 +454,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/dev/api/logger.html b/dev/api/logger.html index 30a96b9..cd634da 100644 --- a/dev/api/logger.html +++ b/dev/api/logger.html @@ -4,7 +4,7 @@ - Logging — mdacli 0.1.32 documentation + Logging — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
- 0.1.32 + 0.1.31
@@ -66,7 +66,6 @@
  • Results Saving
  • Coloring
  • Logging
  • @@ -105,29 +104,10 @@

    Logging

    Logging.

    -
    -
    -mdacli.logger.check_suffix(filename: str | Path, suffix: str) str | Path[source]
    -

    Check the suffix of a file name and adds if it not existing.

    -

    If filename does not end with suffix the suffix is added and a -warning will be issued.

    -
    -
    Parameters:
    -
      -
    • filename (Name of the file to be checked.)

    • -
    • suffix (Expected filesuffix i.e. .txt.)

    • -
    -
    -
    Returns:
    -

    Checked and probably extended file name.

    -
    -
    -
    -
    -mdacli.logger.setup_logging(logobj: Logger, logfile: str | Path | None = None, level: int = 30)[source]
    -

    Create a logging environment for a given log_obj.

    +mdacli.logger.setup_logging(logobj, logfile=None, level=30)[source] +

    Create a logging environment for a given logobj.

    Parameters:
      @@ -135,8 +115,8 @@
    • logfile (str) – Name of the log file

    • level (int) – Set the root logger level to the specified level. If for example set to logging.DEBUG detailed debug logs inludcing filename and -function name are displayed. For logging.INFO only the -message logged from errors, warnings and infos will be displayed.

    • +function name are displayed. For :py:obj:`logging.INFO only the message +logged from errors, warnings and infos will be displayed.

    @@ -183,7 +163,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/dev/api/save.html b/dev/api/save.html index d62ebdc..93e3dd7 100644 --- a/dev/api/save.html +++ b/dev/api/save.html @@ -4,7 +4,7 @@ - Results Saving — mdacli 0.1.32 documentation + Results Saving — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
    - 0.1.32 + 0.1.31
    @@ -371,7 +371,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/dev/api/utils.html b/dev/api/utils.html index a25a90b..d1dfc33 100644 --- a/dev/api/utils.html +++ b/dev/api/utils.html @@ -4,7 +4,7 @@ - Utilities — mdacli 0.1.32 documentation + Utilities — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
    - 0.1.32 + 0.1.31
    @@ -231,7 +231,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/dev/authors.html b/dev/authors.html index 5cbb4d6..5e87b53 100644 --- a/dev/authors.html +++ b/dev/authors.html @@ -4,7 +4,7 @@ - Authors — mdacli 0.1.32 documentation + Authors — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -44,7 +44,7 @@
    - 0.1.32 + 0.1.31
    @@ -137,7 +137,7 @@

    Authors aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/dev/changelog.html b/dev/changelog.html index 1304834..c341651 100644 --- a/dev/changelog.html +++ b/dev/changelog.html @@ -4,7 +4,7 @@ - Changelog — mdacli 0.1.32 documentation + Changelog — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
    - 0.1.32 + 0.1.31
    @@ -62,7 +62,6 @@
  • Contributing
  • API library documentation
  • Changelog
      -
    • v0.1.32 (2024-07-09)
    • v0.1.31 (2024-07-08)
    • v0.1.30 (2024-04-03)
    • v0.1.29 (2024-03-21)
    • @@ -126,12 +125,6 @@

      Changelog

      -
      -

      v0.1.32 (2024-07-09)

      -
        -
      • Cleanup logger function

      • -
      -

      v0.1.31 (2024-07-08)

        @@ -386,7 +379,7 @@

        v0.1.0 (2021-11-18) - 0.1.32 + 0.1.31 diff --git a/dev/contributing.html b/dev/contributing.html index e511b69..bb7816d 100644 --- a/dev/contributing.html +++ b/dev/contributing.html @@ -4,7 +4,7 @@ - Contributing — mdacli 0.1.32 documentation + Contributing — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
        - 0.1.32 + 0.1.31
        @@ -278,7 +278,7 @@

        Pull Request - 0.1.32 + 0.1.31 diff --git a/dev/genindex.html b/dev/genindex.html index 64f94d1..ab5cb51 100644 --- a/dev/genindex.html +++ b/dev/genindex.html @@ -3,7 +3,7 @@ - Index — mdacli 0.1.32 documentation + Index — mdacli 0.1.31 documentation @@ -17,13 +17,13 @@ - + @@ -42,7 +42,7 @@
        - 0.1.32 + 0.1.31
        @@ -139,8 +139,6 @@

        B

        C

          -
        • check_suffix() (in module mdacli.logger) -
        • cli() (in module mdacli.cli)
        • convert_analysis_parameters() (in module mdacli.libcli) @@ -466,7 +464,7 @@

          Y

          aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/dev/index.html b/dev/index.html index aaeeece..8942c4a 100644 --- a/dev/index.html +++ b/dev/index.html @@ -4,7 +4,7 @@ - MDAnalysis command line interface — mdacli 0.1.32 documentation + MDAnalysis command line interface — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -44,7 +44,7 @@
          - 0.1.32 + 0.1.31
          @@ -225,7 +225,7 @@

          Available modules - 0.1.32 + 0.1.31 diff --git a/dev/installation.html b/dev/installation.html index ad87670..e32251c 100644 --- a/dev/installation.html +++ b/dev/installation.html @@ -4,7 +4,7 @@ - Installation — mdacli 0.1.32 documentation + Installation — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
          - 0.1.32 + 0.1.31
          @@ -170,7 +170,7 @@

          conda - 0.1.32 + 0.1.31 diff --git a/dev/objects.inv b/dev/objects.inv index b58dabf..6986add 100644 Binary files a/dev/objects.inv and b/dev/objects.inv differ diff --git a/dev/philosophy.html b/dev/philosophy.html index 6661305..e9ac197 100644 --- a/dev/philosophy.html +++ b/dev/philosophy.html @@ -4,7 +4,7 @@ - Philosophy and approach — mdacli 0.1.32 documentation + Philosophy and approach — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
          - 0.1.32 + 0.1.31
          @@ -182,7 +182,7 @@

          Philosophy and approach - 0.1.32 + 0.1.31 diff --git a/dev/py-modindex.html b/dev/py-modindex.html index 5f598d1..bf4eaca 100644 --- a/dev/py-modindex.html +++ b/dev/py-modindex.html @@ -3,7 +3,7 @@ - Python Module Index — mdacli 0.1.32 documentation + Python Module Index — mdacli 0.1.31 documentation @@ -17,13 +17,13 @@ - + @@ -45,7 +45,7 @@
          - 0.1.32 + 0.1.31
          @@ -173,7 +173,7 @@

          Python Module Index

          aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/dev/readme.html b/dev/readme.html index 1eb9da0..8ee2d8b 100644 --- a/dev/readme.html +++ b/dev/readme.html @@ -4,7 +4,7 @@ - MDAnalysis command line interface — mdacli 0.1.32 documentation + MDAnalysis command line interface — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -43,7 +43,7 @@
          - 0.1.32 + 0.1.31
          @@ -220,7 +220,7 @@

          Available modules - 0.1.32 + 0.1.31 diff --git a/dev/search.html b/dev/search.html index 94b66dd..fb8e1f8 100644 --- a/dev/search.html +++ b/dev/search.html @@ -3,7 +3,7 @@ - Search — mdacli 0.1.32 documentation + Search — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
          - 0.1.32 + 0.1.31
          @@ -136,7 +136,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/dev/searchindex.js b/dev/searchindex.js index ea96ba2..716e176 100644 --- a/dev/searchindex.js +++ b/dev/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API library documentation": [[0, "api-library-documentation"]], "Add your fork as remote": [[9, "add-your-fork-as-remote"]], "Authors": [[7, "authors"]], "Available modules": [[10, "available-modules"], [13, "available-modules"]], "Changelog": [[8, "changelog"]], "Clone the main project to your computer": [[9, "clone-the-main-project-to-your-computer"]], "Coloring": [[2, "module-mdacli.colors"]], "Contributing": [[9, "contributing"]], "Create a new branch and start developing": [[9, "create-a-new-branch-and-start-developing"]], "Fork this repository": [[9, "fork-this-repository"]], "High-Level API": [[1, "module-mdacli.cli"]], "Install for developers": [[9, "install-for-developers"]], "Installation": [[11, "installation"]], "Logging": [[4, "module-mdacli.logger"]], "MDAnalysis command line interface": [[10, "mdanalysis-command-line-interface"], [13, "mdanalysis-command-line-interface"]], "Philosophy and approach": [[12, "philosophy-and-approach"]], "Pull Request": [[9, "pull-request"]], "Pull Request your changes": [[9, "pull-request-your-changes"]], "Results Saving": [[5, "module-mdacli.save"]], "Running tests with tox": [[9, "running-tests-with-tox"]], "Support functions for CLI": [[3, "module-mdacli.libcli"]], "Update CHANGELOG": [[9, "update-changelog"]], "Usage": [[14, "usage"]], "Utilities": [[6, "module-mdacli.utils"]], "conda": [[11, "conda"]], "pip": [[11, "pip"]], "v0.1.0 (2021-11-18)": [[8, "v0-1-0-2021-11-18"]], "v0.1.1 (2021-11-18)": [[8, "v0-1-1-2021-11-18"]], "v0.1.10 (2022-01-18)": [[8, "v0-1-10-2022-01-18"]], "v0.1.11 (2022-01-19)": [[8, "v0-1-11-2022-01-19"]], "v0.1.12 (2022-01-19)": [[8, "v0-1-12-2022-01-19"]], "v0.1.13 (2022-02-16)": [[8, "v0-1-13-2022-02-16"]], "v0.1.14 (2022-02-17)": [[8, "v0-1-14-2022-02-17"]], "v0.1.15 (2022-02-25)": [[8, "v0-1-15-2022-02-25"]], "v0.1.16 (2022-02-25)": [[8, "v0-1-16-2022-02-25"]], "v0.1.17 (2022-04-07)": [[8, "v0-1-17-2022-04-07"]], "v0.1.18 (2022-04-12)": [[8, "v0-1-18-2022-04-12"]], "v0.1.19 (2022-04-12)": [[8, "v0-1-19-2022-04-12"]], "v0.1.2 (2021-11-18)": [[8, "v0-1-2-2021-11-18"]], "v0.1.20 (2022-04-13)": [[8, "v0-1-20-2022-04-13"]], "v0.1.21 (2022-04-22)": [[8, "v0-1-21-2022-04-22"]], "v0.1.22 (2023-01-27)": [[8, "v0-1-22-2023-01-27"]], "v0.1.23 (2023-01-27)": [[8, "v0-1-23-2023-01-27"]], "v0.1.24 (2023-01-27)": [[8, "v0-1-24-2023-01-27"]], "v0.1.25 (2023-02-21)": [[8, "v0-1-25-2023-02-21"]], "v0.1.26 (2023-06-27)": [[8, "v0-1-26-2023-06-27"]], "v0.1.27 (2023-08-25)": [[8, "v0-1-27-2023-08-25"]], "v0.1.28 (2023-09-29)": [[8, "v0-1-28-2023-09-29"]], "v0.1.29 (2024-03-21)": [[8, "v0-1-29-2024-03-21"]], "v0.1.3 (2021-11-24)": [[8, "v0-1-3-2021-11-24"]], "v0.1.30 (2024-04-03)": [[8, "v0-1-30-2024-04-03"]], "v0.1.31 (2024-07-08)": [[8, "v0-1-31-2024-07-08"]], "v0.1.32 (2024-07-09)": [[8, "v0-1-32-2024-07-09"]], "v0.1.4 (2021-11-24)": [[8, "v0-1-4-2021-11-24"]], "v0.1.5 (2021-12-01)": [[8, "v0-1-5-2021-12-01"]], "v0.1.6 (2021-12-01)": [[8, "v0-1-6-2021-12-01"]], "v0.1.7 (2021-12-18)": [[8, "v0-1-7-2021-12-18"]], "v0.1.8 (2022-01-16)": [[8, "v0-1-8-2022-01-16"]], "v0.1.9 (2022-01-16)": [[8, "v0-1-9-2022-01-16"]]}, "docnames": ["api", "api/cli", "api/colors", "api/libcli", "api/logger", "api/save", "api/utils", "authors", "changelog", "contributing", "index", "installation", "philosophy", "readme", "usage"], "envversion": {"sphinx": 61, "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.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "api/cli.rst", "api/colors.rst", "api/libcli.rst", "api/logger.rst", "api/save.rst", "api/utils.rst", "authors.rst", "changelog.rst", "contributing.rst", "index.rst", "installation.rst", "philosophy.rst", "readme.rst", "usage.rst"], "indexentries": {"add_cli_universe() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_cli_universe", false]], "add_output_group() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_output_group", false]], "add_run_group() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_run_group", false]], "blue (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.blue", false]], "bold (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.bold", false]], "check_suffix() (in module mdacli.logger)": [[4, "mdacli.logger.check_suffix", false]], "cli() (in module mdacli.cli)": [[1, "mdacli.cli.cli", false]], "convert_analysis_parameters() (in module mdacli.libcli)": [[3, "mdacli.libcli.convert_analysis_parameters", false]], "convert_str_time() (in module mdacli.utils)": [[6, "mdacli.utils.convert_str_time", false]], "create_cli() (in module mdacli.libcli)": [[3, "mdacli.libcli.create_cli", false]], "create_universe() (in module mdacli.libcli)": [[3, "mdacli.libcli.create_universe", false]], "debug() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.debug", false]], "emphasise (class in mdacli.colors)": [[2, "mdacli.colors.Emphasise", false]], "emphasise() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.emphasise", false]], "error() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.error", false]], "find_classes_in_modules() (in module mdacli.libcli)": [[3, "mdacli.libcli.find_classes_in_modules", false]], "find_cls_members() (in module mdacli.libcli)": [[3, "mdacli.libcli.find_cls_members", false]], "get_1d_arrays() (in module mdacli.save)": [[5, "mdacli.save.get_1D_arrays", false]], "get_cli_input() (in module mdacli.save)": [[5, "mdacli.save.get_cli_input", false]], "gray (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.gray", false]], "green (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.green", false]], "header() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.header", false]], "info() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.info", false]], "init_base_argparse() (in module mdacli.libcli)": [[3, "mdacli.libcli.init_base_argparse", false]], "is_1d_array() (in module mdacli.save)": [[5, "mdacli.save.is_1d_array", false]], "is_2d_array() (in module mdacli.save)": [[5, "mdacli.save.is_2d_array", false]], "is_3d_array() (in module mdacli.save)": [[5, "mdacli.save.is_3d_array", false]], "is_dimension_array() (in module mdacli.save)": [[5, "mdacli.save.is_dimension_array", false]], "is_higher_dimension_array() (in module mdacli.save)": [[5, "mdacli.save.is_higher_dimension_array", false]], "is_serializable() (in module mdacli.save)": [[5, "mdacli.save.is_serializable", false]], "kwargsdict (class in mdacli.libcli)": [[3, "mdacli.libcli.KwargsDict", false]], "mdacli.cli": [[1, "module-mdacli.cli", false]], "mdacli.colors": [[2, "module-mdacli.colors", false]], "mdacli.libcli": [[3, "module-mdacli.libcli", false]], "mdacli.logger": [[4, "module-mdacli.logger", false]], "mdacli.save": [[5, "module-mdacli.save", false]], "mdacli.utils": [[6, "module-mdacli.utils", false]], "module": [[1, "module-mdacli.cli", false], [2, "module-mdacli.colors", false], [3, "module-mdacli.libcli", false], [4, "module-mdacli.logger", false], [5, "module-mdacli.save", false], [6, "module-mdacli.utils", false]], "ok() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.ok", false]], "parse_callable_signature() (in module mdacli.utils)": [[6, "mdacli.utils.parse_callable_signature", false]], "parse_docs() (in module mdacli.utils)": [[6, "mdacli.utils.parse_docs", false]], "pink (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.pink", false]], "red (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.red", false]], "remove_files() (in module mdacli.save)": [[5, "mdacli.save.remove_files", false]], "return_with_remove() (in module mdacli.save)": [[5, "mdacli.save.return_with_remove", false]], "run_analysis() (in module mdacli.libcli)": [[3, "mdacli.libcli.run_analysis", false]], "save() (in module mdacli.save)": [[5, "mdacli.save.save", false]], "save_1d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_1D_arrays", false]], "save_2d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_2D_arrays", false]], "save_3d_array_to_2d_csv() (in module mdacli.save)": [[5, "mdacli.save.save_3D_array_to_2D_csv", false]], "save_3d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_3D_arrays", false]], "save_files_to_zip() (in module mdacli.save)": [[5, "mdacli.save.save_files_to_zip", false]], "save_higher_dim_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_higher_dim_arrays", false]], "save_json_serializables() (in module mdacli.save)": [[5, "mdacli.save.save_json_serializables", false]], "save_result_array() (in module mdacli.save)": [[5, "mdacli.save.save_result_array", false]], "save_results_object() (in module mdacli.save)": [[5, "mdacli.save.save_Results_object", false]], "save_to_json() (in module mdacli.save)": [[5, "mdacli.save.save_to_json", false]], "savetxt_w_command() (in module mdacli.save)": [[5, "mdacli.save.savetxt_w_command", false]], "setup_clients() (in module mdacli.libcli)": [[3, "mdacli.libcli.setup_clients", false]], "setup_logging() (in module mdacli.logger)": [[4, "mdacli.logger.setup_logging", false]], "split_argparse_into_groups() (in module mdacli.libcli)": [[3, "mdacli.libcli.split_argparse_into_groups", false]], "split_time_unit() (in module mdacli.utils)": [[6, "mdacli.utils.split_time_unit", false]], "stack_1d_arrays_list() (in module mdacli.save)": [[5, "mdacli.save.stack_1d_arrays_list", false]], "try_to_squeeze_me() (in module mdacli.save)": [[5, "mdacli.save.try_to_squeeze_me", false]], "turquoise (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.turquoise", false]], "underline (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.underline", false]], "warning() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.warning", false]], "yellow (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.yellow", false]]}, "objects": {"mdacli": [[1, 0, 0, "-", "cli"], [2, 0, 0, "-", "colors"], [3, 0, 0, "-", "libcli"], [4, 0, 0, "-", "logger"], [5, 0, 0, "-", "save"], [6, 0, 0, "-", "utils"]], "mdacli.cli": [[1, 1, 1, "", "cli"]], "mdacli.colors": [[2, 2, 1, "", "Emphasise"]], "mdacli.colors.Emphasise": [[2, 3, 1, "", "blue"], [2, 3, 1, "", "bold"], [2, 4, 1, "", "debug"], [2, 4, 1, "", "emphasise"], [2, 4, 1, "", "error"], [2, 3, 1, "", "gray"], [2, 3, 1, "", "green"], [2, 4, 1, "", "header"], [2, 4, 1, "", "info"], [2, 4, 1, "", "ok"], [2, 3, 1, "", "pink"], [2, 3, 1, "", "red"], [2, 3, 1, "", "turquoise"], [2, 3, 1, "", "underline"], [2, 4, 1, "", "warning"], [2, 3, 1, "", "yellow"]], "mdacli.libcli": [[3, 2, 1, "", "KwargsDict"], [3, 1, 1, "", "add_cli_universe"], [3, 1, 1, "", "add_output_group"], [3, 1, 1, "", "add_run_group"], [3, 1, 1, "", "convert_analysis_parameters"], [3, 1, 1, "", "create_cli"], [3, 1, 1, "", "create_universe"], [3, 1, 1, "", "find_classes_in_modules"], [3, 1, 1, "", "find_cls_members"], [3, 1, 1, "", "init_base_argparse"], [3, 1, 1, "", "run_analysis"], [3, 1, 1, "", "setup_clients"], [3, 1, 1, "", "split_argparse_into_groups"]], "mdacli.logger": [[4, 1, 1, "", "check_suffix"], [4, 1, 1, "", "setup_logging"]], "mdacli.save": [[5, 1, 1, "", "get_1D_arrays"], [5, 1, 1, "", "get_cli_input"], [5, 1, 1, "", "is_1d_array"], [5, 1, 1, "", "is_2d_array"], [5, 1, 1, "", "is_3d_array"], [5, 1, 1, "", "is_dimension_array"], [5, 1, 1, "", "is_higher_dimension_array"], [5, 1, 1, "", "is_serializable"], [5, 1, 1, "", "remove_files"], [5, 1, 1, "", "return_with_remove"], [5, 1, 1, "", "save"], [5, 1, 1, "", "save_1D_arrays"], [5, 1, 1, "", "save_2D_arrays"], [5, 1, 1, "", "save_3D_array_to_2D_csv"], [5, 1, 1, "", "save_3D_arrays"], [5, 1, 1, "", "save_Results_object"], [5, 1, 1, "", "save_files_to_zip"], [5, 1, 1, "", "save_higher_dim_arrays"], [5, 1, 1, "", "save_json_serializables"], [5, 1, 1, "", "save_result_array"], [5, 1, 1, "", "save_to_json"], [5, 1, 1, "", "savetxt_w_command"], [5, 1, 1, "", "stack_1d_arrays_list"], [5, 1, 1, "", "try_to_squeeze_me"]], "mdacli.utils": [[6, 1, 1, "", "convert_str_time"], [6, 1, 1, "", "parse_callable_signature"], [6, 1, 1, "", "parse_docs"], [6, 1, 1, "", "split_time_unit"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "terms": {"": [3, 6, 9, 12, 14], "0": 3, "01": 9, "1": [2, 3, 5], "109": 8, "114": 8, "139825847530112": 1, "14deb97bef6df9bc6553": 2, "1900": 9, "1d": [5, 12], "1darrai": 5, "1m": 2, "2": [5, 6], "2d": [5, 12], "2darr": 5, "2nd": 14, "3": [3, 5], "30": 4, "31519997": 3, "3d": 5, "3darr": 5, "3rd": 14, "4": [5, 14], "4m": 2, "6": 3, "65": 8, "68": 8, "70": 8, "75": 8, "78": 8, "80": 8, "81": 8, "82": 8, "83": 8, "85": 8, "86": 8, "88": 8, "90": 3, "90m": 2, "91m": 2, "92m": 2, "93m": 2, "94m": 2, "95m": 2, "96m": 2, "A": [0, 3, 4, 5, 6, 10, 12, 13, 14], "For": [4, 9, 10, 13, 14], "If": [3, 4, 5, 6, 9, 11, 12], "It": 9, "Not": 9, "One": 6, "Or": 11, "That": 9, "The": [0, 1, 2, 3, 5, 6, 9, 12, 14], "These": 9, "To": [10, 11, 13, 14], "With": 12, "__all__": 1, "__authors__": 8, "__doc__": 1, "__init__": 6, "__version__": 1, "about": [5, 10, 13, 14], "absolut": 3, "accept": 9, "accor": 5, "accord": 3, "accordingli": 8, "account": 9, "achiev": 14, "across": [10, 13], "action": [8, 9], "activ": 11, "actual": [3, 12, 14], "ad": [3, 4, 6, 8, 12], "add": [3, 4, 5, 8], "add_argu": 8, "add_cli_univers": 3, "add_output_group": 3, "add_run_group": 3, "addit": [5, 9, 14], "adjust": 12, "advanc": 0, "after": [3, 9, 14], "align": [10, 13], "aligntraj": [10, 13], "all": [3, 5, 9, 12, 14], "allow": 8, "along": 5, "alreadi": [6, 9, 11], "also": [3, 9, 11, 12, 14], "altern": 3, "alwai": 9, "an": [3, 6, 9, 10, 12, 13, 14], "analysi": [1, 3, 5, 8, 10, 12, 13, 14], "analysis_cal": 3, "analysis_class_pars": 3, "analysis_paramet": 3, "analysisbas": [1, 3, 12], "analysisfromfunct": 1, "analyz": 12, "anaylsi": 1, "anaylysi": 3, "angl": [3, 10, 13], "ani": [3, 6, 9, 11, 12], "anlysi": 3, "ap": 3, "appear": 9, "appli": [5, 9, 12], "ar": [3, 4, 5, 6, 9, 10, 11, 12, 13, 14], "archiv": 5, "arg": 8, "arg_grouped_dict": 3, "argpars": [3, 10, 12, 13], "argument": [3, 8, 12], "argumentpars": 3, "argumentspars": 3, "around": 12, "arr": 5, "arr_nam": 5, "arrai": [5, 12, 14], "ask": 14, "assert": 5, "assum": 6, "atom": [3, 10, 13, 14], "atom_styl": 3, "atomgroup": [3, 8, 10, 13, 14], "attempt": 3, "attract": 12, "attribut": [2, 5], "author": 9, "automat": [11, 12], "avail": [2, 3, 14], "averag": [10, 13], "averagestructur": [10, 13], "avoid": 9, "b": 9, "banner": 8, "bare": 14, "base": [1, 3, 5, 6, 8, 9, 10, 12, 13], "base_class": 1, "basic": [3, 10, 13], "bcolor": 2, "becaus": [3, 9], "beckstein": 7, "befor": 9, "begin": 3, "bellow": 9, "belong": [1, 3], "between": [10, 13, 14], "blue": 2, "bold": 2, "bond": 3, "bool": [1, 3, 5], "boolean": 8, "both": 12, "box": 8, "build": [1, 9, 12], "bullet": 9, "bump2vers": 8, "bumpvers": 8, "bunch": 14, "c": [7, 9, 11], "calcul": [10, 13, 14], "callabl": 6, "callable_obj": 6, "can": [3, 6, 9, 11, 12, 14], "canon": 8, "case": 9, "categori": 3, "cd": 9, "cell": 3, "certain": [3, 5], "certifi": 9, "cfg": 8, "chain": 3, "challeng": 12, "chang": [3, 8, 14], "charg": 3, "charmm": 3, "check": [4, 5, 8], "check_suffix": 4, "checkout": 9, "choic": [3, 8], "ci": [8, 9], "cl": [1, 3], "class": [1, 2, 3, 6, 8, 10, 12, 13, 14], "classifi": 8, "cleanup": 8, "clever": 12, "cli": [0, 1, 6, 8, 10, 12, 13], "cli_pars": 3, "client": [3, 14], "clone": 11, "close": [10, 13], "closecontactgnmanalysi": [10, 13], "code": [1, 9, 12], "codebas": 12, "codecov": 8, "color": 0, "column": 14, "com": [2, 3, 6, 9, 11], "combin": [6, 12], "command": [0, 1, 3, 5, 9, 12, 14], "commit": 9, "commun": 9, "complet": 8, "complex": 14, "compon": [10, 13], "compress": 5, "comput": [10, 13], "conda": [8, 9], "conflict": 9, "const": 3, "contact": [1, 10, 11, 13], "contain": [1, 3, 5, 6, 12, 14], "continu": 9, "contribut": [8, 10, 13], "contributor": 9, "conveni": 6, "convert": [3, 6, 8], "convert_analysis_paramet": 3, "convert_str_tim": 6, "coordin": [3, 10, 13], "copi": 12, "core": [3, 12], "correct": [3, 8, 9], "correctli": 9, "correspond": [5, 14], "could": [2, 3, 6, 12], "crd": 3, "creat": [1, 3, 4, 5, 12], "create_cli": [3, 8], "create_univers": 3, "creation": [3, 6, 8], "csv": [5, 12, 14], "current": [10, 13, 14], "custom": 3, "customis": 3, "dai": 12, "danger": 2, "data": [3, 5, 12, 14], "dcd": 3, "ddict": 5, "debug": [2, 3, 4, 8, 14], "decor": 2, "decorated_messag": 2, "default": [3, 5, 14], "defin": [3, 5], "degre": 3, "densiti": [10, 13], "densityanalysi": [10, 13], "dep": [9, 11], "depend": [8, 11], "deploi": 8, "deploy": 8, "desc": 6, "describ": 9, "descript": [1, 3, 6, 8, 10, 13], "design": 3, "desir": 2, "dest": 3, "detail": [4, 6, 14], "detect": [8, 12], "develop": [0, 10, 11, 12, 13], "dict": [3, 5, 6], "dictionari": [3, 5, 6, 12], "did": 9, "dielectricconst": [10, 13], "dihedr": [1, 8, 10, 13], "dim": 5, "dimens": [3, 5, 8], "dimension": [5, 12, 14], "dimes": 3, "dipol": [10, 13], "direct": 12, "directli": [5, 11, 14], "directori": 14, "disabl": 8, "disk": 5, "displac": [10, 13], "displai": 4, "distanc": [10, 13], "distancematrix": [10, 13], "distribut": [10, 13, 14], "divid": 3, "do": [8, 9], "doc": [3, 8, 9], "docstr": [6, 8, 12], "document": [8, 9, 10, 13, 14], "doe": [0, 3, 4, 6], "don": [9, 11], "done": 3, "doubl": 5, "doubt": 11, "downstream": 12, "dt": 6, "dump": [12, 14], "e": [3, 4, 9, 12, 14], "each": [3, 5, 10, 12, 13, 14], "earli": [9, 10, 13], "easi": 9, "easier": 12, "effect": 3, "effort": 12, "eg": 3, "einstein": [10, 13], "einsteinmsd": [10, 13], "either": [3, 12], "element": 3, "els": [3, 5], "emphais": 2, "emphasis": 2, "empti": 3, "emul": 14, "encapsul": 9, "end": [3, 4], "engag": 9, "environ": [4, 9, 11], "error": [2, 4], "especi": 9, "etc": [2, 14], "even": 14, "everi": 3, "everyth": [5, 11], "evolv": 12, "exactli": 9, "exampl": [1, 2, 4, 9, 14], "execut": [3, 5], "exist": [3, 4, 12], "expect": [3, 4], "experi": 12, "expert": 11, "explain": [9, 14], "explanatori": 9, "extend": [4, 6], "extens": [3, 5], "extra_list": 5, "extract": 6, "f": [1, 12, 14], "face": 12, "fail": [8, 9], "fals": [1, 3], "feedback": 9, "fetch": 9, "ff": 9, "file": [3, 4, 5, 8, 9, 10, 12, 13, 14], "filenam": 4, "filesuffix": [4, 5], "fill": 3, "final": 9, "find": 3, "find_classes_in_modul": 3, "find_cls_memb": 3, "finish": 9, "first": [9, 11], "fix": 8, "flag": [3, 9, 12, 14], "flexibl": 8, "float": [3, 6], "fly": 12, "fname": 5, "follow": [3, 6, 9, 10, 13], "fomat": 5, "forg": [9, 11], "form": 9, "format": [3, 6], "found": [3, 6], "fprefix": 5, "frame": [3, 6, 8, 10, 12, 13], "framework": 12, "friend": 9, "from": [0, 1, 2, 3, 4, 5, 6, 8, 9, 11, 12, 14], "fsuffix": 5, "function": [0, 1, 4, 5, 6, 8, 9, 10, 13, 14], "funtion": 3, "g": 3, "g1": 14, "g2": 14, "gener": [3, 8, 12], "get": 5, "get_1d_arrai": 5, "get_cli_input": 5, "gist": 2, "git": 9, "github": [2, 7, 8, 9, 11], "give": 9, "given": [1, 3, 4, 6, 10, 13], "gnm": [10, 13], "gnmanalysi": [10, 13], "go": 9, "goal": 0, "goe": 9, "good": 9, "got": 5, "grai": 2, "great": 2, "green": 2, "gro": 3, "gromac": [3, 12, 14], "grorup": 3, "group": [3, 10, 13, 14], "guess": 3, "guid": 9, "guidelin": 9, "h": [10, 13, 14], "ha": [3, 5, 6], "handl": 8, "happen": [6, 14], "have": [9, 11, 14], "header": [2, 5, 14], "helan": [10, 13], "helix": [10, 13], "help": [3, 8, 10, 12, 13, 14], "helper": 6, "henrik": 7, "here": 9, "high": [0, 12], "higher": [5, 12, 14], "hole": [10, 13], "holeanalysi": [10, 13], "hopefulli": 9, "how": [3, 9, 12, 14], "howev": [9, 12], "http": [2, 3, 6, 8, 9, 11], "hydrogenbondanalysi": 1, "i": [1, 2, 3, 4, 5, 6, 9, 10, 11, 12, 13, 14], "id": 1, "ignor": [1, 3, 5, 9], "ignore_warn": [1, 3], "implement": 9, "import": [1, 3, 9], "improv": 8, "includ": 3, "incompat": 9, "indent": 5, "indexerror": [3, 6], "individu": [3, 9], "ine": 3, "info": [2, 4, 5], "inform": [3, 6, 10, 13, 14], "init_base_argpars": 3, "initi": [8, 12], "initil": 3, "inludc": 4, "inplac": 3, "input": [3, 5, 6], "insid": [9, 12], "inspect": [6, 12], "inspir": 12, "instal": [8, 10, 13, 14], "instanc": [3, 4, 5], "instead": 0, "instruct": [8, 14], "int": [4, 6], "integ": [6, 8], "integr": [8, 9], "interact": 9, "interfac": [0, 1, 3, 12], "interface_nam": 3, "intermolecular": [10, 13], "intern": 0, "interpret": 9, "interrdf": [10, 13, 14], "interrdf_": 1, "interrdf_count_bins_rdf": 14, "introduc": 8, "is_1d_arrai": 5, "is_2d_arrai": 5, "is_3d_arrai": 5, "is_dimension_arrai": 5, "is_higher_dimension_arrai": 5, "is_serializ": 5, "isort": 8, "issu": [4, 9, 11], "item": 5, "iter": 3, "its": [6, 12, 14], "itself": 12, "janin": [10, 13], "jdict": 5, "joao": 7, "json": [3, 5, 12, 14], "json_dict": 5, "jsonarg": 5, "just": [11, 12], "j\u00e4ger": 7, "kei": [3, 5, 6], "keyword": 3, "klass": 6, "known": 12, "kwarg": 5, "kwargsdict": 3, "lab": 12, "lammp": 3, "last": 9, "later": 11, "least": 12, "length": [3, 5], "level": [0, 4, 8], "libcli": [3, 8], "librari": 12, "like": [5, 9], "lili": 7, "limit": [8, 12], "line": [0, 1, 3, 5, 6, 12, 14], "linear": [10, 13], "lineardens": [10, 13], "link": 8, "lint": 9, "list": [1, 3, 5, 8, 9, 14], "list_1d": 5, "load": 3, "local": 9, "locat": 12, "loch": 7, "log": [0, 3, 14], "log_obj": 4, "logfil": [3, 4, 14], "logger": [4, 8], "logic": [3, 8], "logobj": 4, "long": 8, "loop": 12, "lowercas": 8, "lzabil": 6, "m": [1, 7, 9], "machin": 9, "maco": 8, "madcli": 9, "mai": [3, 9], "maico": 12, "main": [3, 6], "make": [8, 9, 12], "manag": 5, "mandatori": 3, "mandatory_analysis_paramet": 3, "mani": 12, "manual": 8, "map": 5, "mass": 3, "matrix": 8, "md": [10, 13], "mda": [8, 10, 12, 13, 14], "mdacli": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14], "mdacli_result": 5, "mdanalysi": [1, 3, 5, 8, 9, 11, 12, 14], "mean": [10, 13], "member": 3, "merg": 9, "messag": [2, 4, 9, 10, 13], "metavar": 3, "method": [6, 9], "might": 0, "min_ndim": 5, "mock": 1, "mod": 3, "mode": 3, "modul": [1, 3, 8, 14], "module_list": 1, "module_nam": 3, "moment": [10, 13], "more": [8, 10, 12, 13, 14], "most": 9, "move": 8, "multidimension": 5, "must": 3, "my": [2, 9], "myfork": 9, "namd": 3, "name": [1, 3, 4, 5, 6, 8, 9, 10, 13, 14], "namespac": 3, "narg": 3, "ndarrai": [3, 5], "ndim": 5, "need": [0, 3, 8, 9], "new": [3, 8, 12], "next": 9, "nice": 9, "no_entry_sign": 9, "non": 5, "none": [1, 3, 4, 5, 8], "nor": 3, "note": [3, 5], "now": 9, "np": [3, 5], "nt": 8, "num": 5, "number": [5, 6, 8, 14], "numpi": [3, 5], "numpydocstr": 6, "o": 14, "object": [3, 5, 6, 12], "observ": [10, 13], "ok": 2, "oliv": 7, "ommit": 1, "onc": 9, "one": [3, 5], "onli": [0, 3, 4, 9, 10, 13], "onlin": [9, 14], "open": [9, 14], "oper": 5, "option": [3, 5, 8, 14], "option_str": 3, "optional_analysis_paramet": 3, "order": 3, "org": 8, "organ": 5, "origin": 5, "other": 14, "our": [9, 12], "out_extra": 5, "out_list": 5, "output": [3, 14], "output_directori": 3, "output_paramet": 3, "output_prefix": 3, "overview": [10, 13], "ow": 14, "own": [9, 14], "oxygen": 14, "p": 6, "packag": [8, 9], "page": [0, 8, 10, 13, 14], "pair": [10, 13], "pairwis": [10, 13], "paramet": [1, 2, 3, 4, 5, 6, 8, 12, 14], "parent": [3, 12], "pars": [3, 6, 8], "parsabl": 8, "parse_callable_signatur": 6, "parse_doc": 6, "parser": [3, 6, 12], "partial": 3, "pass": [3, 9], "path": 4, "pca": [10, 13], "pdb": 3, "peopl": 12, "per": 3, "perform": [3, 9, 10, 13], "permiss": 8, "persistencelength": 1, "phase": 9, "philip": 7, "pink": 2, "pip": 9, "pipelin": 9, "pkg": 3, "place": 9, "pleas": [9, 11], "pluge": 11, "point": 3, "popul": 3, "posit": 8, "possibl": 3, "possibli": 9, "potenti": 2, "power": 9, "pr": 9, "pre": 14, "prefix": [5, 14], "present": [3, 6, 9], "previou": 9, "princip": [10, 13], "print": [2, 3], "pro": 9, "probabl": [3, 4], "problem": 12, "procedur": 14, "process": [3, 9, 12], "profil": [10, 13], "program": [3, 10, 13], "progress": [10, 13], "project": [10, 12, 13], "proper": 5, "protoread": 3, "provid": [3, 12, 14], "psf": 3, "pullrequest": 9, "push": 9, "py": [8, 9, 11], "py3": 8, "pyproject": 8, "python": [8, 9, 11, 12], "question": 3, "r": 6, "radial": 14, "rais": [3, 6], "ramachandran": [10, 13], "rdf": 14, "read": [3, 9], "reader": 3, "readm": 8, "real": 9, "red": 2, "reenabl": 8, "refer": [0, 3, 8, 9, 10, 13], "reference_univers": 3, "reference_universe_paramet": 3, "reflect": 9, "regex": [6, 8], "regex101": 6, "regular": 0, "regularli": 12, "rel": 3, "relat": [10, 13], "relax": 9, "releas": 8, "remov": [5, 8], "remove_fil": 5, "renam": 8, "replac": 8, "repositori": 11, "requir": [3, 6, 8, 14], "result": [0, 12, 14], "return": [2, 3, 4, 5, 6], "return_with_remov": 5, "review": 9, "right": 9, "rigid": 14, "rm": [10, 13], "rmsd": [10, 13], "rmsf": [10, 13], "root": 4, "routin": 12, "row": [5, 14], "rst": [8, 9], "run": [3, 6, 8, 10, 13, 14], "run_analsi": 8, "run_analysi": [3, 8], "run_paramet": 3, "safe": 9, "same": [3, 5, 9, 11, 12], "sampl": 14, "save": [0, 3, 8, 12, 14], "save_1d_arrai": 5, "save_2d_arrai": 5, "save_3d_arrai": 5, "save_3d_array_to_2d_csv": 5, "save_files_to_zip": 5, "save_higher_dim_arrai": 5, "save_json_serializ": 5, "save_result": 8, "save_result_arrai": 5, "save_results_object": 5, "save_to_json": 5, "savetxt_w_command": 5, "scientist": 12, "script": 12, "search": 3, "see": [2, 3, 6, 9, 14], "select": [3, 10, 12, 13, 14], "select_atom": 3, "seri": 3, "serializ": 5, "serv": 5, "set": [3, 4, 8, 9, 14], "setup": [8, 9, 11], "setup_cli": 3, "setup_log": [4, 8], "sever": 12, "shape": 3, "shortest": 5, "shortli": 9, "should": [1, 3, 9, 11], "show": 12, "signatur": 6, "similar": 14, "simpl": [10, 12, 13, 14], "simplifi": 8, "simul": 12, "sinc": [3, 9, 12], "singl": [3, 5, 8], "skip_mod": 1, "skip_modul": 1, "slightli": 11, "smile": 9, "smile_cat": 9, "so": [6, 9, 11, 12, 14], "solv": 12, "some": [9, 12, 14], "sometim": 12, "sort_kei": 5, "sourc": [1, 2, 3, 4, 5, 6], "spc": 14, "special": 3, "specif": [0, 9], "specifi": [4, 10, 13], "split": [3, 5, 6], "split_argparse_into_group": 3, "split_time_unit": 6, "squar": [10, 13], "squeez": 5, "stack": 5, "stack_1d_arrays_list": 5, "stackoverflow": 3, "stage": [10, 13], "stai": 12, "start": [3, 6, 8, 12], "static": 2, "step": [3, 6, 9], "stop": [3, 8], "storage_dict": 6, "store": [3, 5, 12, 14], "str": [1, 2, 3, 4, 5, 6], "stream": 3, "strict": 6, "string": [1, 2, 3, 5, 6, 14], "structur": [10, 12, 13], "student": 12, "style": [2, 8, 9], "sub": 3, "sub_pars": 3, "subclass": 3, "subdictinari": 6, "submit": 9, "subpars": 3, "subset": 5, "subtitl": 9, "suffix": [3, 4], "suitabl": 3, "summari": 6, "suppli": 3, "support": [0, 8, 10, 13], "syntax": 12, "t": [9, 11], "tabl": [3, 5], "taken": [2, 5], "task": 9, "taurenmd": 12, "teixeira": 7, "term": 3, "termin": 14, "test": 8, "thei": [5, 12], "them": [9, 12], "therefor": 12, "thezip": 5, "thi": [1, 2, 3, 6, 10, 12, 13, 14], "thread": 8, "through": [10, 12, 13], "time": [3, 6, 8, 9], "titl": [3, 9], "togeth": [5, 11, 14], "toml": 8, "tool": [10, 11, 13], "top": 11, "toplevel": 1, "topol": 14, "topolgi": 14, "topologi": [3, 12], "topology_format": 3, "topologyreaderbas": 3, "tox": 8, "tox_": 9, "tpr": 14, "traj": 14, "trajectori": [3, 8, 10, 12, 13, 14], "trajectory_format": 3, "translat": 8, "trr": [3, 14], "true": [1, 5], "try": 5, "try_to_squeeze_m": 5, "tupl": 6, "turquois": 2, "tuvokki": 2, "twice": 9, "two": 14, "txt": 4, "type": [3, 5, 6, 8, 12], "typo": 8, "u": [9, 11], "under": 9, "underlin": 2, "unit": [3, 6], "univers": [3, 12], "up": [1, 3, 9, 12], "updat": [8, 11], "upgrad": 11, "upload": 8, "upstream": 9, "url": 8, "us": [0, 3, 6, 8, 9, 10, 11, 12, 13, 14], "usag": 0, "user": [0, 12], "usernam": 9, "util": 0, "v": 14, "v2": 9, "valu": [5, 6, 8], "valueerror": [3, 6], "variabl": [2, 12], "vebos": 3, "vector": 3, "verbos": [3, 14], "veri": [0, 9, 12], "verifi": 9, "version": [1, 3, 9], "vertic": 5, "via": 9, "volumetr": [10, 13], "vx": 9, "wai": [3, 9, 12], "wang": 7, "want": [0, 11], "warn": [1, 2, 3, 4, 14], "water": 14, "waterbridgeanalysi": 1, "we": [5, 9, 12], "webpag": 7, "welcom": [9, 10, 13], "well": 9, "were": 12, "what": 3, "when": [1, 6, 9], "where": [3, 5, 6], "which": [1, 3, 5, 6, 11, 12], "whole": 9, "window": 8, "wish": 9, "within": 12, "without": [5, 12], "work": [3, 10, 13], "workflow": 9, "wrapper": 12, "write": 12, "x": [5, 6, 9], "x1b": 2, "xdarr": 5, "xplor": 3, "xtc": 3, "xyz": 3, "yai": 2, "yellow": 2, "yet": 6, "you": [9, 11, 14], "your": [10, 11, 13, 14], "zip": [5, 12, 14], "zipit": 5, "zipnam": 5, "\u03c7_1": [10, 13], "\u03c7_2": [10, 13], "\u03c8": [10, 13], "\u03d5": [10, 13]}, "titles": ["API library documentation", "High-Level API", "Coloring", "Support functions for CLI", "Logging", "Results Saving", "Utilities", "Authors", "Changelog", "Contributing", "MDAnalysis command line interface", "Installation", "Philosophy and approach", "MDAnalysis command line interface", "Usage"], "titleterms": {"0": 8, "01": 8, "02": 8, "03": 8, "04": 8, "06": 8, "07": 8, "08": 8, "09": 8, "1": 8, "10": 8, "11": 8, "12": 8, "13": 8, "14": 8, "15": 8, "16": 8, "17": 8, "18": 8, "19": 8, "2": 8, "20": 8, "2021": 8, "2022": 8, "2023": 8, "2024": 8, "21": 8, "22": 8, "23": 8, "24": 8, "25": 8, "26": 8, "27": 8, "28": 8, "29": 8, "3": 8, "30": 8, "31": 8, "32": 8, "4": 8, "5": 8, "6": 8, "7": 8, "8": 8, "9": 8, "add": 9, "api": [0, 1], "approach": 12, "author": 7, "avail": [10, 13], "branch": 9, "chang": 9, "changelog": [8, 9], "cli": 3, "clone": 9, "color": 2, "command": [10, 13], "comput": 9, "conda": 11, "contribut": 9, "creat": 9, "develop": 9, "document": 0, "fork": 9, "function": 3, "high": 1, "instal": [9, 11], "interfac": [10, 13], "level": 1, "librari": 0, "line": [10, 13], "log": 4, "main": 9, "mdanalysi": [10, 13], "modul": [10, 13], "new": 9, "philosophi": 12, "pip": 11, "project": 9, "pull": 9, "remot": 9, "repositori": 9, "request": 9, "result": 5, "run": 9, "save": 5, "start": 9, "support": 3, "test": 9, "thi": 9, "tox": 9, "updat": 9, "usag": 14, "util": 6, "v0": 8, "your": 9}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API library documentation": [[0, "api-library-documentation"]], "Add your fork as remote": [[9, "add-your-fork-as-remote"]], "Authors": [[7, "authors"]], "Available modules": [[10, "available-modules"], [13, "available-modules"]], "Changelog": [[8, "changelog"]], "Clone the main project to your computer": [[9, "clone-the-main-project-to-your-computer"]], "Coloring": [[2, "module-mdacli.colors"]], "Contributing": [[9, "contributing"]], "Create a new branch and start developing": [[9, "create-a-new-branch-and-start-developing"]], "Fork this repository": [[9, "fork-this-repository"]], "High-Level API": [[1, "module-mdacli.cli"]], "Install for developers": [[9, "install-for-developers"]], "Installation": [[11, "installation"]], "Logging": [[4, "module-mdacli.logger"]], "MDAnalysis command line interface": [[10, "mdanalysis-command-line-interface"], [13, "mdanalysis-command-line-interface"]], "Philosophy and approach": [[12, "philosophy-and-approach"]], "Pull Request": [[9, "pull-request"]], "Pull Request your changes": [[9, "pull-request-your-changes"]], "Results Saving": [[5, "module-mdacli.save"]], "Running tests with tox": [[9, "running-tests-with-tox"]], "Support functions for CLI": [[3, "module-mdacli.libcli"]], "Update CHANGELOG": [[9, "update-changelog"]], "Usage": [[14, "usage"]], "Utilities": [[6, "module-mdacli.utils"]], "conda": [[11, "conda"]], "pip": [[11, "pip"]], "v0.1.0 (2021-11-18)": [[8, "v0-1-0-2021-11-18"]], "v0.1.1 (2021-11-18)": [[8, "v0-1-1-2021-11-18"]], "v0.1.10 (2022-01-18)": [[8, "v0-1-10-2022-01-18"]], "v0.1.11 (2022-01-19)": [[8, "v0-1-11-2022-01-19"]], "v0.1.12 (2022-01-19)": [[8, "v0-1-12-2022-01-19"]], "v0.1.13 (2022-02-16)": [[8, "v0-1-13-2022-02-16"]], "v0.1.14 (2022-02-17)": [[8, "v0-1-14-2022-02-17"]], "v0.1.15 (2022-02-25)": [[8, "v0-1-15-2022-02-25"]], "v0.1.16 (2022-02-25)": [[8, "v0-1-16-2022-02-25"]], "v0.1.17 (2022-04-07)": [[8, "v0-1-17-2022-04-07"]], "v0.1.18 (2022-04-12)": [[8, "v0-1-18-2022-04-12"]], "v0.1.19 (2022-04-12)": [[8, "v0-1-19-2022-04-12"]], "v0.1.2 (2021-11-18)": [[8, "v0-1-2-2021-11-18"]], "v0.1.20 (2022-04-13)": [[8, "v0-1-20-2022-04-13"]], "v0.1.21 (2022-04-22)": [[8, "v0-1-21-2022-04-22"]], "v0.1.22 (2023-01-27)": [[8, "v0-1-22-2023-01-27"]], "v0.1.23 (2023-01-27)": [[8, "v0-1-23-2023-01-27"]], "v0.1.24 (2023-01-27)": [[8, "v0-1-24-2023-01-27"]], "v0.1.25 (2023-02-21)": [[8, "v0-1-25-2023-02-21"]], "v0.1.26 (2023-06-27)": [[8, "v0-1-26-2023-06-27"]], "v0.1.27 (2023-08-25)": [[8, "v0-1-27-2023-08-25"]], "v0.1.28 (2023-09-29)": [[8, "v0-1-28-2023-09-29"]], "v0.1.29 (2024-03-21)": [[8, "v0-1-29-2024-03-21"]], "v0.1.3 (2021-11-24)": [[8, "v0-1-3-2021-11-24"]], "v0.1.30 (2024-04-03)": [[8, "v0-1-30-2024-04-03"]], "v0.1.31 (2024-07-08)": [[8, "v0-1-31-2024-07-08"]], "v0.1.4 (2021-11-24)": [[8, "v0-1-4-2021-11-24"]], "v0.1.5 (2021-12-01)": [[8, "v0-1-5-2021-12-01"]], "v0.1.6 (2021-12-01)": [[8, "v0-1-6-2021-12-01"]], "v0.1.7 (2021-12-18)": [[8, "v0-1-7-2021-12-18"]], "v0.1.8 (2022-01-16)": [[8, "v0-1-8-2022-01-16"]], "v0.1.9 (2022-01-16)": [[8, "v0-1-9-2022-01-16"]]}, "docnames": ["api", "api/cli", "api/colors", "api/libcli", "api/logger", "api/save", "api/utils", "authors", "changelog", "contributing", "index", "installation", "philosophy", "readme", "usage"], "envversion": {"sphinx": 61, "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.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "api/cli.rst", "api/colors.rst", "api/libcli.rst", "api/logger.rst", "api/save.rst", "api/utils.rst", "authors.rst", "changelog.rst", "contributing.rst", "index.rst", "installation.rst", "philosophy.rst", "readme.rst", "usage.rst"], "indexentries": {"add_cli_universe() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_cli_universe", false]], "add_output_group() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_output_group", false]], "add_run_group() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_run_group", false]], "blue (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.blue", false]], "bold (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.bold", false]], "cli() (in module mdacli.cli)": [[1, "mdacli.cli.cli", false]], "convert_analysis_parameters() (in module mdacli.libcli)": [[3, "mdacli.libcli.convert_analysis_parameters", false]], "convert_str_time() (in module mdacli.utils)": [[6, "mdacli.utils.convert_str_time", false]], "create_cli() (in module mdacli.libcli)": [[3, "mdacli.libcli.create_cli", false]], "create_universe() (in module mdacli.libcli)": [[3, "mdacli.libcli.create_universe", false]], "debug() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.debug", false]], "emphasise (class in mdacli.colors)": [[2, "mdacli.colors.Emphasise", false]], "emphasise() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.emphasise", false]], "error() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.error", false]], "find_classes_in_modules() (in module mdacli.libcli)": [[3, "mdacli.libcli.find_classes_in_modules", false]], "find_cls_members() (in module mdacli.libcli)": [[3, "mdacli.libcli.find_cls_members", false]], "get_1d_arrays() (in module mdacli.save)": [[5, "mdacli.save.get_1D_arrays", false]], "get_cli_input() (in module mdacli.save)": [[5, "mdacli.save.get_cli_input", false]], "gray (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.gray", false]], "green (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.green", false]], "header() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.header", false]], "info() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.info", false]], "init_base_argparse() (in module mdacli.libcli)": [[3, "mdacli.libcli.init_base_argparse", false]], "is_1d_array() (in module mdacli.save)": [[5, "mdacli.save.is_1d_array", false]], "is_2d_array() (in module mdacli.save)": [[5, "mdacli.save.is_2d_array", false]], "is_3d_array() (in module mdacli.save)": [[5, "mdacli.save.is_3d_array", false]], "is_dimension_array() (in module mdacli.save)": [[5, "mdacli.save.is_dimension_array", false]], "is_higher_dimension_array() (in module mdacli.save)": [[5, "mdacli.save.is_higher_dimension_array", false]], "is_serializable() (in module mdacli.save)": [[5, "mdacli.save.is_serializable", false]], "kwargsdict (class in mdacli.libcli)": [[3, "mdacli.libcli.KwargsDict", false]], "mdacli.cli": [[1, "module-mdacli.cli", false]], "mdacli.colors": [[2, "module-mdacli.colors", false]], "mdacli.libcli": [[3, "module-mdacli.libcli", false]], "mdacli.logger": [[4, "module-mdacli.logger", false]], "mdacli.save": [[5, "module-mdacli.save", false]], "mdacli.utils": [[6, "module-mdacli.utils", false]], "module": [[1, "module-mdacli.cli", false], [2, "module-mdacli.colors", false], [3, "module-mdacli.libcli", false], [4, "module-mdacli.logger", false], [5, "module-mdacli.save", false], [6, "module-mdacli.utils", false]], "ok() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.ok", false]], "parse_callable_signature() (in module mdacli.utils)": [[6, "mdacli.utils.parse_callable_signature", false]], "parse_docs() (in module mdacli.utils)": [[6, "mdacli.utils.parse_docs", false]], "pink (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.pink", false]], "red (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.red", false]], "remove_files() (in module mdacli.save)": [[5, "mdacli.save.remove_files", false]], "return_with_remove() (in module mdacli.save)": [[5, "mdacli.save.return_with_remove", false]], "run_analysis() (in module mdacli.libcli)": [[3, "mdacli.libcli.run_analysis", false]], "save() (in module mdacli.save)": [[5, "mdacli.save.save", false]], "save_1d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_1D_arrays", false]], "save_2d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_2D_arrays", false]], "save_3d_array_to_2d_csv() (in module mdacli.save)": [[5, "mdacli.save.save_3D_array_to_2D_csv", false]], "save_3d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_3D_arrays", false]], "save_files_to_zip() (in module mdacli.save)": [[5, "mdacli.save.save_files_to_zip", false]], "save_higher_dim_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_higher_dim_arrays", false]], "save_json_serializables() (in module mdacli.save)": [[5, "mdacli.save.save_json_serializables", false]], "save_result_array() (in module mdacli.save)": [[5, "mdacli.save.save_result_array", false]], "save_results_object() (in module mdacli.save)": [[5, "mdacli.save.save_Results_object", false]], "save_to_json() (in module mdacli.save)": [[5, "mdacli.save.save_to_json", false]], "savetxt_w_command() (in module mdacli.save)": [[5, "mdacli.save.savetxt_w_command", false]], "setup_clients() (in module mdacli.libcli)": [[3, "mdacli.libcli.setup_clients", false]], "setup_logging() (in module mdacli.logger)": [[4, "mdacli.logger.setup_logging", false]], "split_argparse_into_groups() (in module mdacli.libcli)": [[3, "mdacli.libcli.split_argparse_into_groups", false]], "split_time_unit() (in module mdacli.utils)": [[6, "mdacli.utils.split_time_unit", false]], "stack_1d_arrays_list() (in module mdacli.save)": [[5, "mdacli.save.stack_1d_arrays_list", false]], "try_to_squeeze_me() (in module mdacli.save)": [[5, "mdacli.save.try_to_squeeze_me", false]], "turquoise (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.turquoise", false]], "underline (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.underline", false]], "warning() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.warning", false]], "yellow (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.yellow", false]]}, "objects": {"mdacli": [[1, 0, 0, "-", "cli"], [2, 0, 0, "-", "colors"], [3, 0, 0, "-", "libcli"], [4, 0, 0, "-", "logger"], [5, 0, 0, "-", "save"], [6, 0, 0, "-", "utils"]], "mdacli.cli": [[1, 1, 1, "", "cli"]], "mdacli.colors": [[2, 2, 1, "", "Emphasise"]], "mdacli.colors.Emphasise": [[2, 3, 1, "", "blue"], [2, 3, 1, "", "bold"], [2, 4, 1, "", "debug"], [2, 4, 1, "", "emphasise"], [2, 4, 1, "", "error"], [2, 3, 1, "", "gray"], [2, 3, 1, "", "green"], [2, 4, 1, "", "header"], [2, 4, 1, "", "info"], [2, 4, 1, "", "ok"], [2, 3, 1, "", "pink"], [2, 3, 1, "", "red"], [2, 3, 1, "", "turquoise"], [2, 3, 1, "", "underline"], [2, 4, 1, "", "warning"], [2, 3, 1, "", "yellow"]], "mdacli.libcli": [[3, 2, 1, "", "KwargsDict"], [3, 1, 1, "", "add_cli_universe"], [3, 1, 1, "", "add_output_group"], [3, 1, 1, "", "add_run_group"], [3, 1, 1, "", "convert_analysis_parameters"], [3, 1, 1, "", "create_cli"], [3, 1, 1, "", "create_universe"], [3, 1, 1, "", "find_classes_in_modules"], [3, 1, 1, "", "find_cls_members"], [3, 1, 1, "", "init_base_argparse"], [3, 1, 1, "", "run_analysis"], [3, 1, 1, "", "setup_clients"], [3, 1, 1, "", "split_argparse_into_groups"]], "mdacli.logger": [[4, 1, 1, "", "setup_logging"]], "mdacli.save": [[5, 1, 1, "", "get_1D_arrays"], [5, 1, 1, "", "get_cli_input"], [5, 1, 1, "", "is_1d_array"], [5, 1, 1, "", "is_2d_array"], [5, 1, 1, "", "is_3d_array"], [5, 1, 1, "", "is_dimension_array"], [5, 1, 1, "", "is_higher_dimension_array"], [5, 1, 1, "", "is_serializable"], [5, 1, 1, "", "remove_files"], [5, 1, 1, "", "return_with_remove"], [5, 1, 1, "", "save"], [5, 1, 1, "", "save_1D_arrays"], [5, 1, 1, "", "save_2D_arrays"], [5, 1, 1, "", "save_3D_array_to_2D_csv"], [5, 1, 1, "", "save_3D_arrays"], [5, 1, 1, "", "save_Results_object"], [5, 1, 1, "", "save_files_to_zip"], [5, 1, 1, "", "save_higher_dim_arrays"], [5, 1, 1, "", "save_json_serializables"], [5, 1, 1, "", "save_result_array"], [5, 1, 1, "", "save_to_json"], [5, 1, 1, "", "savetxt_w_command"], [5, 1, 1, "", "stack_1d_arrays_list"], [5, 1, 1, "", "try_to_squeeze_me"]], "mdacli.utils": [[6, 1, 1, "", "convert_str_time"], [6, 1, 1, "", "parse_callable_signature"], [6, 1, 1, "", "parse_docs"], [6, 1, 1, "", "split_time_unit"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "terms": {"": [3, 6, 9, 12, 14], "0": 3, "01": 9, "1": [2, 3, 5], "109": 8, "114": 8, "140423703360128": 1, "14deb97bef6df9bc6553": 2, "1900": 9, "1d": [5, 12], "1darrai": 5, "1m": 2, "2": [5, 6], "2d": [5, 12], "2darr": 5, "2nd": 14, "3": [3, 5], "30": 4, "31519997": 3, "3d": 5, "3darr": 5, "3rd": 14, "4": [5, 14], "4m": 2, "6": 3, "65": 8, "68": 8, "70": 8, "75": 8, "78": 8, "80": 8, "81": 8, "82": 8, "83": 8, "85": 8, "86": 8, "88": 8, "90": 3, "90m": 2, "91m": 2, "92m": 2, "93m": 2, "94m": 2, "95m": 2, "96m": 2, "A": [0, 3, 4, 5, 6, 10, 12, 13, 14], "For": [4, 9, 10, 13, 14], "If": [3, 4, 5, 6, 9, 11, 12], "It": 9, "Not": 9, "One": 6, "Or": 11, "That": 9, "The": [0, 1, 2, 3, 5, 6, 9, 12, 14], "These": 9, "To": [10, 11, 13, 14], "With": 12, "__all__": 1, "__authors__": 8, "__doc__": 1, "__init__": 6, "__version__": 1, "about": [5, 10, 13, 14], "absolut": 3, "accept": 9, "accor": 5, "accord": 3, "accordingli": 8, "account": 9, "achiev": 14, "across": [10, 13], "action": [8, 9], "activ": 11, "actual": [3, 12, 14], "ad": [3, 6, 8, 12], "add": [3, 5, 8], "add_argu": 8, "add_cli_univers": 3, "add_output_group": 3, "add_run_group": 3, "addit": [5, 9, 14], "adjust": 12, "advanc": 0, "after": [3, 9, 14], "align": [10, 13], "aligntraj": [10, 13], "all": [3, 5, 9, 12, 14], "allow": 8, "along": 5, "alreadi": [6, 9, 11], "also": [3, 9, 11, 12, 14], "altern": 3, "alwai": 9, "an": [3, 6, 9, 10, 12, 13, 14], "analysi": [1, 3, 5, 8, 10, 12, 13, 14], "analysis_cal": 3, "analysis_class_pars": 3, "analysis_paramet": 3, "analysisbas": [1, 3, 12], "analysisfromfunct": 1, "analyz": 12, "anaylsi": 1, "anaylysi": 3, "angl": [3, 10, 13], "ani": [3, 6, 9, 11, 12], "anlysi": 3, "ap": 3, "appear": 9, "appli": [5, 9, 12], "ar": [3, 4, 5, 6, 9, 10, 11, 12, 13, 14], "archiv": 5, "arg": 8, "arg_grouped_dict": 3, "argpars": [3, 10, 12, 13], "argument": [3, 8, 12], "argumentpars": 3, "argumentspars": 3, "around": 12, "arr": 5, "arr_nam": 5, "arrai": [5, 12, 14], "ask": 14, "assert": 5, "assum": 6, "atom": [3, 10, 13, 14], "atom_styl": 3, "atomgroup": [3, 8, 10, 13, 14], "attempt": 3, "attract": 12, "attribut": [2, 5], "author": 9, "automat": [11, 12], "avail": [2, 3, 14], "averag": [10, 13], "averagestructur": [10, 13], "avoid": 9, "b": 9, "banner": 8, "bare": 14, "base": [1, 3, 5, 6, 8, 9, 10, 12, 13], "base_class": 1, "basic": [3, 10, 13], "bcolor": 2, "becaus": [3, 9], "beckstein": 7, "befor": 9, "begin": 3, "bellow": 9, "belong": [1, 3], "between": [10, 13, 14], "blue": 2, "bold": 2, "bond": 3, "bool": [1, 3, 5], "boolean": 8, "both": 12, "box": 8, "build": [1, 9, 12], "bullet": 9, "bump2vers": 8, "bumpvers": 8, "bunch": 14, "c": [7, 9, 11], "calcul": [10, 13, 14], "callabl": 6, "callable_obj": 6, "can": [3, 6, 9, 11, 12, 14], "canon": 8, "case": 9, "categori": 3, "cd": 9, "cell": 3, "certain": [3, 5], "certifi": 9, "cfg": 8, "chain": 3, "challeng": 12, "chang": [3, 8, 14], "charg": 3, "charmm": 3, "check": [5, 8], "checkout": 9, "choic": [3, 8], "ci": [8, 9], "cl": [1, 3], "class": [1, 2, 3, 6, 8, 10, 12, 13, 14], "classifi": 8, "clever": 12, "cli": [0, 1, 6, 8, 10, 12, 13], "cli_pars": 3, "client": [3, 14], "clone": 11, "close": [10, 13], "closecontactgnmanalysi": [10, 13], "code": [1, 9, 12], "codebas": 12, "codecov": 8, "color": 0, "column": 14, "com": [2, 3, 6, 9, 11], "combin": [6, 12], "command": [0, 1, 3, 5, 9, 12, 14], "commit": 9, "commun": 9, "complet": 8, "complex": 14, "compon": [10, 13], "compress": 5, "comput": [10, 13], "conda": [8, 9], "conflict": 9, "const": 3, "contact": [1, 10, 11, 13], "contain": [1, 3, 5, 6, 12, 14], "continu": 9, "contribut": [8, 10, 13], "contributor": 9, "conveni": 6, "convert": [3, 6, 8], "convert_analysis_paramet": 3, "convert_str_tim": 6, "coordin": [3, 10, 13], "copi": 12, "core": [3, 12], "correct": [3, 8, 9], "correctli": 9, "correspond": [5, 14], "could": [2, 3, 6, 12], "crd": 3, "creat": [1, 3, 4, 5, 12], "create_cli": [3, 8], "create_univers": 3, "creation": [3, 6, 8], "csv": [5, 12, 14], "current": [10, 13, 14], "custom": 3, "customis": 3, "dai": 12, "danger": 2, "data": [3, 5, 12, 14], "dcd": 3, "ddict": 5, "debug": [2, 3, 4, 8, 14], "decor": 2, "decorated_messag": 2, "default": [3, 5, 14], "defin": [3, 5], "degre": 3, "densiti": [10, 13], "densityanalysi": [10, 13], "dep": [9, 11], "depend": [8, 11], "deploi": 8, "deploy": 8, "desc": 6, "describ": 9, "descript": [1, 3, 6, 8, 10, 13], "design": 3, "desir": 2, "dest": 3, "detail": [4, 6, 14], "detect": [8, 12], "develop": [0, 10, 11, 12, 13], "dict": [3, 5, 6], "dictionari": [3, 5, 6, 12], "did": 9, "dielectricconst": [10, 13], "dihedr": [1, 8, 10, 13], "dim": 5, "dimens": [3, 5, 8], "dimension": [5, 12, 14], "dimes": 3, "dipol": [10, 13], "direct": 12, "directli": [5, 11, 14], "directori": 14, "disabl": 8, "disk": 5, "displac": [10, 13], "displai": 4, "distanc": [10, 13], "distancematrix": [10, 13], "distribut": [10, 13, 14], "divid": 3, "do": [8, 9], "doc": [3, 8, 9], "docstr": [6, 8, 12], "document": [8, 9, 10, 13, 14], "doe": [0, 3, 6], "don": [9, 11], "done": 3, "doubl": 5, "doubt": 11, "downstream": 12, "dt": 6, "dump": [12, 14], "e": [3, 9, 12, 14], "each": [3, 5, 10, 12, 13, 14], "earli": [9, 10, 13], "easi": 9, "easier": 12, "effect": 3, "effort": 12, "eg": 3, "einstein": [10, 13], "einsteinmsd": [10, 13], "either": [3, 12], "element": 3, "els": [3, 5], "emphais": 2, "emphasis": 2, "empti": 3, "emul": 14, "encapsul": 9, "end": 3, "engag": 9, "environ": [4, 9, 11], "error": [2, 4], "especi": 9, "etc": [2, 14], "even": 14, "everi": 3, "everyth": [5, 11], "evolv": 12, "exactli": 9, "exampl": [1, 2, 4, 9, 14], "execut": [3, 5], "exist": [3, 12], "expect": 3, "experi": 12, "expert": 11, "explain": [9, 14], "explanatori": 9, "extend": 6, "extens": [3, 5], "extra_list": 5, "extract": 6, "f": [1, 12, 14], "face": 12, "fail": [8, 9], "fals": [1, 3], "feedback": 9, "fetch": 9, "ff": 9, "file": [3, 4, 5, 8, 9, 10, 12, 13, 14], "filenam": 4, "filesuffix": 5, "fill": 3, "final": 9, "find": 3, "find_classes_in_modul": 3, "find_cls_memb": 3, "finish": 9, "first": [9, 11], "fix": 8, "flag": [3, 9, 12, 14], "flexibl": 8, "float": [3, 6], "fly": 12, "fname": 5, "follow": [3, 6, 9, 10, 13], "fomat": 5, "forg": [9, 11], "form": 9, "format": [3, 6], "found": [3, 6], "fprefix": 5, "frame": [3, 6, 8, 10, 12, 13], "framework": 12, "friend": 9, "from": [0, 1, 2, 3, 4, 5, 6, 8, 9, 11, 12, 14], "fsuffix": 5, "function": [0, 1, 4, 5, 6, 9, 10, 13, 14], "funtion": 3, "g": 3, "g1": 14, "g2": 14, "gener": [3, 8, 12], "get": 5, "get_1d_arrai": 5, "get_cli_input": 5, "gist": 2, "git": 9, "github": [2, 7, 8, 9, 11], "give": 9, "given": [1, 3, 4, 6, 10, 13], "gnm": [10, 13], "gnmanalysi": [10, 13], "go": 9, "goal": 0, "goe": 9, "good": 9, "got": 5, "grai": 2, "great": 2, "green": 2, "gro": 3, "gromac": [3, 12, 14], "grorup": 3, "group": [3, 10, 13, 14], "guess": 3, "guid": 9, "guidelin": 9, "h": [10, 13, 14], "ha": [3, 5, 6], "handl": 8, "happen": [6, 14], "have": [9, 11, 14], "header": [2, 5, 14], "helan": [10, 13], "helix": [10, 13], "help": [3, 8, 10, 12, 13, 14], "helper": 6, "henrik": 7, "here": 9, "high": [0, 12], "higher": [5, 12, 14], "hole": [10, 13], "holeanalysi": [10, 13], "hopefulli": 9, "how": [3, 9, 12, 14], "howev": [9, 12], "http": [2, 3, 6, 8, 9, 11], "hydrogenbondanalysi": 1, "i": [1, 2, 3, 5, 6, 9, 10, 11, 12, 13, 14], "id": 1, "ignor": [1, 3, 5, 9], "ignore_warn": [1, 3], "implement": 9, "import": [1, 3, 9], "improv": 8, "includ": 3, "incompat": 9, "indent": 5, "indexerror": [3, 6], "individu": [3, 9], "ine": 3, "info": [2, 4, 5], "inform": [3, 6, 10, 13, 14], "init_base_argpars": 3, "initi": [8, 12], "initil": 3, "inludc": 4, "inplac": 3, "input": [3, 5, 6], "insid": [9, 12], "inspect": [6, 12], "inspir": 12, "instal": [8, 10, 13, 14], "instanc": [3, 4, 5], "instead": 0, "instruct": [8, 14], "int": [4, 6], "integ": [6, 8], "integr": [8, 9], "interact": 9, "interfac": [0, 1, 3, 12], "interface_nam": 3, "intermolecular": [10, 13], "intern": 0, "interpret": 9, "interrdf": [10, 13, 14], "interrdf_": 1, "interrdf_count_bins_rdf": 14, "introduc": 8, "is_1d_arrai": 5, "is_2d_arrai": 5, "is_3d_arrai": 5, "is_dimension_arrai": 5, "is_higher_dimension_arrai": 5, "is_serializ": 5, "isort": 8, "issu": [9, 11], "item": 5, "iter": 3, "its": [6, 12, 14], "itself": 12, "janin": [10, 13], "jdict": 5, "joao": 7, "json": [3, 5, 12, 14], "json_dict": 5, "jsonarg": 5, "just": [11, 12], "j\u00e4ger": 7, "kei": [3, 5, 6], "keyword": 3, "klass": 6, "known": 12, "kwarg": 5, "kwargsdict": 3, "lab": 12, "lammp": 3, "last": 9, "later": 11, "least": 12, "length": [3, 5], "level": [0, 4, 8], "libcli": [3, 8], "librari": 12, "like": [5, 9], "lili": 7, "limit": [8, 12], "line": [0, 1, 3, 5, 6, 12, 14], "linear": [10, 13], "lineardens": [10, 13], "link": 8, "lint": 9, "list": [1, 3, 5, 8, 9, 14], "list_1d": 5, "load": 3, "local": 9, "locat": 12, "loch": 7, "log": [0, 3, 14], "logfil": [3, 4, 14], "logger": 4, "logic": [3, 8], "logobj": 4, "long": 8, "loop": 12, "lowercas": 8, "lzabil": 6, "m": [1, 7, 9], "machin": 9, "maco": 8, "madcli": 9, "mai": [3, 9], "maico": 12, "main": [3, 6], "make": [8, 9, 12], "manag": 5, "mandatori": 3, "mandatory_analysis_paramet": 3, "mani": 12, "manual": 8, "map": 5, "mass": 3, "matrix": 8, "md": [10, 13], "mda": [8, 10, 12, 13, 14], "mdacli": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14], "mdacli_result": 5, "mdanalysi": [1, 3, 5, 8, 9, 11, 12, 14], "mean": [10, 13], "member": 3, "merg": 9, "messag": [2, 4, 9, 10, 13], "metavar": 3, "method": [6, 9], "might": 0, "min_ndim": 5, "mock": 1, "mod": 3, "mode": 3, "modul": [1, 3, 8, 14], "module_list": 1, "module_nam": 3, "moment": [10, 13], "more": [8, 10, 12, 13, 14], "most": 9, "move": 8, "multidimension": 5, "must": 3, "my": [2, 9], "myfork": 9, "namd": 3, "name": [1, 3, 4, 5, 6, 8, 9, 10, 13, 14], "namespac": 3, "narg": 3, "ndarrai": [3, 5], "ndim": 5, "need": [0, 3, 8, 9], "new": [3, 8, 12], "next": 9, "nice": 9, "no_entry_sign": 9, "non": 5, "none": [1, 3, 4, 5, 8], "nor": 3, "note": [3, 5], "now": 9, "np": [3, 5], "nt": 8, "num": 5, "number": [5, 6, 8, 14], "numpi": [3, 5], "numpydocstr": 6, "o": 14, "obj": 4, "object": [3, 5, 6, 12], "observ": [10, 13], "ok": 2, "oliv": 7, "ommit": 1, "onc": 9, "one": [3, 5], "onli": [0, 3, 4, 9, 10, 13], "onlin": [9, 14], "open": [9, 14], "oper": 5, "option": [3, 5, 8, 14], "option_str": 3, "optional_analysis_paramet": 3, "order": 3, "org": 8, "organ": 5, "origin": 5, "other": 14, "our": [9, 12], "out_extra": 5, "out_list": 5, "output": [3, 14], "output_directori": 3, "output_paramet": 3, "output_prefix": 3, "overview": [10, 13], "ow": 14, "own": [9, 14], "oxygen": 14, "p": 6, "packag": [8, 9], "page": [0, 8, 10, 13, 14], "pair": [10, 13], "pairwis": [10, 13], "paramet": [1, 2, 3, 4, 5, 6, 8, 12, 14], "parent": [3, 12], "pars": [3, 6, 8], "parsabl": 8, "parse_callable_signatur": 6, "parse_doc": 6, "parser": [3, 6, 12], "partial": 3, "pass": [3, 9], "pca": [10, 13], "pdb": 3, "peopl": 12, "per": 3, "perform": [3, 9, 10, 13], "permiss": 8, "persistencelength": 1, "phase": 9, "philip": 7, "pink": 2, "pip": 9, "pipelin": 9, "pkg": 3, "place": 9, "pleas": [9, 11], "pluge": 11, "point": 3, "popul": 3, "posit": 8, "possibl": 3, "possibli": 9, "potenti": 2, "power": 9, "pr": 9, "pre": 14, "prefix": [5, 14], "present": [3, 6, 9], "previou": 9, "princip": [10, 13], "print": [2, 3], "pro": 9, "probabl": 3, "problem": 12, "procedur": 14, "process": [3, 9, 12], "profil": [10, 13], "program": [3, 10, 13], "progress": [10, 13], "project": [10, 12, 13], "proper": 5, "protoread": 3, "provid": [3, 12, 14], "psf": 3, "pullrequest": 9, "push": 9, "py": [4, 8, 9, 11], "py3": 8, "pyproject": 8, "python": [8, 9, 11, 12], "question": 3, "r": 6, "radial": 14, "rais": [3, 6], "ramachandran": [10, 13], "rdf": 14, "read": [3, 9], "reader": 3, "readm": 8, "real": 9, "red": 2, "reenabl": 8, "refer": [0, 3, 8, 9, 10, 13], "reference_univers": 3, "reference_universe_paramet": 3, "reflect": 9, "regex": [6, 8], "regex101": 6, "regular": 0, "regularli": 12, "rel": 3, "relat": [10, 13], "relax": 9, "releas": 8, "remov": [5, 8], "remove_fil": 5, "renam": 8, "replac": 8, "repositori": 11, "requir": [3, 6, 8, 14], "result": [0, 12, 14], "return": [2, 3, 5, 6], "return_with_remov": 5, "review": 9, "right": 9, "rigid": 14, "rm": [10, 13], "rmsd": [10, 13], "rmsf": [10, 13], "root": 4, "routin": 12, "row": [5, 14], "rst": [8, 9], "run": [3, 6, 8, 10, 13, 14], "run_analsi": 8, "run_analysi": [3, 8], "run_paramet": 3, "safe": 9, "same": [3, 5, 9, 11, 12], "sampl": 14, "save": [0, 3, 8, 12, 14], "save_1d_arrai": 5, "save_2d_arrai": 5, "save_3d_arrai": 5, "save_3d_array_to_2d_csv": 5, "save_files_to_zip": 5, "save_higher_dim_arrai": 5, "save_json_serializ": 5, "save_result": 8, "save_result_arrai": 5, "save_results_object": 5, "save_to_json": 5, "savetxt_w_command": 5, "scientist": 12, "script": 12, "search": 3, "see": [2, 3, 6, 9, 14], "select": [3, 10, 12, 13, 14], "select_atom": 3, "seri": 3, "serializ": 5, "serv": 5, "set": [3, 4, 8, 9, 14], "setup": [8, 9, 11], "setup_cli": 3, "setup_log": [4, 8], "sever": 12, "shape": 3, "shortest": 5, "shortli": 9, "should": [1, 3, 9, 11], "show": 12, "signatur": 6, "similar": 14, "simpl": [10, 12, 13, 14], "simplifi": 8, "simul": 12, "sinc": [3, 9, 12], "singl": [3, 5, 8], "skip_mod": 1, "skip_modul": 1, "slightli": 11, "smile": 9, "smile_cat": 9, "so": [6, 9, 11, 12, 14], "solv": 12, "some": [9, 12, 14], "sometim": 12, "sort_kei": 5, "sourc": [1, 2, 3, 4, 5, 6], "spc": 14, "special": 3, "specif": [0, 9], "specifi": [4, 10, 13], "split": [3, 5, 6], "split_argparse_into_group": 3, "split_time_unit": 6, "squar": [10, 13], "squeez": 5, "stack": 5, "stack_1d_arrays_list": 5, "stackoverflow": 3, "stage": [10, 13], "stai": 12, "start": [3, 6, 8, 12], "static": 2, "step": [3, 6, 9], "stop": [3, 8], "storage_dict": 6, "store": [3, 5, 12, 14], "str": [1, 2, 3, 4, 5, 6], "stream": 3, "strict": 6, "string": [1, 2, 3, 5, 6, 14], "structur": [10, 12, 13], "student": 12, "style": [2, 8, 9], "sub": 3, "sub_pars": 3, "subclass": 3, "subdictinari": 6, "submit": 9, "subpars": 3, "subset": 5, "subtitl": 9, "suffix": 3, "suitabl": 3, "summari": 6, "suppli": 3, "support": [0, 8, 10, 13], "syntax": 12, "t": [9, 11], "tabl": [3, 5], "taken": [2, 5], "task": 9, "taurenmd": 12, "teixeira": 7, "term": 3, "termin": 14, "test": 8, "thei": [5, 12], "them": [9, 12], "therefor": 12, "thezip": 5, "thi": [1, 2, 3, 6, 10, 12, 13, 14], "thread": 8, "through": [10, 12, 13], "time": [3, 6, 8, 9], "titl": [3, 9], "togeth": [5, 11, 14], "toml": 8, "tool": [10, 11, 13], "top": 11, "toplevel": 1, "topol": 14, "topolgi": 14, "topologi": [3, 12], "topology_format": 3, "topologyreaderbas": 3, "tox": 8, "tox_": 9, "tpr": 14, "traj": 14, "trajectori": [3, 8, 10, 12, 13, 14], "trajectory_format": 3, "translat": 8, "trr": [3, 14], "true": [1, 5], "try": 5, "try_to_squeeze_m": 5, "tupl": 6, "turquois": 2, "tuvokki": 2, "twice": 9, "two": 14, "type": [3, 5, 6, 8, 12], "typo": 8, "u": [9, 11], "under": 9, "underlin": 2, "unit": [3, 6], "univers": [3, 12], "up": [1, 3, 9, 12], "updat": [8, 11], "upgrad": 11, "upload": 8, "upstream": 9, "url": 8, "us": [0, 3, 6, 8, 9, 10, 11, 12, 13, 14], "usag": 0, "user": [0, 12], "usernam": 9, "util": 0, "v": 14, "v2": 9, "valu": [5, 6, 8], "valueerror": [3, 6], "variabl": [2, 12], "vebos": 3, "vector": 3, "verbos": [3, 14], "veri": [0, 9, 12], "verifi": 9, "version": [1, 3, 9], "vertic": 5, "via": 9, "volumetr": [10, 13], "vx": 9, "wai": [3, 9, 12], "wang": 7, "want": [0, 11], "warn": [1, 2, 3, 4, 14], "water": 14, "waterbridgeanalysi": 1, "we": [5, 9, 12], "webpag": 7, "welcom": [9, 10, 13], "well": 9, "were": 12, "what": 3, "when": [1, 6, 9], "where": [3, 5, 6], "which": [1, 3, 5, 6, 11, 12], "whole": 9, "window": 8, "wish": 9, "within": 12, "without": [5, 12], "work": [3, 10, 13], "workflow": 9, "wrapper": 12, "write": 12, "x": [5, 6, 9], "x1b": 2, "xdarr": 5, "xplor": 3, "xtc": 3, "xyz": 3, "yai": 2, "yellow": 2, "yet": 6, "you": [9, 11, 14], "your": [10, 11, 13, 14], "zip": [5, 12, 14], "zipit": 5, "zipnam": 5, "\u03c7_1": [10, 13], "\u03c7_2": [10, 13], "\u03c8": [10, 13], "\u03d5": [10, 13]}, "titles": ["API library documentation", "High-Level API", "Coloring", "Support functions for CLI", "Logging", "Results Saving", "Utilities", "Authors", "Changelog", "Contributing", "MDAnalysis command line interface", "Installation", "Philosophy and approach", "MDAnalysis command line interface", "Usage"], "titleterms": {"0": 8, "01": 8, "02": 8, "03": 8, "04": 8, "06": 8, "07": 8, "08": 8, "09": 8, "1": 8, "10": 8, "11": 8, "12": 8, "13": 8, "14": 8, "15": 8, "16": 8, "17": 8, "18": 8, "19": 8, "2": 8, "20": 8, "2021": 8, "2022": 8, "2023": 8, "2024": 8, "21": 8, "22": 8, "23": 8, "24": 8, "25": 8, "26": 8, "27": 8, "28": 8, "29": 8, "3": 8, "30": 8, "31": 8, "4": 8, "5": 8, "6": 8, "7": 8, "8": 8, "9": 8, "add": 9, "api": [0, 1], "approach": 12, "author": 7, "avail": [10, 13], "branch": 9, "chang": 9, "changelog": [8, 9], "cli": 3, "clone": 9, "color": 2, "command": [10, 13], "comput": 9, "conda": 11, "contribut": 9, "creat": 9, "develop": 9, "document": 0, "fork": 9, "function": 3, "high": 1, "instal": [9, 11], "interfac": [10, 13], "level": 1, "librari": 0, "line": [10, 13], "log": 4, "main": 9, "mdanalysi": [10, 13], "modul": [10, 13], "new": 9, "philosophi": 12, "pip": 11, "project": 9, "pull": 9, "remot": 9, "repositori": 9, "request": 9, "result": 5, "run": 9, "save": 5, "start": 9, "support": 3, "test": 9, "thi": 9, "tox": 9, "updat": 9, "usag": 14, "util": 6, "v0": 8, "your": 9}}) \ No newline at end of file diff --git a/dev/sitemap.xml b/dev/sitemap.xml index 40091ea..deecdff 100644 --- a/dev/sitemap.xml +++ b/dev/sitemap.xml @@ -1,2 +1,2 @@ -https://mdacli.mdanalysis.org/en/0.1.32/api.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/api/cli.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/api/colors.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/api/libcli.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/api/logger.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/api/save.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/api/utils.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/authors.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/changelog.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/contributing.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/index.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/installation.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/philosophy.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/readme.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/usage.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/genindex.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/py-modindex.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/mdacli/cli.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/mdacli/colors.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/mdacli/libcli.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/mdacli/logger.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/mdacli/save.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/mdacli/utils.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/index.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/search.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/opensearch.html \ No newline at end of file +https://mdacli.mdanalysis.org/en/0.1.31/api.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/api/cli.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/api/colors.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/api/libcli.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/api/logger.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/api/save.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/api/utils.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/authors.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/changelog.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/contributing.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/index.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/installation.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/philosophy.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/readme.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/usage.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/genindex.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/py-modindex.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/mdacli/cli.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/mdacli/colors.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/mdacli/libcli.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/mdacli/logger.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/mdacli/save.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/mdacli/utils.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/index.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/search.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/opensearch.html \ No newline at end of file diff --git a/dev/usage.html b/dev/usage.html index b727c33..729b94b 100644 --- a/dev/usage.html +++ b/dev/usage.html @@ -4,7 +4,7 @@ - Usage — mdacli 0.1.32 documentation + Usage — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
          - 0.1.32 + 0.1.31
          @@ -178,7 +178,7 @@

          Usage - 0.1.32 + 0.1.31 diff --git a/latest/index.html b/latest/index.html index 5b99a32..c038085 100644 --- a/latest/index.html +++ b/latest/index.html @@ -1,6 +1,6 @@ -Redirecting to https://mdacli.mdanalysis.org/0.1.32/index.html - - +Redirecting to https://mdacli.mdanalysis.org/0.1.31/index.html + + diff --git a/sitemap_index.xml b/sitemap_index.xml index a7654a2..f12455e 100644 --- a/sitemap_index.xml +++ b/sitemap_index.xml @@ -1,2 +1,2 @@ -https://mdacli.mdanalysis.org/0.1.32/sitemap.xmlhttps://mdacli.mdanalysis.org/stable/sitemap.xmlhttps://mdacli.mdanalysis.org/dev/sitemap.xml \ No newline at end of file +https://mdacli.mdanalysis.org/0.1.31/sitemap.xmlhttps://mdacli.mdanalysis.org/stable/sitemap.xmlhttps://mdacli.mdanalysis.org/dev/sitemap.xml \ No newline at end of file diff --git a/stable/_modules/index.html b/stable/_modules/index.html index a22f018..fd41492 100644 --- a/stable/_modules/index.html +++ b/stable/_modules/index.html @@ -3,7 +3,7 @@ - Overview: module code — mdacli 0.1.32 documentation + Overview: module code — mdacli 0.1.31 documentation @@ -17,13 +17,13 @@ - + @@ -42,7 +42,7 @@
          - 0.1.32 + 0.1.31
          @@ -129,7 +129,7 @@

          All modules for which code is available

          aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/stable/_modules/mdacli/cli.html b/stable/_modules/mdacli/cli.html index 78d6d83..82fdad0 100644 --- a/stable/_modules/mdacli/cli.html +++ b/stable/_modules/mdacli/cli.html @@ -3,7 +3,7 @@ - mdacli.cli — mdacli 0.1.32 documentation + mdacli.cli — mdacli 0.1.31 documentation @@ -17,13 +17,13 @@ - + @@ -42,7 +42,7 @@
          - 0.1.32 + 0.1.31
          @@ -274,7 +274,7 @@

          Source code for mdacli.cli

                aria-label="versions">
               
                 
          -        0.1.32
          +        0.1.31
                 
               
           
          diff --git a/stable/_modules/mdacli/colors.html b/stable/_modules/mdacli/colors.html
          index f7f432e..d62cd2c 100644
          --- a/stable/_modules/mdacli/colors.html
          +++ b/stable/_modules/mdacli/colors.html
          @@ -3,7 +3,7 @@
           
             
             
          -  mdacli.colors — mdacli 0.1.32 documentation
          +  mdacli.colors — mdacli 0.1.31 documentation
                 
                 
                 
          @@ -17,13 +17,13 @@
             
                   
                   
          -        
          +        
                   
                   
                   
               
               
               
                
          @@ -42,7 +42,7 @@
                         
                     
                         
          - 0.1.32 + 0.1.31
          @@ -341,7 +341,7 @@

          Source code for mdacli.colors

                aria-label="versions">
               
                 
          -        0.1.32
          +        0.1.31
                 
               
           
          diff --git a/stable/_modules/mdacli/libcli.html b/stable/_modules/mdacli/libcli.html
          index 9ffc26f..3380f62 100644
          --- a/stable/_modules/mdacli/libcli.html
          +++ b/stable/_modules/mdacli/libcli.html
          @@ -3,7 +3,7 @@
           
             
             
          -  mdacli.libcli — mdacli 0.1.32 documentation
          +  mdacli.libcli — mdacli 0.1.31 documentation
                 
                 
                 
          @@ -17,13 +17,13 @@
             
                   
                   
          -        
          +        
                   
                   
                   
               
               
               
                
          @@ -42,7 +42,7 @@
                         
                     
                         
          - 0.1.32 + 0.1.31
          @@ -985,7 +985,7 @@

          Source code for mdacli.libcli

                aria-label="versions">
               
                 
          -        0.1.32
          +        0.1.31
                 
               
           
          diff --git a/stable/_modules/mdacli/logger.html b/stable/_modules/mdacli/logger.html
          index 2594940..2759bc5 100644
          --- a/stable/_modules/mdacli/logger.html
          +++ b/stable/_modules/mdacli/logger.html
          @@ -3,7 +3,7 @@
           
             
             
          -  mdacli.logger — mdacli 0.1.32 documentation
          +  mdacli.logger — mdacli 0.1.31 documentation
                 
                 
                 
          @@ -17,13 +17,13 @@
             
                   
                   
          -        
          +        
                   
                   
                   
               
               
               
                
          @@ -42,7 +42,7 @@
                         
                     
                         
          - 0.1.32 + 0.1.31
          @@ -95,60 +95,20 @@

          Source code for mdacli.logger

           # Released under the GNU Public Licence, v2 or any higher version
           # SPDX-License-Identifier: GPL-2.0-or-later
           """Logging."""
          +
           import contextlib
           import logging
           import sys
          -import warnings
          -from pathlib import Path
          -from typing import List, Optional, Union
           
           from .colors import Emphasise
           
           
          -
          -[docs] -def check_suffix(filename: Union[str, Path], suffix: str) -> Union[str, Path]: - """Check the suffix of a file name and adds if it not existing. - - If ``filename`` does not end with ``suffix`` the ``suffix`` is added and a - warning will be issued. - - Parameters - ---------- - filename : Name of the file to be checked. - suffix : Expected filesuffix i.e. ``.txt``. - - Returns - ------- - Checked and probably extended file name. - """ - path_filename = Path(filename) - - if path_filename.suffix != suffix: - warnings.warn( - f"The file name should have a '{suffix}' extension. The user " - f"requested the file with name '{filename}', but it will be saved " - f"as '{filename}{suffix}'.", - stacklevel=1, - ) - path_filename = path_filename.parent / (path_filename.name + suffix) - - if type(filename) is str: - return str(path_filename) - else: - return path_filename
          - - -
          [docs] @contextlib.contextmanager -def setup_logging( - logobj: logging.Logger, - logfile: Optional[Union[str, Path]] = None, - level: int = logging.WARNING, -): - """Create a logging environment for a given ``log_obj``. +def setup_logging(logobj, logfile=None, level=logging.WARNING): + """ + Create a logging environment for a given logobj. Parameters ---------- @@ -159,52 +119,39 @@

          Source code for mdacli.logger

               level : int
                   Set the root logger level to the specified level. If for example set
                   to :py:obj:`logging.DEBUG` detailed debug logs inludcing filename and
          -        function name are displayed. For :py:obj:`logging.INFO` only the
          -        message logged from errors, warnings and infos will be displayed.
          +        function name are displayed. For :py:obj:`logging.INFO only the message
          +        logged from errors, warnings and infos will be displayed.
               """
               try:
          -        format = ""
                   if level == logging.DEBUG:
          -            format += "[{levelname}]:{filename}:{funcName}:{lineno} - "
          -        format += "{message}"
          -
          -        formatter = logging.Formatter(format, style="{")
          -        handlers: List[Union[logging.StreamHandler, logging.FileHandler]] = []
          +            format = (
          +                "[{levelname}] {filename}:{name}:{funcName}:{lineno}: "
          +                "{message}"
          +            )
          +        else:
          +            format = "{message}"
           
          -        stream_handler = logging.StreamHandler(sys.stdout)
          -        stream_handler.setFormatter(formatter)
          -        handlers.append(stream_handler)
          +        logging.basicConfig(format=format,
          +                            handlers=[logging.StreamHandler(sys.stdout)],
          +                            level=level,
          +                            style='{')
           
                   if logfile:
          -            logfile = check_suffix(filename=logfile, suffix=".log")
          -            file_handler = logging.FileHandler(
          -                filename=str(logfile), encoding="utf-8")
          -            file_handler.setFormatter(formatter)
          -            handlers.append(file_handler)
          +            logfile += ".log" * (not logfile.endswith("log"))
          +            handler = logging.FileHandler(filename=logfile, encoding='utf-8')
          +            handler.setFormatter(logging.Formatter(format, style='{'))
          +            logobj.addHandler(handler)
                   else:
                       logging.addLevelName(logging.INFO, Emphasise.info("INFO"))
                       logging.addLevelName(logging.DEBUG, Emphasise.debug("DEBUG"))
                       logging.addLevelName(logging.WARNING, Emphasise.warning("WARNING"))
                       logging.addLevelName(logging.ERROR, Emphasise.error("ERROR"))
          -
          -        logging.basicConfig(
          -            format=format, handlers=handlers, level=level, style="{")
          -        logging.captureWarnings(True)
          -
          -        if logfile:
          -            abs_path = str(Path(logfile).absolute().resolve())
          -            logobj.info(f"This log is also available at {abs_path!r}.")
          -        else:
          -            logobj.debug("Logging to file is disabled.")
          -
          -        for handler in handlers:
          -            logobj.addHandler(handler)
          +            logobj.info('Logging to file is disabled.')
           
                   yield
          -
               finally:
          +        handlers = logobj.handlers[:]
                   for handler in handlers:
          -            handler.flush()
                       handler.close()
                       logobj.removeHandler(handler)
          @@ -245,7 +192,7 @@

          Source code for mdacli.logger

                aria-label="versions">
               
                 
          -        0.1.32
          +        0.1.31
                 
               
           
          diff --git a/stable/_modules/mdacli/save.html b/stable/_modules/mdacli/save.html
          index d68e06c..94f00ff 100644
          --- a/stable/_modules/mdacli/save.html
          +++ b/stable/_modules/mdacli/save.html
          @@ -3,7 +3,7 @@
           
             
             
          -  mdacli.save — mdacli 0.1.32 documentation
          +  mdacli.save — mdacli 0.1.31 documentation
                 
                 
                 
          @@ -17,13 +17,13 @@
             
                   
                   
          -        
          +        
                   
                   
                   
               
               
               
                
          @@ -42,7 +42,7 @@
                         
                     
                         
          - 0.1.32 + 0.1.31
          @@ -580,7 +580,7 @@

          Source code for mdacli.save

                aria-label="versions">
               
                 
          -        0.1.32
          +        0.1.31
                 
               
           
          diff --git a/stable/_modules/mdacli/utils.html b/stable/_modules/mdacli/utils.html
          index 8863210..8888189 100644
          --- a/stable/_modules/mdacli/utils.html
          +++ b/stable/_modules/mdacli/utils.html
          @@ -3,7 +3,7 @@
           
             
             
          -  mdacli.utils — mdacli 0.1.32 documentation
          +  mdacli.utils — mdacli 0.1.31 documentation
                 
                 
                 
          @@ -17,13 +17,13 @@
             
                   
                   
          -        
          +        
                   
                   
                   
               
               
               
                
          @@ -42,7 +42,7 @@
                         
                     
                         
          - 0.1.32 + 0.1.31
          @@ -396,7 +396,7 @@

          Source code for mdacli.utils

                aria-label="versions">
               
                 
          -        0.1.32
          +        0.1.31
                 
               
           
          diff --git a/stable/_static/documentation_options.js b/stable/_static/documentation_options.js
          index e673888..ef6aebe 100644
          --- a/stable/_static/documentation_options.js
          +++ b/stable/_static/documentation_options.js
          @@ -1,5 +1,5 @@
           const DOCUMENTATION_OPTIONS = {
          -    VERSION: '0.1.32',
          +    VERSION: '0.1.31',
               LANGUAGE: 'en',
               COLLAPSE_INDEX: false,
               BUILDER: 'html',
          diff --git a/stable/_static/opensearch.xml b/stable/_static/opensearch.xml
          index 479fda6..82ff9e2 100644
          --- a/stable/_static/opensearch.xml
          +++ b/stable/_static/opensearch.xml
          @@ -1,11 +1,11 @@
           
           
             mdacli
          -  Search mdacli 0.1.32 documentation
          +  Search mdacli 0.1.31 documentation
             utf-8
             
          -  mdacli 0.1.32 documentation
          +  mdacli 0.1.31 documentation
             https://mdacli.mdanalysis.org//_static/mdanalysis-logo.ico
             
           
          \ No newline at end of file
          diff --git a/stable/api.html b/stable/api.html
          index 4f06a71..a2bd874 100644
          --- a/stable/api.html
          +++ b/stable/api.html
          @@ -4,7 +4,7 @@
             
           
             
          -  API library documentation — mdacli 0.1.32 documentation
          +  API library documentation — mdacli 0.1.31 documentation
                 
                 
                 
          @@ -18,13 +18,13 @@
             
                   
                   
          -        
          +        
                   
                   
                   
               
               
               
               
          @@ -45,7 +45,7 @@
                         
                     
                         
          - 0.1.32 + 0.1.31
          @@ -154,7 +154,7 @@

          API library documentation - 0.1.32 + 0.1.31 diff --git a/stable/api/cli.html b/stable/api/cli.html index 2f4db5b..0785451 100644 --- a/stable/api/cli.html +++ b/stable/api/cli.html @@ -4,7 +4,7 @@ - High-Level API — mdacli 0.1.32 documentation + High-Level API — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
          - 0.1.32 + 0.1.31
          @@ -106,7 +106,7 @@

          The toplevel command line interface.

          -mdacli.cli.cli(name, module_list, base_class=<Mock name='mock.AnalysisBase' id='139825847530112'>, version='', description='', skip_modules=None, ignore_warnings=False)[source]
          +mdacli.cli.cli(name, module_list, base_class=<Mock name='mock.AnalysisBase' id='140423703360128'>, version='', description='', skip_modules=None, ignore_warnings=False)[source]

          Create the command-line interface.

          This function creates a command line interface with a given name based on a module list.

          @@ -187,7 +187,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/stable/api/colors.html b/stable/api/colors.html index 2e90659..b099c97 100644 --- a/stable/api/colors.html +++ b/stable/api/colors.html @@ -4,7 +4,7 @@ - Coloring — mdacli 0.1.32 documentation + Coloring — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
          - 0.1.32 + 0.1.31
          @@ -357,7 +357,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/stable/api/libcli.html b/stable/api/libcli.html index 93f94d6..dfc82dc 100644 --- a/stable/api/libcli.html +++ b/stable/api/libcli.html @@ -4,7 +4,7 @@ - Support functions for CLI — mdacli 0.1.32 documentation + Support functions for CLI — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
          - 0.1.32 + 0.1.31
          @@ -454,7 +454,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/stable/api/logger.html b/stable/api/logger.html index 30a96b9..cd634da 100644 --- a/stable/api/logger.html +++ b/stable/api/logger.html @@ -4,7 +4,7 @@ - Logging — mdacli 0.1.32 documentation + Logging — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
          - 0.1.32 + 0.1.31
          @@ -66,7 +66,6 @@
        • Results Saving
        • Coloring
        • Logging
        • @@ -105,29 +104,10 @@

          Logging

          Logging.

          -
          -
          -mdacli.logger.check_suffix(filename: str | Path, suffix: str) str | Path[source]
          -

          Check the suffix of a file name and adds if it not existing.

          -

          If filename does not end with suffix the suffix is added and a -warning will be issued.

          -
          -
          Parameters:
          -
            -
          • filename (Name of the file to be checked.)

          • -
          • suffix (Expected filesuffix i.e. .txt.)

          • -
          -
          -
          Returns:
          -

          Checked and probably extended file name.

          -
          -
          -
          -
          -mdacli.logger.setup_logging(logobj: Logger, logfile: str | Path | None = None, level: int = 30)[source]
          -

          Create a logging environment for a given log_obj.

          +mdacli.logger.setup_logging(logobj, logfile=None, level=30)[source] +

          Create a logging environment for a given logobj.

          Parameters:
            @@ -135,8 +115,8 @@
          • logfile (str) – Name of the log file

          • level (int) – Set the root logger level to the specified level. If for example set to logging.DEBUG detailed debug logs inludcing filename and -function name are displayed. For logging.INFO only the -message logged from errors, warnings and infos will be displayed.

          • +function name are displayed. For :py:obj:`logging.INFO only the message +logged from errors, warnings and infos will be displayed.

          @@ -183,7 +163,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/stable/api/save.html b/stable/api/save.html index d62ebdc..93e3dd7 100644 --- a/stable/api/save.html +++ b/stable/api/save.html @@ -4,7 +4,7 @@ - Results Saving — mdacli 0.1.32 documentation + Results Saving — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
          - 0.1.32 + 0.1.31
          @@ -371,7 +371,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/stable/api/utils.html b/stable/api/utils.html index a25a90b..d1dfc33 100644 --- a/stable/api/utils.html +++ b/stable/api/utils.html @@ -4,7 +4,7 @@ - Utilities — mdacli 0.1.32 documentation + Utilities — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
          - 0.1.32 + 0.1.31
          @@ -231,7 +231,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/stable/authors.html b/stable/authors.html index 5cbb4d6..5e87b53 100644 --- a/stable/authors.html +++ b/stable/authors.html @@ -4,7 +4,7 @@ - Authors — mdacli 0.1.32 documentation + Authors — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -44,7 +44,7 @@
          - 0.1.32 + 0.1.31
          @@ -137,7 +137,7 @@

          Authors aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/stable/changelog.html b/stable/changelog.html index 1304834..c341651 100644 --- a/stable/changelog.html +++ b/stable/changelog.html @@ -4,7 +4,7 @@ - Changelog — mdacli 0.1.32 documentation + Changelog — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
          - 0.1.32 + 0.1.31
          @@ -62,7 +62,6 @@
        • Contributing
        • API library documentation
        • Changelog
            -
          • v0.1.32 (2024-07-09)
          • v0.1.31 (2024-07-08)
          • v0.1.30 (2024-04-03)
          • v0.1.29 (2024-03-21)
          • @@ -126,12 +125,6 @@

            Changelog

            -
            -

            v0.1.32 (2024-07-09)

            -
              -
            • Cleanup logger function

            • -
            -

            v0.1.31 (2024-07-08)

              @@ -386,7 +379,7 @@

              v0.1.0 (2021-11-18) - 0.1.32 + 0.1.31 diff --git a/stable/contributing.html b/stable/contributing.html index e511b69..bb7816d 100644 --- a/stable/contributing.html +++ b/stable/contributing.html @@ -4,7 +4,7 @@ - Contributing — mdacli 0.1.32 documentation + Contributing — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
              - 0.1.32 + 0.1.31
              @@ -278,7 +278,7 @@

              Pull Request - 0.1.32 + 0.1.31 diff --git a/stable/genindex.html b/stable/genindex.html index 64f94d1..ab5cb51 100644 --- a/stable/genindex.html +++ b/stable/genindex.html @@ -3,7 +3,7 @@ - Index — mdacli 0.1.32 documentation + Index — mdacli 0.1.31 documentation @@ -17,13 +17,13 @@ - + @@ -42,7 +42,7 @@
              - 0.1.32 + 0.1.31
              @@ -139,8 +139,6 @@

              B

              C

                -
              • check_suffix() (in module mdacli.logger) -
              • cli() (in module mdacli.cli)
              • convert_analysis_parameters() (in module mdacli.libcli) @@ -466,7 +464,7 @@

                Y

                aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/stable/index.html b/stable/index.html index aaeeece..8942c4a 100644 --- a/stable/index.html +++ b/stable/index.html @@ -4,7 +4,7 @@ - MDAnalysis command line interface — mdacli 0.1.32 documentation + MDAnalysis command line interface — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -44,7 +44,7 @@
                - 0.1.32 + 0.1.31
                @@ -225,7 +225,7 @@

                Available modules - 0.1.32 + 0.1.31 diff --git a/stable/installation.html b/stable/installation.html index ad87670..e32251c 100644 --- a/stable/installation.html +++ b/stable/installation.html @@ -4,7 +4,7 @@ - Installation — mdacli 0.1.32 documentation + Installation — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
                - 0.1.32 + 0.1.31
                @@ -170,7 +170,7 @@

                conda - 0.1.32 + 0.1.31 diff --git a/stable/objects.inv b/stable/objects.inv index b58dabf..6986add 100644 Binary files a/stable/objects.inv and b/stable/objects.inv differ diff --git a/stable/philosophy.html b/stable/philosophy.html index 6661305..e9ac197 100644 --- a/stable/philosophy.html +++ b/stable/philosophy.html @@ -4,7 +4,7 @@ - Philosophy and approach — mdacli 0.1.32 documentation + Philosophy and approach — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
                - 0.1.32 + 0.1.31
                @@ -182,7 +182,7 @@

                Philosophy and approach - 0.1.32 + 0.1.31 diff --git a/stable/py-modindex.html b/stable/py-modindex.html index 5f598d1..bf4eaca 100644 --- a/stable/py-modindex.html +++ b/stable/py-modindex.html @@ -3,7 +3,7 @@ - Python Module Index — mdacli 0.1.32 documentation + Python Module Index — mdacli 0.1.31 documentation @@ -17,13 +17,13 @@ - + @@ -45,7 +45,7 @@
                - 0.1.32 + 0.1.31
                @@ -173,7 +173,7 @@

                Python Module Index

                aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/stable/readme.html b/stable/readme.html index 1eb9da0..8ee2d8b 100644 --- a/stable/readme.html +++ b/stable/readme.html @@ -4,7 +4,7 @@ - MDAnalysis command line interface — mdacli 0.1.32 documentation + MDAnalysis command line interface — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -43,7 +43,7 @@
                - 0.1.32 + 0.1.31
                @@ -220,7 +220,7 @@

                Available modules - 0.1.32 + 0.1.31 diff --git a/stable/search.html b/stable/search.html index 94b66dd..fb8e1f8 100644 --- a/stable/search.html +++ b/stable/search.html @@ -3,7 +3,7 @@ - Search — mdacli 0.1.32 documentation + Search — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
                - 0.1.32 + 0.1.31
                @@ -136,7 +136,7 @@ aria-label="versions"> - 0.1.32 + 0.1.31 diff --git a/stable/searchindex.js b/stable/searchindex.js index ea96ba2..716e176 100644 --- a/stable/searchindex.js +++ b/stable/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API library documentation": [[0, "api-library-documentation"]], "Add your fork as remote": [[9, "add-your-fork-as-remote"]], "Authors": [[7, "authors"]], "Available modules": [[10, "available-modules"], [13, "available-modules"]], "Changelog": [[8, "changelog"]], "Clone the main project to your computer": [[9, "clone-the-main-project-to-your-computer"]], "Coloring": [[2, "module-mdacli.colors"]], "Contributing": [[9, "contributing"]], "Create a new branch and start developing": [[9, "create-a-new-branch-and-start-developing"]], "Fork this repository": [[9, "fork-this-repository"]], "High-Level API": [[1, "module-mdacli.cli"]], "Install for developers": [[9, "install-for-developers"]], "Installation": [[11, "installation"]], "Logging": [[4, "module-mdacli.logger"]], "MDAnalysis command line interface": [[10, "mdanalysis-command-line-interface"], [13, "mdanalysis-command-line-interface"]], "Philosophy and approach": [[12, "philosophy-and-approach"]], "Pull Request": [[9, "pull-request"]], "Pull Request your changes": [[9, "pull-request-your-changes"]], "Results Saving": [[5, "module-mdacli.save"]], "Running tests with tox": [[9, "running-tests-with-tox"]], "Support functions for CLI": [[3, "module-mdacli.libcli"]], "Update CHANGELOG": [[9, "update-changelog"]], "Usage": [[14, "usage"]], "Utilities": [[6, "module-mdacli.utils"]], "conda": [[11, "conda"]], "pip": [[11, "pip"]], "v0.1.0 (2021-11-18)": [[8, "v0-1-0-2021-11-18"]], "v0.1.1 (2021-11-18)": [[8, "v0-1-1-2021-11-18"]], "v0.1.10 (2022-01-18)": [[8, "v0-1-10-2022-01-18"]], "v0.1.11 (2022-01-19)": [[8, "v0-1-11-2022-01-19"]], "v0.1.12 (2022-01-19)": [[8, "v0-1-12-2022-01-19"]], "v0.1.13 (2022-02-16)": [[8, "v0-1-13-2022-02-16"]], "v0.1.14 (2022-02-17)": [[8, "v0-1-14-2022-02-17"]], "v0.1.15 (2022-02-25)": [[8, "v0-1-15-2022-02-25"]], "v0.1.16 (2022-02-25)": [[8, "v0-1-16-2022-02-25"]], "v0.1.17 (2022-04-07)": [[8, "v0-1-17-2022-04-07"]], "v0.1.18 (2022-04-12)": [[8, "v0-1-18-2022-04-12"]], "v0.1.19 (2022-04-12)": [[8, "v0-1-19-2022-04-12"]], "v0.1.2 (2021-11-18)": [[8, "v0-1-2-2021-11-18"]], "v0.1.20 (2022-04-13)": [[8, "v0-1-20-2022-04-13"]], "v0.1.21 (2022-04-22)": [[8, "v0-1-21-2022-04-22"]], "v0.1.22 (2023-01-27)": [[8, "v0-1-22-2023-01-27"]], "v0.1.23 (2023-01-27)": [[8, "v0-1-23-2023-01-27"]], "v0.1.24 (2023-01-27)": [[8, "v0-1-24-2023-01-27"]], "v0.1.25 (2023-02-21)": [[8, "v0-1-25-2023-02-21"]], "v0.1.26 (2023-06-27)": [[8, "v0-1-26-2023-06-27"]], "v0.1.27 (2023-08-25)": [[8, "v0-1-27-2023-08-25"]], "v0.1.28 (2023-09-29)": [[8, "v0-1-28-2023-09-29"]], "v0.1.29 (2024-03-21)": [[8, "v0-1-29-2024-03-21"]], "v0.1.3 (2021-11-24)": [[8, "v0-1-3-2021-11-24"]], "v0.1.30 (2024-04-03)": [[8, "v0-1-30-2024-04-03"]], "v0.1.31 (2024-07-08)": [[8, "v0-1-31-2024-07-08"]], "v0.1.32 (2024-07-09)": [[8, "v0-1-32-2024-07-09"]], "v0.1.4 (2021-11-24)": [[8, "v0-1-4-2021-11-24"]], "v0.1.5 (2021-12-01)": [[8, "v0-1-5-2021-12-01"]], "v0.1.6 (2021-12-01)": [[8, "v0-1-6-2021-12-01"]], "v0.1.7 (2021-12-18)": [[8, "v0-1-7-2021-12-18"]], "v0.1.8 (2022-01-16)": [[8, "v0-1-8-2022-01-16"]], "v0.1.9 (2022-01-16)": [[8, "v0-1-9-2022-01-16"]]}, "docnames": ["api", "api/cli", "api/colors", "api/libcli", "api/logger", "api/save", "api/utils", "authors", "changelog", "contributing", "index", "installation", "philosophy", "readme", "usage"], "envversion": {"sphinx": 61, "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.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "api/cli.rst", "api/colors.rst", "api/libcli.rst", "api/logger.rst", "api/save.rst", "api/utils.rst", "authors.rst", "changelog.rst", "contributing.rst", "index.rst", "installation.rst", "philosophy.rst", "readme.rst", "usage.rst"], "indexentries": {"add_cli_universe() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_cli_universe", false]], "add_output_group() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_output_group", false]], "add_run_group() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_run_group", false]], "blue (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.blue", false]], "bold (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.bold", false]], "check_suffix() (in module mdacli.logger)": [[4, "mdacli.logger.check_suffix", false]], "cli() (in module mdacli.cli)": [[1, "mdacli.cli.cli", false]], "convert_analysis_parameters() (in module mdacli.libcli)": [[3, "mdacli.libcli.convert_analysis_parameters", false]], "convert_str_time() (in module mdacli.utils)": [[6, "mdacli.utils.convert_str_time", false]], "create_cli() (in module mdacli.libcli)": [[3, "mdacli.libcli.create_cli", false]], "create_universe() (in module mdacli.libcli)": [[3, "mdacli.libcli.create_universe", false]], "debug() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.debug", false]], "emphasise (class in mdacli.colors)": [[2, "mdacli.colors.Emphasise", false]], "emphasise() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.emphasise", false]], "error() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.error", false]], "find_classes_in_modules() (in module mdacli.libcli)": [[3, "mdacli.libcli.find_classes_in_modules", false]], "find_cls_members() (in module mdacli.libcli)": [[3, "mdacli.libcli.find_cls_members", false]], "get_1d_arrays() (in module mdacli.save)": [[5, "mdacli.save.get_1D_arrays", false]], "get_cli_input() (in module mdacli.save)": [[5, "mdacli.save.get_cli_input", false]], "gray (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.gray", false]], "green (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.green", false]], "header() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.header", false]], "info() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.info", false]], "init_base_argparse() (in module mdacli.libcli)": [[3, "mdacli.libcli.init_base_argparse", false]], "is_1d_array() (in module mdacli.save)": [[5, "mdacli.save.is_1d_array", false]], "is_2d_array() (in module mdacli.save)": [[5, "mdacli.save.is_2d_array", false]], "is_3d_array() (in module mdacli.save)": [[5, "mdacli.save.is_3d_array", false]], "is_dimension_array() (in module mdacli.save)": [[5, "mdacli.save.is_dimension_array", false]], "is_higher_dimension_array() (in module mdacli.save)": [[5, "mdacli.save.is_higher_dimension_array", false]], "is_serializable() (in module mdacli.save)": [[5, "mdacli.save.is_serializable", false]], "kwargsdict (class in mdacli.libcli)": [[3, "mdacli.libcli.KwargsDict", false]], "mdacli.cli": [[1, "module-mdacli.cli", false]], "mdacli.colors": [[2, "module-mdacli.colors", false]], "mdacli.libcli": [[3, "module-mdacli.libcli", false]], "mdacli.logger": [[4, "module-mdacli.logger", false]], "mdacli.save": [[5, "module-mdacli.save", false]], "mdacli.utils": [[6, "module-mdacli.utils", false]], "module": [[1, "module-mdacli.cli", false], [2, "module-mdacli.colors", false], [3, "module-mdacli.libcli", false], [4, "module-mdacli.logger", false], [5, "module-mdacli.save", false], [6, "module-mdacli.utils", false]], "ok() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.ok", false]], "parse_callable_signature() (in module mdacli.utils)": [[6, "mdacli.utils.parse_callable_signature", false]], "parse_docs() (in module mdacli.utils)": [[6, "mdacli.utils.parse_docs", false]], "pink (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.pink", false]], "red (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.red", false]], "remove_files() (in module mdacli.save)": [[5, "mdacli.save.remove_files", false]], "return_with_remove() (in module mdacli.save)": [[5, "mdacli.save.return_with_remove", false]], "run_analysis() (in module mdacli.libcli)": [[3, "mdacli.libcli.run_analysis", false]], "save() (in module mdacli.save)": [[5, "mdacli.save.save", false]], "save_1d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_1D_arrays", false]], "save_2d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_2D_arrays", false]], "save_3d_array_to_2d_csv() (in module mdacli.save)": [[5, "mdacli.save.save_3D_array_to_2D_csv", false]], "save_3d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_3D_arrays", false]], "save_files_to_zip() (in module mdacli.save)": [[5, "mdacli.save.save_files_to_zip", false]], "save_higher_dim_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_higher_dim_arrays", false]], "save_json_serializables() (in module mdacli.save)": [[5, "mdacli.save.save_json_serializables", false]], "save_result_array() (in module mdacli.save)": [[5, "mdacli.save.save_result_array", false]], "save_results_object() (in module mdacli.save)": [[5, "mdacli.save.save_Results_object", false]], "save_to_json() (in module mdacli.save)": [[5, "mdacli.save.save_to_json", false]], "savetxt_w_command() (in module mdacli.save)": [[5, "mdacli.save.savetxt_w_command", false]], "setup_clients() (in module mdacli.libcli)": [[3, "mdacli.libcli.setup_clients", false]], "setup_logging() (in module mdacli.logger)": [[4, "mdacli.logger.setup_logging", false]], "split_argparse_into_groups() (in module mdacli.libcli)": [[3, "mdacli.libcli.split_argparse_into_groups", false]], "split_time_unit() (in module mdacli.utils)": [[6, "mdacli.utils.split_time_unit", false]], "stack_1d_arrays_list() (in module mdacli.save)": [[5, "mdacli.save.stack_1d_arrays_list", false]], "try_to_squeeze_me() (in module mdacli.save)": [[5, "mdacli.save.try_to_squeeze_me", false]], "turquoise (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.turquoise", false]], "underline (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.underline", false]], "warning() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.warning", false]], "yellow (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.yellow", false]]}, "objects": {"mdacli": [[1, 0, 0, "-", "cli"], [2, 0, 0, "-", "colors"], [3, 0, 0, "-", "libcli"], [4, 0, 0, "-", "logger"], [5, 0, 0, "-", "save"], [6, 0, 0, "-", "utils"]], "mdacli.cli": [[1, 1, 1, "", "cli"]], "mdacli.colors": [[2, 2, 1, "", "Emphasise"]], "mdacli.colors.Emphasise": [[2, 3, 1, "", "blue"], [2, 3, 1, "", "bold"], [2, 4, 1, "", "debug"], [2, 4, 1, "", "emphasise"], [2, 4, 1, "", "error"], [2, 3, 1, "", "gray"], [2, 3, 1, "", "green"], [2, 4, 1, "", "header"], [2, 4, 1, "", "info"], [2, 4, 1, "", "ok"], [2, 3, 1, "", "pink"], [2, 3, 1, "", "red"], [2, 3, 1, "", "turquoise"], [2, 3, 1, "", "underline"], [2, 4, 1, "", "warning"], [2, 3, 1, "", "yellow"]], "mdacli.libcli": [[3, 2, 1, "", "KwargsDict"], [3, 1, 1, "", "add_cli_universe"], [3, 1, 1, "", "add_output_group"], [3, 1, 1, "", "add_run_group"], [3, 1, 1, "", "convert_analysis_parameters"], [3, 1, 1, "", "create_cli"], [3, 1, 1, "", "create_universe"], [3, 1, 1, "", "find_classes_in_modules"], [3, 1, 1, "", "find_cls_members"], [3, 1, 1, "", "init_base_argparse"], [3, 1, 1, "", "run_analysis"], [3, 1, 1, "", "setup_clients"], [3, 1, 1, "", "split_argparse_into_groups"]], "mdacli.logger": [[4, 1, 1, "", "check_suffix"], [4, 1, 1, "", "setup_logging"]], "mdacli.save": [[5, 1, 1, "", "get_1D_arrays"], [5, 1, 1, "", "get_cli_input"], [5, 1, 1, "", "is_1d_array"], [5, 1, 1, "", "is_2d_array"], [5, 1, 1, "", "is_3d_array"], [5, 1, 1, "", "is_dimension_array"], [5, 1, 1, "", "is_higher_dimension_array"], [5, 1, 1, "", "is_serializable"], [5, 1, 1, "", "remove_files"], [5, 1, 1, "", "return_with_remove"], [5, 1, 1, "", "save"], [5, 1, 1, "", "save_1D_arrays"], [5, 1, 1, "", "save_2D_arrays"], [5, 1, 1, "", "save_3D_array_to_2D_csv"], [5, 1, 1, "", "save_3D_arrays"], [5, 1, 1, "", "save_Results_object"], [5, 1, 1, "", "save_files_to_zip"], [5, 1, 1, "", "save_higher_dim_arrays"], [5, 1, 1, "", "save_json_serializables"], [5, 1, 1, "", "save_result_array"], [5, 1, 1, "", "save_to_json"], [5, 1, 1, "", "savetxt_w_command"], [5, 1, 1, "", "stack_1d_arrays_list"], [5, 1, 1, "", "try_to_squeeze_me"]], "mdacli.utils": [[6, 1, 1, "", "convert_str_time"], [6, 1, 1, "", "parse_callable_signature"], [6, 1, 1, "", "parse_docs"], [6, 1, 1, "", "split_time_unit"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "terms": {"": [3, 6, 9, 12, 14], "0": 3, "01": 9, "1": [2, 3, 5], "109": 8, "114": 8, "139825847530112": 1, "14deb97bef6df9bc6553": 2, "1900": 9, "1d": [5, 12], "1darrai": 5, "1m": 2, "2": [5, 6], "2d": [5, 12], "2darr": 5, "2nd": 14, "3": [3, 5], "30": 4, "31519997": 3, "3d": 5, "3darr": 5, "3rd": 14, "4": [5, 14], "4m": 2, "6": 3, "65": 8, "68": 8, "70": 8, "75": 8, "78": 8, "80": 8, "81": 8, "82": 8, "83": 8, "85": 8, "86": 8, "88": 8, "90": 3, "90m": 2, "91m": 2, "92m": 2, "93m": 2, "94m": 2, "95m": 2, "96m": 2, "A": [0, 3, 4, 5, 6, 10, 12, 13, 14], "For": [4, 9, 10, 13, 14], "If": [3, 4, 5, 6, 9, 11, 12], "It": 9, "Not": 9, "One": 6, "Or": 11, "That": 9, "The": [0, 1, 2, 3, 5, 6, 9, 12, 14], "These": 9, "To": [10, 11, 13, 14], "With": 12, "__all__": 1, "__authors__": 8, "__doc__": 1, "__init__": 6, "__version__": 1, "about": [5, 10, 13, 14], "absolut": 3, "accept": 9, "accor": 5, "accord": 3, "accordingli": 8, "account": 9, "achiev": 14, "across": [10, 13], "action": [8, 9], "activ": 11, "actual": [3, 12, 14], "ad": [3, 4, 6, 8, 12], "add": [3, 4, 5, 8], "add_argu": 8, "add_cli_univers": 3, "add_output_group": 3, "add_run_group": 3, "addit": [5, 9, 14], "adjust": 12, "advanc": 0, "after": [3, 9, 14], "align": [10, 13], "aligntraj": [10, 13], "all": [3, 5, 9, 12, 14], "allow": 8, "along": 5, "alreadi": [6, 9, 11], "also": [3, 9, 11, 12, 14], "altern": 3, "alwai": 9, "an": [3, 6, 9, 10, 12, 13, 14], "analysi": [1, 3, 5, 8, 10, 12, 13, 14], "analysis_cal": 3, "analysis_class_pars": 3, "analysis_paramet": 3, "analysisbas": [1, 3, 12], "analysisfromfunct": 1, "analyz": 12, "anaylsi": 1, "anaylysi": 3, "angl": [3, 10, 13], "ani": [3, 6, 9, 11, 12], "anlysi": 3, "ap": 3, "appear": 9, "appli": [5, 9, 12], "ar": [3, 4, 5, 6, 9, 10, 11, 12, 13, 14], "archiv": 5, "arg": 8, "arg_grouped_dict": 3, "argpars": [3, 10, 12, 13], "argument": [3, 8, 12], "argumentpars": 3, "argumentspars": 3, "around": 12, "arr": 5, "arr_nam": 5, "arrai": [5, 12, 14], "ask": 14, "assert": 5, "assum": 6, "atom": [3, 10, 13, 14], "atom_styl": 3, "atomgroup": [3, 8, 10, 13, 14], "attempt": 3, "attract": 12, "attribut": [2, 5], "author": 9, "automat": [11, 12], "avail": [2, 3, 14], "averag": [10, 13], "averagestructur": [10, 13], "avoid": 9, "b": 9, "banner": 8, "bare": 14, "base": [1, 3, 5, 6, 8, 9, 10, 12, 13], "base_class": 1, "basic": [3, 10, 13], "bcolor": 2, "becaus": [3, 9], "beckstein": 7, "befor": 9, "begin": 3, "bellow": 9, "belong": [1, 3], "between": [10, 13, 14], "blue": 2, "bold": 2, "bond": 3, "bool": [1, 3, 5], "boolean": 8, "both": 12, "box": 8, "build": [1, 9, 12], "bullet": 9, "bump2vers": 8, "bumpvers": 8, "bunch": 14, "c": [7, 9, 11], "calcul": [10, 13, 14], "callabl": 6, "callable_obj": 6, "can": [3, 6, 9, 11, 12, 14], "canon": 8, "case": 9, "categori": 3, "cd": 9, "cell": 3, "certain": [3, 5], "certifi": 9, "cfg": 8, "chain": 3, "challeng": 12, "chang": [3, 8, 14], "charg": 3, "charmm": 3, "check": [4, 5, 8], "check_suffix": 4, "checkout": 9, "choic": [3, 8], "ci": [8, 9], "cl": [1, 3], "class": [1, 2, 3, 6, 8, 10, 12, 13, 14], "classifi": 8, "cleanup": 8, "clever": 12, "cli": [0, 1, 6, 8, 10, 12, 13], "cli_pars": 3, "client": [3, 14], "clone": 11, "close": [10, 13], "closecontactgnmanalysi": [10, 13], "code": [1, 9, 12], "codebas": 12, "codecov": 8, "color": 0, "column": 14, "com": [2, 3, 6, 9, 11], "combin": [6, 12], "command": [0, 1, 3, 5, 9, 12, 14], "commit": 9, "commun": 9, "complet": 8, "complex": 14, "compon": [10, 13], "compress": 5, "comput": [10, 13], "conda": [8, 9], "conflict": 9, "const": 3, "contact": [1, 10, 11, 13], "contain": [1, 3, 5, 6, 12, 14], "continu": 9, "contribut": [8, 10, 13], "contributor": 9, "conveni": 6, "convert": [3, 6, 8], "convert_analysis_paramet": 3, "convert_str_tim": 6, "coordin": [3, 10, 13], "copi": 12, "core": [3, 12], "correct": [3, 8, 9], "correctli": 9, "correspond": [5, 14], "could": [2, 3, 6, 12], "crd": 3, "creat": [1, 3, 4, 5, 12], "create_cli": [3, 8], "create_univers": 3, "creation": [3, 6, 8], "csv": [5, 12, 14], "current": [10, 13, 14], "custom": 3, "customis": 3, "dai": 12, "danger": 2, "data": [3, 5, 12, 14], "dcd": 3, "ddict": 5, "debug": [2, 3, 4, 8, 14], "decor": 2, "decorated_messag": 2, "default": [3, 5, 14], "defin": [3, 5], "degre": 3, "densiti": [10, 13], "densityanalysi": [10, 13], "dep": [9, 11], "depend": [8, 11], "deploi": 8, "deploy": 8, "desc": 6, "describ": 9, "descript": [1, 3, 6, 8, 10, 13], "design": 3, "desir": 2, "dest": 3, "detail": [4, 6, 14], "detect": [8, 12], "develop": [0, 10, 11, 12, 13], "dict": [3, 5, 6], "dictionari": [3, 5, 6, 12], "did": 9, "dielectricconst": [10, 13], "dihedr": [1, 8, 10, 13], "dim": 5, "dimens": [3, 5, 8], "dimension": [5, 12, 14], "dimes": 3, "dipol": [10, 13], "direct": 12, "directli": [5, 11, 14], "directori": 14, "disabl": 8, "disk": 5, "displac": [10, 13], "displai": 4, "distanc": [10, 13], "distancematrix": [10, 13], "distribut": [10, 13, 14], "divid": 3, "do": [8, 9], "doc": [3, 8, 9], "docstr": [6, 8, 12], "document": [8, 9, 10, 13, 14], "doe": [0, 3, 4, 6], "don": [9, 11], "done": 3, "doubl": 5, "doubt": 11, "downstream": 12, "dt": 6, "dump": [12, 14], "e": [3, 4, 9, 12, 14], "each": [3, 5, 10, 12, 13, 14], "earli": [9, 10, 13], "easi": 9, "easier": 12, "effect": 3, "effort": 12, "eg": 3, "einstein": [10, 13], "einsteinmsd": [10, 13], "either": [3, 12], "element": 3, "els": [3, 5], "emphais": 2, "emphasis": 2, "empti": 3, "emul": 14, "encapsul": 9, "end": [3, 4], "engag": 9, "environ": [4, 9, 11], "error": [2, 4], "especi": 9, "etc": [2, 14], "even": 14, "everi": 3, "everyth": [5, 11], "evolv": 12, "exactli": 9, "exampl": [1, 2, 4, 9, 14], "execut": [3, 5], "exist": [3, 4, 12], "expect": [3, 4], "experi": 12, "expert": 11, "explain": [9, 14], "explanatori": 9, "extend": [4, 6], "extens": [3, 5], "extra_list": 5, "extract": 6, "f": [1, 12, 14], "face": 12, "fail": [8, 9], "fals": [1, 3], "feedback": 9, "fetch": 9, "ff": 9, "file": [3, 4, 5, 8, 9, 10, 12, 13, 14], "filenam": 4, "filesuffix": [4, 5], "fill": 3, "final": 9, "find": 3, "find_classes_in_modul": 3, "find_cls_memb": 3, "finish": 9, "first": [9, 11], "fix": 8, "flag": [3, 9, 12, 14], "flexibl": 8, "float": [3, 6], "fly": 12, "fname": 5, "follow": [3, 6, 9, 10, 13], "fomat": 5, "forg": [9, 11], "form": 9, "format": [3, 6], "found": [3, 6], "fprefix": 5, "frame": [3, 6, 8, 10, 12, 13], "framework": 12, "friend": 9, "from": [0, 1, 2, 3, 4, 5, 6, 8, 9, 11, 12, 14], "fsuffix": 5, "function": [0, 1, 4, 5, 6, 8, 9, 10, 13, 14], "funtion": 3, "g": 3, "g1": 14, "g2": 14, "gener": [3, 8, 12], "get": 5, "get_1d_arrai": 5, "get_cli_input": 5, "gist": 2, "git": 9, "github": [2, 7, 8, 9, 11], "give": 9, "given": [1, 3, 4, 6, 10, 13], "gnm": [10, 13], "gnmanalysi": [10, 13], "go": 9, "goal": 0, "goe": 9, "good": 9, "got": 5, "grai": 2, "great": 2, "green": 2, "gro": 3, "gromac": [3, 12, 14], "grorup": 3, "group": [3, 10, 13, 14], "guess": 3, "guid": 9, "guidelin": 9, "h": [10, 13, 14], "ha": [3, 5, 6], "handl": 8, "happen": [6, 14], "have": [9, 11, 14], "header": [2, 5, 14], "helan": [10, 13], "helix": [10, 13], "help": [3, 8, 10, 12, 13, 14], "helper": 6, "henrik": 7, "here": 9, "high": [0, 12], "higher": [5, 12, 14], "hole": [10, 13], "holeanalysi": [10, 13], "hopefulli": 9, "how": [3, 9, 12, 14], "howev": [9, 12], "http": [2, 3, 6, 8, 9, 11], "hydrogenbondanalysi": 1, "i": [1, 2, 3, 4, 5, 6, 9, 10, 11, 12, 13, 14], "id": 1, "ignor": [1, 3, 5, 9], "ignore_warn": [1, 3], "implement": 9, "import": [1, 3, 9], "improv": 8, "includ": 3, "incompat": 9, "indent": 5, "indexerror": [3, 6], "individu": [3, 9], "ine": 3, "info": [2, 4, 5], "inform": [3, 6, 10, 13, 14], "init_base_argpars": 3, "initi": [8, 12], "initil": 3, "inludc": 4, "inplac": 3, "input": [3, 5, 6], "insid": [9, 12], "inspect": [6, 12], "inspir": 12, "instal": [8, 10, 13, 14], "instanc": [3, 4, 5], "instead": 0, "instruct": [8, 14], "int": [4, 6], "integ": [6, 8], "integr": [8, 9], "interact": 9, "interfac": [0, 1, 3, 12], "interface_nam": 3, "intermolecular": [10, 13], "intern": 0, "interpret": 9, "interrdf": [10, 13, 14], "interrdf_": 1, "interrdf_count_bins_rdf": 14, "introduc": 8, "is_1d_arrai": 5, "is_2d_arrai": 5, "is_3d_arrai": 5, "is_dimension_arrai": 5, "is_higher_dimension_arrai": 5, "is_serializ": 5, "isort": 8, "issu": [4, 9, 11], "item": 5, "iter": 3, "its": [6, 12, 14], "itself": 12, "janin": [10, 13], "jdict": 5, "joao": 7, "json": [3, 5, 12, 14], "json_dict": 5, "jsonarg": 5, "just": [11, 12], "j\u00e4ger": 7, "kei": [3, 5, 6], "keyword": 3, "klass": 6, "known": 12, "kwarg": 5, "kwargsdict": 3, "lab": 12, "lammp": 3, "last": 9, "later": 11, "least": 12, "length": [3, 5], "level": [0, 4, 8], "libcli": [3, 8], "librari": 12, "like": [5, 9], "lili": 7, "limit": [8, 12], "line": [0, 1, 3, 5, 6, 12, 14], "linear": [10, 13], "lineardens": [10, 13], "link": 8, "lint": 9, "list": [1, 3, 5, 8, 9, 14], "list_1d": 5, "load": 3, "local": 9, "locat": 12, "loch": 7, "log": [0, 3, 14], "log_obj": 4, "logfil": [3, 4, 14], "logger": [4, 8], "logic": [3, 8], "logobj": 4, "long": 8, "loop": 12, "lowercas": 8, "lzabil": 6, "m": [1, 7, 9], "machin": 9, "maco": 8, "madcli": 9, "mai": [3, 9], "maico": 12, "main": [3, 6], "make": [8, 9, 12], "manag": 5, "mandatori": 3, "mandatory_analysis_paramet": 3, "mani": 12, "manual": 8, "map": 5, "mass": 3, "matrix": 8, "md": [10, 13], "mda": [8, 10, 12, 13, 14], "mdacli": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14], "mdacli_result": 5, "mdanalysi": [1, 3, 5, 8, 9, 11, 12, 14], "mean": [10, 13], "member": 3, "merg": 9, "messag": [2, 4, 9, 10, 13], "metavar": 3, "method": [6, 9], "might": 0, "min_ndim": 5, "mock": 1, "mod": 3, "mode": 3, "modul": [1, 3, 8, 14], "module_list": 1, "module_nam": 3, "moment": [10, 13], "more": [8, 10, 12, 13, 14], "most": 9, "move": 8, "multidimension": 5, "must": 3, "my": [2, 9], "myfork": 9, "namd": 3, "name": [1, 3, 4, 5, 6, 8, 9, 10, 13, 14], "namespac": 3, "narg": 3, "ndarrai": [3, 5], "ndim": 5, "need": [0, 3, 8, 9], "new": [3, 8, 12], "next": 9, "nice": 9, "no_entry_sign": 9, "non": 5, "none": [1, 3, 4, 5, 8], "nor": 3, "note": [3, 5], "now": 9, "np": [3, 5], "nt": 8, "num": 5, "number": [5, 6, 8, 14], "numpi": [3, 5], "numpydocstr": 6, "o": 14, "object": [3, 5, 6, 12], "observ": [10, 13], "ok": 2, "oliv": 7, "ommit": 1, "onc": 9, "one": [3, 5], "onli": [0, 3, 4, 9, 10, 13], "onlin": [9, 14], "open": [9, 14], "oper": 5, "option": [3, 5, 8, 14], "option_str": 3, "optional_analysis_paramet": 3, "order": 3, "org": 8, "organ": 5, "origin": 5, "other": 14, "our": [9, 12], "out_extra": 5, "out_list": 5, "output": [3, 14], "output_directori": 3, "output_paramet": 3, "output_prefix": 3, "overview": [10, 13], "ow": 14, "own": [9, 14], "oxygen": 14, "p": 6, "packag": [8, 9], "page": [0, 8, 10, 13, 14], "pair": [10, 13], "pairwis": [10, 13], "paramet": [1, 2, 3, 4, 5, 6, 8, 12, 14], "parent": [3, 12], "pars": [3, 6, 8], "parsabl": 8, "parse_callable_signatur": 6, "parse_doc": 6, "parser": [3, 6, 12], "partial": 3, "pass": [3, 9], "path": 4, "pca": [10, 13], "pdb": 3, "peopl": 12, "per": 3, "perform": [3, 9, 10, 13], "permiss": 8, "persistencelength": 1, "phase": 9, "philip": 7, "pink": 2, "pip": 9, "pipelin": 9, "pkg": 3, "place": 9, "pleas": [9, 11], "pluge": 11, "point": 3, "popul": 3, "posit": 8, "possibl": 3, "possibli": 9, "potenti": 2, "power": 9, "pr": 9, "pre": 14, "prefix": [5, 14], "present": [3, 6, 9], "previou": 9, "princip": [10, 13], "print": [2, 3], "pro": 9, "probabl": [3, 4], "problem": 12, "procedur": 14, "process": [3, 9, 12], "profil": [10, 13], "program": [3, 10, 13], "progress": [10, 13], "project": [10, 12, 13], "proper": 5, "protoread": 3, "provid": [3, 12, 14], "psf": 3, "pullrequest": 9, "push": 9, "py": [8, 9, 11], "py3": 8, "pyproject": 8, "python": [8, 9, 11, 12], "question": 3, "r": 6, "radial": 14, "rais": [3, 6], "ramachandran": [10, 13], "rdf": 14, "read": [3, 9], "reader": 3, "readm": 8, "real": 9, "red": 2, "reenabl": 8, "refer": [0, 3, 8, 9, 10, 13], "reference_univers": 3, "reference_universe_paramet": 3, "reflect": 9, "regex": [6, 8], "regex101": 6, "regular": 0, "regularli": 12, "rel": 3, "relat": [10, 13], "relax": 9, "releas": 8, "remov": [5, 8], "remove_fil": 5, "renam": 8, "replac": 8, "repositori": 11, "requir": [3, 6, 8, 14], "result": [0, 12, 14], "return": [2, 3, 4, 5, 6], "return_with_remov": 5, "review": 9, "right": 9, "rigid": 14, "rm": [10, 13], "rmsd": [10, 13], "rmsf": [10, 13], "root": 4, "routin": 12, "row": [5, 14], "rst": [8, 9], "run": [3, 6, 8, 10, 13, 14], "run_analsi": 8, "run_analysi": [3, 8], "run_paramet": 3, "safe": 9, "same": [3, 5, 9, 11, 12], "sampl": 14, "save": [0, 3, 8, 12, 14], "save_1d_arrai": 5, "save_2d_arrai": 5, "save_3d_arrai": 5, "save_3d_array_to_2d_csv": 5, "save_files_to_zip": 5, "save_higher_dim_arrai": 5, "save_json_serializ": 5, "save_result": 8, "save_result_arrai": 5, "save_results_object": 5, "save_to_json": 5, "savetxt_w_command": 5, "scientist": 12, "script": 12, "search": 3, "see": [2, 3, 6, 9, 14], "select": [3, 10, 12, 13, 14], "select_atom": 3, "seri": 3, "serializ": 5, "serv": 5, "set": [3, 4, 8, 9, 14], "setup": [8, 9, 11], "setup_cli": 3, "setup_log": [4, 8], "sever": 12, "shape": 3, "shortest": 5, "shortli": 9, "should": [1, 3, 9, 11], "show": 12, "signatur": 6, "similar": 14, "simpl": [10, 12, 13, 14], "simplifi": 8, "simul": 12, "sinc": [3, 9, 12], "singl": [3, 5, 8], "skip_mod": 1, "skip_modul": 1, "slightli": 11, "smile": 9, "smile_cat": 9, "so": [6, 9, 11, 12, 14], "solv": 12, "some": [9, 12, 14], "sometim": 12, "sort_kei": 5, "sourc": [1, 2, 3, 4, 5, 6], "spc": 14, "special": 3, "specif": [0, 9], "specifi": [4, 10, 13], "split": [3, 5, 6], "split_argparse_into_group": 3, "split_time_unit": 6, "squar": [10, 13], "squeez": 5, "stack": 5, "stack_1d_arrays_list": 5, "stackoverflow": 3, "stage": [10, 13], "stai": 12, "start": [3, 6, 8, 12], "static": 2, "step": [3, 6, 9], "stop": [3, 8], "storage_dict": 6, "store": [3, 5, 12, 14], "str": [1, 2, 3, 4, 5, 6], "stream": 3, "strict": 6, "string": [1, 2, 3, 5, 6, 14], "structur": [10, 12, 13], "student": 12, "style": [2, 8, 9], "sub": 3, "sub_pars": 3, "subclass": 3, "subdictinari": 6, "submit": 9, "subpars": 3, "subset": 5, "subtitl": 9, "suffix": [3, 4], "suitabl": 3, "summari": 6, "suppli": 3, "support": [0, 8, 10, 13], "syntax": 12, "t": [9, 11], "tabl": [3, 5], "taken": [2, 5], "task": 9, "taurenmd": 12, "teixeira": 7, "term": 3, "termin": 14, "test": 8, "thei": [5, 12], "them": [9, 12], "therefor": 12, "thezip": 5, "thi": [1, 2, 3, 6, 10, 12, 13, 14], "thread": 8, "through": [10, 12, 13], "time": [3, 6, 8, 9], "titl": [3, 9], "togeth": [5, 11, 14], "toml": 8, "tool": [10, 11, 13], "top": 11, "toplevel": 1, "topol": 14, "topolgi": 14, "topologi": [3, 12], "topology_format": 3, "topologyreaderbas": 3, "tox": 8, "tox_": 9, "tpr": 14, "traj": 14, "trajectori": [3, 8, 10, 12, 13, 14], "trajectory_format": 3, "translat": 8, "trr": [3, 14], "true": [1, 5], "try": 5, "try_to_squeeze_m": 5, "tupl": 6, "turquois": 2, "tuvokki": 2, "twice": 9, "two": 14, "txt": 4, "type": [3, 5, 6, 8, 12], "typo": 8, "u": [9, 11], "under": 9, "underlin": 2, "unit": [3, 6], "univers": [3, 12], "up": [1, 3, 9, 12], "updat": [8, 11], "upgrad": 11, "upload": 8, "upstream": 9, "url": 8, "us": [0, 3, 6, 8, 9, 10, 11, 12, 13, 14], "usag": 0, "user": [0, 12], "usernam": 9, "util": 0, "v": 14, "v2": 9, "valu": [5, 6, 8], "valueerror": [3, 6], "variabl": [2, 12], "vebos": 3, "vector": 3, "verbos": [3, 14], "veri": [0, 9, 12], "verifi": 9, "version": [1, 3, 9], "vertic": 5, "via": 9, "volumetr": [10, 13], "vx": 9, "wai": [3, 9, 12], "wang": 7, "want": [0, 11], "warn": [1, 2, 3, 4, 14], "water": 14, "waterbridgeanalysi": 1, "we": [5, 9, 12], "webpag": 7, "welcom": [9, 10, 13], "well": 9, "were": 12, "what": 3, "when": [1, 6, 9], "where": [3, 5, 6], "which": [1, 3, 5, 6, 11, 12], "whole": 9, "window": 8, "wish": 9, "within": 12, "without": [5, 12], "work": [3, 10, 13], "workflow": 9, "wrapper": 12, "write": 12, "x": [5, 6, 9], "x1b": 2, "xdarr": 5, "xplor": 3, "xtc": 3, "xyz": 3, "yai": 2, "yellow": 2, "yet": 6, "you": [9, 11, 14], "your": [10, 11, 13, 14], "zip": [5, 12, 14], "zipit": 5, "zipnam": 5, "\u03c7_1": [10, 13], "\u03c7_2": [10, 13], "\u03c8": [10, 13], "\u03d5": [10, 13]}, "titles": ["API library documentation", "High-Level API", "Coloring", "Support functions for CLI", "Logging", "Results Saving", "Utilities", "Authors", "Changelog", "Contributing", "MDAnalysis command line interface", "Installation", "Philosophy and approach", "MDAnalysis command line interface", "Usage"], "titleterms": {"0": 8, "01": 8, "02": 8, "03": 8, "04": 8, "06": 8, "07": 8, "08": 8, "09": 8, "1": 8, "10": 8, "11": 8, "12": 8, "13": 8, "14": 8, "15": 8, "16": 8, "17": 8, "18": 8, "19": 8, "2": 8, "20": 8, "2021": 8, "2022": 8, "2023": 8, "2024": 8, "21": 8, "22": 8, "23": 8, "24": 8, "25": 8, "26": 8, "27": 8, "28": 8, "29": 8, "3": 8, "30": 8, "31": 8, "32": 8, "4": 8, "5": 8, "6": 8, "7": 8, "8": 8, "9": 8, "add": 9, "api": [0, 1], "approach": 12, "author": 7, "avail": [10, 13], "branch": 9, "chang": 9, "changelog": [8, 9], "cli": 3, "clone": 9, "color": 2, "command": [10, 13], "comput": 9, "conda": 11, "contribut": 9, "creat": 9, "develop": 9, "document": 0, "fork": 9, "function": 3, "high": 1, "instal": [9, 11], "interfac": [10, 13], "level": 1, "librari": 0, "line": [10, 13], "log": 4, "main": 9, "mdanalysi": [10, 13], "modul": [10, 13], "new": 9, "philosophi": 12, "pip": 11, "project": 9, "pull": 9, "remot": 9, "repositori": 9, "request": 9, "result": 5, "run": 9, "save": 5, "start": 9, "support": 3, "test": 9, "thi": 9, "tox": 9, "updat": 9, "usag": 14, "util": 6, "v0": 8, "your": 9}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API library documentation": [[0, "api-library-documentation"]], "Add your fork as remote": [[9, "add-your-fork-as-remote"]], "Authors": [[7, "authors"]], "Available modules": [[10, "available-modules"], [13, "available-modules"]], "Changelog": [[8, "changelog"]], "Clone the main project to your computer": [[9, "clone-the-main-project-to-your-computer"]], "Coloring": [[2, "module-mdacli.colors"]], "Contributing": [[9, "contributing"]], "Create a new branch and start developing": [[9, "create-a-new-branch-and-start-developing"]], "Fork this repository": [[9, "fork-this-repository"]], "High-Level API": [[1, "module-mdacli.cli"]], "Install for developers": [[9, "install-for-developers"]], "Installation": [[11, "installation"]], "Logging": [[4, "module-mdacli.logger"]], "MDAnalysis command line interface": [[10, "mdanalysis-command-line-interface"], [13, "mdanalysis-command-line-interface"]], "Philosophy and approach": [[12, "philosophy-and-approach"]], "Pull Request": [[9, "pull-request"]], "Pull Request your changes": [[9, "pull-request-your-changes"]], "Results Saving": [[5, "module-mdacli.save"]], "Running tests with tox": [[9, "running-tests-with-tox"]], "Support functions for CLI": [[3, "module-mdacli.libcli"]], "Update CHANGELOG": [[9, "update-changelog"]], "Usage": [[14, "usage"]], "Utilities": [[6, "module-mdacli.utils"]], "conda": [[11, "conda"]], "pip": [[11, "pip"]], "v0.1.0 (2021-11-18)": [[8, "v0-1-0-2021-11-18"]], "v0.1.1 (2021-11-18)": [[8, "v0-1-1-2021-11-18"]], "v0.1.10 (2022-01-18)": [[8, "v0-1-10-2022-01-18"]], "v0.1.11 (2022-01-19)": [[8, "v0-1-11-2022-01-19"]], "v0.1.12 (2022-01-19)": [[8, "v0-1-12-2022-01-19"]], "v0.1.13 (2022-02-16)": [[8, "v0-1-13-2022-02-16"]], "v0.1.14 (2022-02-17)": [[8, "v0-1-14-2022-02-17"]], "v0.1.15 (2022-02-25)": [[8, "v0-1-15-2022-02-25"]], "v0.1.16 (2022-02-25)": [[8, "v0-1-16-2022-02-25"]], "v0.1.17 (2022-04-07)": [[8, "v0-1-17-2022-04-07"]], "v0.1.18 (2022-04-12)": [[8, "v0-1-18-2022-04-12"]], "v0.1.19 (2022-04-12)": [[8, "v0-1-19-2022-04-12"]], "v0.1.2 (2021-11-18)": [[8, "v0-1-2-2021-11-18"]], "v0.1.20 (2022-04-13)": [[8, "v0-1-20-2022-04-13"]], "v0.1.21 (2022-04-22)": [[8, "v0-1-21-2022-04-22"]], "v0.1.22 (2023-01-27)": [[8, "v0-1-22-2023-01-27"]], "v0.1.23 (2023-01-27)": [[8, "v0-1-23-2023-01-27"]], "v0.1.24 (2023-01-27)": [[8, "v0-1-24-2023-01-27"]], "v0.1.25 (2023-02-21)": [[8, "v0-1-25-2023-02-21"]], "v0.1.26 (2023-06-27)": [[8, "v0-1-26-2023-06-27"]], "v0.1.27 (2023-08-25)": [[8, "v0-1-27-2023-08-25"]], "v0.1.28 (2023-09-29)": [[8, "v0-1-28-2023-09-29"]], "v0.1.29 (2024-03-21)": [[8, "v0-1-29-2024-03-21"]], "v0.1.3 (2021-11-24)": [[8, "v0-1-3-2021-11-24"]], "v0.1.30 (2024-04-03)": [[8, "v0-1-30-2024-04-03"]], "v0.1.31 (2024-07-08)": [[8, "v0-1-31-2024-07-08"]], "v0.1.4 (2021-11-24)": [[8, "v0-1-4-2021-11-24"]], "v0.1.5 (2021-12-01)": [[8, "v0-1-5-2021-12-01"]], "v0.1.6 (2021-12-01)": [[8, "v0-1-6-2021-12-01"]], "v0.1.7 (2021-12-18)": [[8, "v0-1-7-2021-12-18"]], "v0.1.8 (2022-01-16)": [[8, "v0-1-8-2022-01-16"]], "v0.1.9 (2022-01-16)": [[8, "v0-1-9-2022-01-16"]]}, "docnames": ["api", "api/cli", "api/colors", "api/libcli", "api/logger", "api/save", "api/utils", "authors", "changelog", "contributing", "index", "installation", "philosophy", "readme", "usage"], "envversion": {"sphinx": 61, "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.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "api/cli.rst", "api/colors.rst", "api/libcli.rst", "api/logger.rst", "api/save.rst", "api/utils.rst", "authors.rst", "changelog.rst", "contributing.rst", "index.rst", "installation.rst", "philosophy.rst", "readme.rst", "usage.rst"], "indexentries": {"add_cli_universe() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_cli_universe", false]], "add_output_group() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_output_group", false]], "add_run_group() (in module mdacli.libcli)": [[3, "mdacli.libcli.add_run_group", false]], "blue (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.blue", false]], "bold (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.bold", false]], "cli() (in module mdacli.cli)": [[1, "mdacli.cli.cli", false]], "convert_analysis_parameters() (in module mdacli.libcli)": [[3, "mdacli.libcli.convert_analysis_parameters", false]], "convert_str_time() (in module mdacli.utils)": [[6, "mdacli.utils.convert_str_time", false]], "create_cli() (in module mdacli.libcli)": [[3, "mdacli.libcli.create_cli", false]], "create_universe() (in module mdacli.libcli)": [[3, "mdacli.libcli.create_universe", false]], "debug() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.debug", false]], "emphasise (class in mdacli.colors)": [[2, "mdacli.colors.Emphasise", false]], "emphasise() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.emphasise", false]], "error() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.error", false]], "find_classes_in_modules() (in module mdacli.libcli)": [[3, "mdacli.libcli.find_classes_in_modules", false]], "find_cls_members() (in module mdacli.libcli)": [[3, "mdacli.libcli.find_cls_members", false]], "get_1d_arrays() (in module mdacli.save)": [[5, "mdacli.save.get_1D_arrays", false]], "get_cli_input() (in module mdacli.save)": [[5, "mdacli.save.get_cli_input", false]], "gray (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.gray", false]], "green (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.green", false]], "header() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.header", false]], "info() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.info", false]], "init_base_argparse() (in module mdacli.libcli)": [[3, "mdacli.libcli.init_base_argparse", false]], "is_1d_array() (in module mdacli.save)": [[5, "mdacli.save.is_1d_array", false]], "is_2d_array() (in module mdacli.save)": [[5, "mdacli.save.is_2d_array", false]], "is_3d_array() (in module mdacli.save)": [[5, "mdacli.save.is_3d_array", false]], "is_dimension_array() (in module mdacli.save)": [[5, "mdacli.save.is_dimension_array", false]], "is_higher_dimension_array() (in module mdacli.save)": [[5, "mdacli.save.is_higher_dimension_array", false]], "is_serializable() (in module mdacli.save)": [[5, "mdacli.save.is_serializable", false]], "kwargsdict (class in mdacli.libcli)": [[3, "mdacli.libcli.KwargsDict", false]], "mdacli.cli": [[1, "module-mdacli.cli", false]], "mdacli.colors": [[2, "module-mdacli.colors", false]], "mdacli.libcli": [[3, "module-mdacli.libcli", false]], "mdacli.logger": [[4, "module-mdacli.logger", false]], "mdacli.save": [[5, "module-mdacli.save", false]], "mdacli.utils": [[6, "module-mdacli.utils", false]], "module": [[1, "module-mdacli.cli", false], [2, "module-mdacli.colors", false], [3, "module-mdacli.libcli", false], [4, "module-mdacli.logger", false], [5, "module-mdacli.save", false], [6, "module-mdacli.utils", false]], "ok() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.ok", false]], "parse_callable_signature() (in module mdacli.utils)": [[6, "mdacli.utils.parse_callable_signature", false]], "parse_docs() (in module mdacli.utils)": [[6, "mdacli.utils.parse_docs", false]], "pink (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.pink", false]], "red (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.red", false]], "remove_files() (in module mdacli.save)": [[5, "mdacli.save.remove_files", false]], "return_with_remove() (in module mdacli.save)": [[5, "mdacli.save.return_with_remove", false]], "run_analysis() (in module mdacli.libcli)": [[3, "mdacli.libcli.run_analysis", false]], "save() (in module mdacli.save)": [[5, "mdacli.save.save", false]], "save_1d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_1D_arrays", false]], "save_2d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_2D_arrays", false]], "save_3d_array_to_2d_csv() (in module mdacli.save)": [[5, "mdacli.save.save_3D_array_to_2D_csv", false]], "save_3d_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_3D_arrays", false]], "save_files_to_zip() (in module mdacli.save)": [[5, "mdacli.save.save_files_to_zip", false]], "save_higher_dim_arrays() (in module mdacli.save)": [[5, "mdacli.save.save_higher_dim_arrays", false]], "save_json_serializables() (in module mdacli.save)": [[5, "mdacli.save.save_json_serializables", false]], "save_result_array() (in module mdacli.save)": [[5, "mdacli.save.save_result_array", false]], "save_results_object() (in module mdacli.save)": [[5, "mdacli.save.save_Results_object", false]], "save_to_json() (in module mdacli.save)": [[5, "mdacli.save.save_to_json", false]], "savetxt_w_command() (in module mdacli.save)": [[5, "mdacli.save.savetxt_w_command", false]], "setup_clients() (in module mdacli.libcli)": [[3, "mdacli.libcli.setup_clients", false]], "setup_logging() (in module mdacli.logger)": [[4, "mdacli.logger.setup_logging", false]], "split_argparse_into_groups() (in module mdacli.libcli)": [[3, "mdacli.libcli.split_argparse_into_groups", false]], "split_time_unit() (in module mdacli.utils)": [[6, "mdacli.utils.split_time_unit", false]], "stack_1d_arrays_list() (in module mdacli.save)": [[5, "mdacli.save.stack_1d_arrays_list", false]], "try_to_squeeze_me() (in module mdacli.save)": [[5, "mdacli.save.try_to_squeeze_me", false]], "turquoise (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.turquoise", false]], "underline (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.underline", false]], "warning() (mdacli.colors.emphasise static method)": [[2, "mdacli.colors.Emphasise.warning", false]], "yellow (mdacli.colors.emphasise attribute)": [[2, "mdacli.colors.Emphasise.yellow", false]]}, "objects": {"mdacli": [[1, 0, 0, "-", "cli"], [2, 0, 0, "-", "colors"], [3, 0, 0, "-", "libcli"], [4, 0, 0, "-", "logger"], [5, 0, 0, "-", "save"], [6, 0, 0, "-", "utils"]], "mdacli.cli": [[1, 1, 1, "", "cli"]], "mdacli.colors": [[2, 2, 1, "", "Emphasise"]], "mdacli.colors.Emphasise": [[2, 3, 1, "", "blue"], [2, 3, 1, "", "bold"], [2, 4, 1, "", "debug"], [2, 4, 1, "", "emphasise"], [2, 4, 1, "", "error"], [2, 3, 1, "", "gray"], [2, 3, 1, "", "green"], [2, 4, 1, "", "header"], [2, 4, 1, "", "info"], [2, 4, 1, "", "ok"], [2, 3, 1, "", "pink"], [2, 3, 1, "", "red"], [2, 3, 1, "", "turquoise"], [2, 3, 1, "", "underline"], [2, 4, 1, "", "warning"], [2, 3, 1, "", "yellow"]], "mdacli.libcli": [[3, 2, 1, "", "KwargsDict"], [3, 1, 1, "", "add_cli_universe"], [3, 1, 1, "", "add_output_group"], [3, 1, 1, "", "add_run_group"], [3, 1, 1, "", "convert_analysis_parameters"], [3, 1, 1, "", "create_cli"], [3, 1, 1, "", "create_universe"], [3, 1, 1, "", "find_classes_in_modules"], [3, 1, 1, "", "find_cls_members"], [3, 1, 1, "", "init_base_argparse"], [3, 1, 1, "", "run_analysis"], [3, 1, 1, "", "setup_clients"], [3, 1, 1, "", "split_argparse_into_groups"]], "mdacli.logger": [[4, 1, 1, "", "setup_logging"]], "mdacli.save": [[5, 1, 1, "", "get_1D_arrays"], [5, 1, 1, "", "get_cli_input"], [5, 1, 1, "", "is_1d_array"], [5, 1, 1, "", "is_2d_array"], [5, 1, 1, "", "is_3d_array"], [5, 1, 1, "", "is_dimension_array"], [5, 1, 1, "", "is_higher_dimension_array"], [5, 1, 1, "", "is_serializable"], [5, 1, 1, "", "remove_files"], [5, 1, 1, "", "return_with_remove"], [5, 1, 1, "", "save"], [5, 1, 1, "", "save_1D_arrays"], [5, 1, 1, "", "save_2D_arrays"], [5, 1, 1, "", "save_3D_array_to_2D_csv"], [5, 1, 1, "", "save_3D_arrays"], [5, 1, 1, "", "save_Results_object"], [5, 1, 1, "", "save_files_to_zip"], [5, 1, 1, "", "save_higher_dim_arrays"], [5, 1, 1, "", "save_json_serializables"], [5, 1, 1, "", "save_result_array"], [5, 1, 1, "", "save_to_json"], [5, 1, 1, "", "savetxt_w_command"], [5, 1, 1, "", "stack_1d_arrays_list"], [5, 1, 1, "", "try_to_squeeze_me"]], "mdacli.utils": [[6, 1, 1, "", "convert_str_time"], [6, 1, 1, "", "parse_callable_signature"], [6, 1, 1, "", "parse_docs"], [6, 1, 1, "", "split_time_unit"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "terms": {"": [3, 6, 9, 12, 14], "0": 3, "01": 9, "1": [2, 3, 5], "109": 8, "114": 8, "140423703360128": 1, "14deb97bef6df9bc6553": 2, "1900": 9, "1d": [5, 12], "1darrai": 5, "1m": 2, "2": [5, 6], "2d": [5, 12], "2darr": 5, "2nd": 14, "3": [3, 5], "30": 4, "31519997": 3, "3d": 5, "3darr": 5, "3rd": 14, "4": [5, 14], "4m": 2, "6": 3, "65": 8, "68": 8, "70": 8, "75": 8, "78": 8, "80": 8, "81": 8, "82": 8, "83": 8, "85": 8, "86": 8, "88": 8, "90": 3, "90m": 2, "91m": 2, "92m": 2, "93m": 2, "94m": 2, "95m": 2, "96m": 2, "A": [0, 3, 4, 5, 6, 10, 12, 13, 14], "For": [4, 9, 10, 13, 14], "If": [3, 4, 5, 6, 9, 11, 12], "It": 9, "Not": 9, "One": 6, "Or": 11, "That": 9, "The": [0, 1, 2, 3, 5, 6, 9, 12, 14], "These": 9, "To": [10, 11, 13, 14], "With": 12, "__all__": 1, "__authors__": 8, "__doc__": 1, "__init__": 6, "__version__": 1, "about": [5, 10, 13, 14], "absolut": 3, "accept": 9, "accor": 5, "accord": 3, "accordingli": 8, "account": 9, "achiev": 14, "across": [10, 13], "action": [8, 9], "activ": 11, "actual": [3, 12, 14], "ad": [3, 6, 8, 12], "add": [3, 5, 8], "add_argu": 8, "add_cli_univers": 3, "add_output_group": 3, "add_run_group": 3, "addit": [5, 9, 14], "adjust": 12, "advanc": 0, "after": [3, 9, 14], "align": [10, 13], "aligntraj": [10, 13], "all": [3, 5, 9, 12, 14], "allow": 8, "along": 5, "alreadi": [6, 9, 11], "also": [3, 9, 11, 12, 14], "altern": 3, "alwai": 9, "an": [3, 6, 9, 10, 12, 13, 14], "analysi": [1, 3, 5, 8, 10, 12, 13, 14], "analysis_cal": 3, "analysis_class_pars": 3, "analysis_paramet": 3, "analysisbas": [1, 3, 12], "analysisfromfunct": 1, "analyz": 12, "anaylsi": 1, "anaylysi": 3, "angl": [3, 10, 13], "ani": [3, 6, 9, 11, 12], "anlysi": 3, "ap": 3, "appear": 9, "appli": [5, 9, 12], "ar": [3, 4, 5, 6, 9, 10, 11, 12, 13, 14], "archiv": 5, "arg": 8, "arg_grouped_dict": 3, "argpars": [3, 10, 12, 13], "argument": [3, 8, 12], "argumentpars": 3, "argumentspars": 3, "around": 12, "arr": 5, "arr_nam": 5, "arrai": [5, 12, 14], "ask": 14, "assert": 5, "assum": 6, "atom": [3, 10, 13, 14], "atom_styl": 3, "atomgroup": [3, 8, 10, 13, 14], "attempt": 3, "attract": 12, "attribut": [2, 5], "author": 9, "automat": [11, 12], "avail": [2, 3, 14], "averag": [10, 13], "averagestructur": [10, 13], "avoid": 9, "b": 9, "banner": 8, "bare": 14, "base": [1, 3, 5, 6, 8, 9, 10, 12, 13], "base_class": 1, "basic": [3, 10, 13], "bcolor": 2, "becaus": [3, 9], "beckstein": 7, "befor": 9, "begin": 3, "bellow": 9, "belong": [1, 3], "between": [10, 13, 14], "blue": 2, "bold": 2, "bond": 3, "bool": [1, 3, 5], "boolean": 8, "both": 12, "box": 8, "build": [1, 9, 12], "bullet": 9, "bump2vers": 8, "bumpvers": 8, "bunch": 14, "c": [7, 9, 11], "calcul": [10, 13, 14], "callabl": 6, "callable_obj": 6, "can": [3, 6, 9, 11, 12, 14], "canon": 8, "case": 9, "categori": 3, "cd": 9, "cell": 3, "certain": [3, 5], "certifi": 9, "cfg": 8, "chain": 3, "challeng": 12, "chang": [3, 8, 14], "charg": 3, "charmm": 3, "check": [5, 8], "checkout": 9, "choic": [3, 8], "ci": [8, 9], "cl": [1, 3], "class": [1, 2, 3, 6, 8, 10, 12, 13, 14], "classifi": 8, "clever": 12, "cli": [0, 1, 6, 8, 10, 12, 13], "cli_pars": 3, "client": [3, 14], "clone": 11, "close": [10, 13], "closecontactgnmanalysi": [10, 13], "code": [1, 9, 12], "codebas": 12, "codecov": 8, "color": 0, "column": 14, "com": [2, 3, 6, 9, 11], "combin": [6, 12], "command": [0, 1, 3, 5, 9, 12, 14], "commit": 9, "commun": 9, "complet": 8, "complex": 14, "compon": [10, 13], "compress": 5, "comput": [10, 13], "conda": [8, 9], "conflict": 9, "const": 3, "contact": [1, 10, 11, 13], "contain": [1, 3, 5, 6, 12, 14], "continu": 9, "contribut": [8, 10, 13], "contributor": 9, "conveni": 6, "convert": [3, 6, 8], "convert_analysis_paramet": 3, "convert_str_tim": 6, "coordin": [3, 10, 13], "copi": 12, "core": [3, 12], "correct": [3, 8, 9], "correctli": 9, "correspond": [5, 14], "could": [2, 3, 6, 12], "crd": 3, "creat": [1, 3, 4, 5, 12], "create_cli": [3, 8], "create_univers": 3, "creation": [3, 6, 8], "csv": [5, 12, 14], "current": [10, 13, 14], "custom": 3, "customis": 3, "dai": 12, "danger": 2, "data": [3, 5, 12, 14], "dcd": 3, "ddict": 5, "debug": [2, 3, 4, 8, 14], "decor": 2, "decorated_messag": 2, "default": [3, 5, 14], "defin": [3, 5], "degre": 3, "densiti": [10, 13], "densityanalysi": [10, 13], "dep": [9, 11], "depend": [8, 11], "deploi": 8, "deploy": 8, "desc": 6, "describ": 9, "descript": [1, 3, 6, 8, 10, 13], "design": 3, "desir": 2, "dest": 3, "detail": [4, 6, 14], "detect": [8, 12], "develop": [0, 10, 11, 12, 13], "dict": [3, 5, 6], "dictionari": [3, 5, 6, 12], "did": 9, "dielectricconst": [10, 13], "dihedr": [1, 8, 10, 13], "dim": 5, "dimens": [3, 5, 8], "dimension": [5, 12, 14], "dimes": 3, "dipol": [10, 13], "direct": 12, "directli": [5, 11, 14], "directori": 14, "disabl": 8, "disk": 5, "displac": [10, 13], "displai": 4, "distanc": [10, 13], "distancematrix": [10, 13], "distribut": [10, 13, 14], "divid": 3, "do": [8, 9], "doc": [3, 8, 9], "docstr": [6, 8, 12], "document": [8, 9, 10, 13, 14], "doe": [0, 3, 6], "don": [9, 11], "done": 3, "doubl": 5, "doubt": 11, "downstream": 12, "dt": 6, "dump": [12, 14], "e": [3, 9, 12, 14], "each": [3, 5, 10, 12, 13, 14], "earli": [9, 10, 13], "easi": 9, "easier": 12, "effect": 3, "effort": 12, "eg": 3, "einstein": [10, 13], "einsteinmsd": [10, 13], "either": [3, 12], "element": 3, "els": [3, 5], "emphais": 2, "emphasis": 2, "empti": 3, "emul": 14, "encapsul": 9, "end": 3, "engag": 9, "environ": [4, 9, 11], "error": [2, 4], "especi": 9, "etc": [2, 14], "even": 14, "everi": 3, "everyth": [5, 11], "evolv": 12, "exactli": 9, "exampl": [1, 2, 4, 9, 14], "execut": [3, 5], "exist": [3, 12], "expect": 3, "experi": 12, "expert": 11, "explain": [9, 14], "explanatori": 9, "extend": 6, "extens": [3, 5], "extra_list": 5, "extract": 6, "f": [1, 12, 14], "face": 12, "fail": [8, 9], "fals": [1, 3], "feedback": 9, "fetch": 9, "ff": 9, "file": [3, 4, 5, 8, 9, 10, 12, 13, 14], "filenam": 4, "filesuffix": 5, "fill": 3, "final": 9, "find": 3, "find_classes_in_modul": 3, "find_cls_memb": 3, "finish": 9, "first": [9, 11], "fix": 8, "flag": [3, 9, 12, 14], "flexibl": 8, "float": [3, 6], "fly": 12, "fname": 5, "follow": [3, 6, 9, 10, 13], "fomat": 5, "forg": [9, 11], "form": 9, "format": [3, 6], "found": [3, 6], "fprefix": 5, "frame": [3, 6, 8, 10, 12, 13], "framework": 12, "friend": 9, "from": [0, 1, 2, 3, 4, 5, 6, 8, 9, 11, 12, 14], "fsuffix": 5, "function": [0, 1, 4, 5, 6, 9, 10, 13, 14], "funtion": 3, "g": 3, "g1": 14, "g2": 14, "gener": [3, 8, 12], "get": 5, "get_1d_arrai": 5, "get_cli_input": 5, "gist": 2, "git": 9, "github": [2, 7, 8, 9, 11], "give": 9, "given": [1, 3, 4, 6, 10, 13], "gnm": [10, 13], "gnmanalysi": [10, 13], "go": 9, "goal": 0, "goe": 9, "good": 9, "got": 5, "grai": 2, "great": 2, "green": 2, "gro": 3, "gromac": [3, 12, 14], "grorup": 3, "group": [3, 10, 13, 14], "guess": 3, "guid": 9, "guidelin": 9, "h": [10, 13, 14], "ha": [3, 5, 6], "handl": 8, "happen": [6, 14], "have": [9, 11, 14], "header": [2, 5, 14], "helan": [10, 13], "helix": [10, 13], "help": [3, 8, 10, 12, 13, 14], "helper": 6, "henrik": 7, "here": 9, "high": [0, 12], "higher": [5, 12, 14], "hole": [10, 13], "holeanalysi": [10, 13], "hopefulli": 9, "how": [3, 9, 12, 14], "howev": [9, 12], "http": [2, 3, 6, 8, 9, 11], "hydrogenbondanalysi": 1, "i": [1, 2, 3, 5, 6, 9, 10, 11, 12, 13, 14], "id": 1, "ignor": [1, 3, 5, 9], "ignore_warn": [1, 3], "implement": 9, "import": [1, 3, 9], "improv": 8, "includ": 3, "incompat": 9, "indent": 5, "indexerror": [3, 6], "individu": [3, 9], "ine": 3, "info": [2, 4, 5], "inform": [3, 6, 10, 13, 14], "init_base_argpars": 3, "initi": [8, 12], "initil": 3, "inludc": 4, "inplac": 3, "input": [3, 5, 6], "insid": [9, 12], "inspect": [6, 12], "inspir": 12, "instal": [8, 10, 13, 14], "instanc": [3, 4, 5], "instead": 0, "instruct": [8, 14], "int": [4, 6], "integ": [6, 8], "integr": [8, 9], "interact": 9, "interfac": [0, 1, 3, 12], "interface_nam": 3, "intermolecular": [10, 13], "intern": 0, "interpret": 9, "interrdf": [10, 13, 14], "interrdf_": 1, "interrdf_count_bins_rdf": 14, "introduc": 8, "is_1d_arrai": 5, "is_2d_arrai": 5, "is_3d_arrai": 5, "is_dimension_arrai": 5, "is_higher_dimension_arrai": 5, "is_serializ": 5, "isort": 8, "issu": [9, 11], "item": 5, "iter": 3, "its": [6, 12, 14], "itself": 12, "janin": [10, 13], "jdict": 5, "joao": 7, "json": [3, 5, 12, 14], "json_dict": 5, "jsonarg": 5, "just": [11, 12], "j\u00e4ger": 7, "kei": [3, 5, 6], "keyword": 3, "klass": 6, "known": 12, "kwarg": 5, "kwargsdict": 3, "lab": 12, "lammp": 3, "last": 9, "later": 11, "least": 12, "length": [3, 5], "level": [0, 4, 8], "libcli": [3, 8], "librari": 12, "like": [5, 9], "lili": 7, "limit": [8, 12], "line": [0, 1, 3, 5, 6, 12, 14], "linear": [10, 13], "lineardens": [10, 13], "link": 8, "lint": 9, "list": [1, 3, 5, 8, 9, 14], "list_1d": 5, "load": 3, "local": 9, "locat": 12, "loch": 7, "log": [0, 3, 14], "logfil": [3, 4, 14], "logger": 4, "logic": [3, 8], "logobj": 4, "long": 8, "loop": 12, "lowercas": 8, "lzabil": 6, "m": [1, 7, 9], "machin": 9, "maco": 8, "madcli": 9, "mai": [3, 9], "maico": 12, "main": [3, 6], "make": [8, 9, 12], "manag": 5, "mandatori": 3, "mandatory_analysis_paramet": 3, "mani": 12, "manual": 8, "map": 5, "mass": 3, "matrix": 8, "md": [10, 13], "mda": [8, 10, 12, 13, 14], "mdacli": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14], "mdacli_result": 5, "mdanalysi": [1, 3, 5, 8, 9, 11, 12, 14], "mean": [10, 13], "member": 3, "merg": 9, "messag": [2, 4, 9, 10, 13], "metavar": 3, "method": [6, 9], "might": 0, "min_ndim": 5, "mock": 1, "mod": 3, "mode": 3, "modul": [1, 3, 8, 14], "module_list": 1, "module_nam": 3, "moment": [10, 13], "more": [8, 10, 12, 13, 14], "most": 9, "move": 8, "multidimension": 5, "must": 3, "my": [2, 9], "myfork": 9, "namd": 3, "name": [1, 3, 4, 5, 6, 8, 9, 10, 13, 14], "namespac": 3, "narg": 3, "ndarrai": [3, 5], "ndim": 5, "need": [0, 3, 8, 9], "new": [3, 8, 12], "next": 9, "nice": 9, "no_entry_sign": 9, "non": 5, "none": [1, 3, 4, 5, 8], "nor": 3, "note": [3, 5], "now": 9, "np": [3, 5], "nt": 8, "num": 5, "number": [5, 6, 8, 14], "numpi": [3, 5], "numpydocstr": 6, "o": 14, "obj": 4, "object": [3, 5, 6, 12], "observ": [10, 13], "ok": 2, "oliv": 7, "ommit": 1, "onc": 9, "one": [3, 5], "onli": [0, 3, 4, 9, 10, 13], "onlin": [9, 14], "open": [9, 14], "oper": 5, "option": [3, 5, 8, 14], "option_str": 3, "optional_analysis_paramet": 3, "order": 3, "org": 8, "organ": 5, "origin": 5, "other": 14, "our": [9, 12], "out_extra": 5, "out_list": 5, "output": [3, 14], "output_directori": 3, "output_paramet": 3, "output_prefix": 3, "overview": [10, 13], "ow": 14, "own": [9, 14], "oxygen": 14, "p": 6, "packag": [8, 9], "page": [0, 8, 10, 13, 14], "pair": [10, 13], "pairwis": [10, 13], "paramet": [1, 2, 3, 4, 5, 6, 8, 12, 14], "parent": [3, 12], "pars": [3, 6, 8], "parsabl": 8, "parse_callable_signatur": 6, "parse_doc": 6, "parser": [3, 6, 12], "partial": 3, "pass": [3, 9], "pca": [10, 13], "pdb": 3, "peopl": 12, "per": 3, "perform": [3, 9, 10, 13], "permiss": 8, "persistencelength": 1, "phase": 9, "philip": 7, "pink": 2, "pip": 9, "pipelin": 9, "pkg": 3, "place": 9, "pleas": [9, 11], "pluge": 11, "point": 3, "popul": 3, "posit": 8, "possibl": 3, "possibli": 9, "potenti": 2, "power": 9, "pr": 9, "pre": 14, "prefix": [5, 14], "present": [3, 6, 9], "previou": 9, "princip": [10, 13], "print": [2, 3], "pro": 9, "probabl": 3, "problem": 12, "procedur": 14, "process": [3, 9, 12], "profil": [10, 13], "program": [3, 10, 13], "progress": [10, 13], "project": [10, 12, 13], "proper": 5, "protoread": 3, "provid": [3, 12, 14], "psf": 3, "pullrequest": 9, "push": 9, "py": [4, 8, 9, 11], "py3": 8, "pyproject": 8, "python": [8, 9, 11, 12], "question": 3, "r": 6, "radial": 14, "rais": [3, 6], "ramachandran": [10, 13], "rdf": 14, "read": [3, 9], "reader": 3, "readm": 8, "real": 9, "red": 2, "reenabl": 8, "refer": [0, 3, 8, 9, 10, 13], "reference_univers": 3, "reference_universe_paramet": 3, "reflect": 9, "regex": [6, 8], "regex101": 6, "regular": 0, "regularli": 12, "rel": 3, "relat": [10, 13], "relax": 9, "releas": 8, "remov": [5, 8], "remove_fil": 5, "renam": 8, "replac": 8, "repositori": 11, "requir": [3, 6, 8, 14], "result": [0, 12, 14], "return": [2, 3, 5, 6], "return_with_remov": 5, "review": 9, "right": 9, "rigid": 14, "rm": [10, 13], "rmsd": [10, 13], "rmsf": [10, 13], "root": 4, "routin": 12, "row": [5, 14], "rst": [8, 9], "run": [3, 6, 8, 10, 13, 14], "run_analsi": 8, "run_analysi": [3, 8], "run_paramet": 3, "safe": 9, "same": [3, 5, 9, 11, 12], "sampl": 14, "save": [0, 3, 8, 12, 14], "save_1d_arrai": 5, "save_2d_arrai": 5, "save_3d_arrai": 5, "save_3d_array_to_2d_csv": 5, "save_files_to_zip": 5, "save_higher_dim_arrai": 5, "save_json_serializ": 5, "save_result": 8, "save_result_arrai": 5, "save_results_object": 5, "save_to_json": 5, "savetxt_w_command": 5, "scientist": 12, "script": 12, "search": 3, "see": [2, 3, 6, 9, 14], "select": [3, 10, 12, 13, 14], "select_atom": 3, "seri": 3, "serializ": 5, "serv": 5, "set": [3, 4, 8, 9, 14], "setup": [8, 9, 11], "setup_cli": 3, "setup_log": [4, 8], "sever": 12, "shape": 3, "shortest": 5, "shortli": 9, "should": [1, 3, 9, 11], "show": 12, "signatur": 6, "similar": 14, "simpl": [10, 12, 13, 14], "simplifi": 8, "simul": 12, "sinc": [3, 9, 12], "singl": [3, 5, 8], "skip_mod": 1, "skip_modul": 1, "slightli": 11, "smile": 9, "smile_cat": 9, "so": [6, 9, 11, 12, 14], "solv": 12, "some": [9, 12, 14], "sometim": 12, "sort_kei": 5, "sourc": [1, 2, 3, 4, 5, 6], "spc": 14, "special": 3, "specif": [0, 9], "specifi": [4, 10, 13], "split": [3, 5, 6], "split_argparse_into_group": 3, "split_time_unit": 6, "squar": [10, 13], "squeez": 5, "stack": 5, "stack_1d_arrays_list": 5, "stackoverflow": 3, "stage": [10, 13], "stai": 12, "start": [3, 6, 8, 12], "static": 2, "step": [3, 6, 9], "stop": [3, 8], "storage_dict": 6, "store": [3, 5, 12, 14], "str": [1, 2, 3, 4, 5, 6], "stream": 3, "strict": 6, "string": [1, 2, 3, 5, 6, 14], "structur": [10, 12, 13], "student": 12, "style": [2, 8, 9], "sub": 3, "sub_pars": 3, "subclass": 3, "subdictinari": 6, "submit": 9, "subpars": 3, "subset": 5, "subtitl": 9, "suffix": 3, "suitabl": 3, "summari": 6, "suppli": 3, "support": [0, 8, 10, 13], "syntax": 12, "t": [9, 11], "tabl": [3, 5], "taken": [2, 5], "task": 9, "taurenmd": 12, "teixeira": 7, "term": 3, "termin": 14, "test": 8, "thei": [5, 12], "them": [9, 12], "therefor": 12, "thezip": 5, "thi": [1, 2, 3, 6, 10, 12, 13, 14], "thread": 8, "through": [10, 12, 13], "time": [3, 6, 8, 9], "titl": [3, 9], "togeth": [5, 11, 14], "toml": 8, "tool": [10, 11, 13], "top": 11, "toplevel": 1, "topol": 14, "topolgi": 14, "topologi": [3, 12], "topology_format": 3, "topologyreaderbas": 3, "tox": 8, "tox_": 9, "tpr": 14, "traj": 14, "trajectori": [3, 8, 10, 12, 13, 14], "trajectory_format": 3, "translat": 8, "trr": [3, 14], "true": [1, 5], "try": 5, "try_to_squeeze_m": 5, "tupl": 6, "turquois": 2, "tuvokki": 2, "twice": 9, "two": 14, "type": [3, 5, 6, 8, 12], "typo": 8, "u": [9, 11], "under": 9, "underlin": 2, "unit": [3, 6], "univers": [3, 12], "up": [1, 3, 9, 12], "updat": [8, 11], "upgrad": 11, "upload": 8, "upstream": 9, "url": 8, "us": [0, 3, 6, 8, 9, 10, 11, 12, 13, 14], "usag": 0, "user": [0, 12], "usernam": 9, "util": 0, "v": 14, "v2": 9, "valu": [5, 6, 8], "valueerror": [3, 6], "variabl": [2, 12], "vebos": 3, "vector": 3, "verbos": [3, 14], "veri": [0, 9, 12], "verifi": 9, "version": [1, 3, 9], "vertic": 5, "via": 9, "volumetr": [10, 13], "vx": 9, "wai": [3, 9, 12], "wang": 7, "want": [0, 11], "warn": [1, 2, 3, 4, 14], "water": 14, "waterbridgeanalysi": 1, "we": [5, 9, 12], "webpag": 7, "welcom": [9, 10, 13], "well": 9, "were": 12, "what": 3, "when": [1, 6, 9], "where": [3, 5, 6], "which": [1, 3, 5, 6, 11, 12], "whole": 9, "window": 8, "wish": 9, "within": 12, "without": [5, 12], "work": [3, 10, 13], "workflow": 9, "wrapper": 12, "write": 12, "x": [5, 6, 9], "x1b": 2, "xdarr": 5, "xplor": 3, "xtc": 3, "xyz": 3, "yai": 2, "yellow": 2, "yet": 6, "you": [9, 11, 14], "your": [10, 11, 13, 14], "zip": [5, 12, 14], "zipit": 5, "zipnam": 5, "\u03c7_1": [10, 13], "\u03c7_2": [10, 13], "\u03c8": [10, 13], "\u03d5": [10, 13]}, "titles": ["API library documentation", "High-Level API", "Coloring", "Support functions for CLI", "Logging", "Results Saving", "Utilities", "Authors", "Changelog", "Contributing", "MDAnalysis command line interface", "Installation", "Philosophy and approach", "MDAnalysis command line interface", "Usage"], "titleterms": {"0": 8, "01": 8, "02": 8, "03": 8, "04": 8, "06": 8, "07": 8, "08": 8, "09": 8, "1": 8, "10": 8, "11": 8, "12": 8, "13": 8, "14": 8, "15": 8, "16": 8, "17": 8, "18": 8, "19": 8, "2": 8, "20": 8, "2021": 8, "2022": 8, "2023": 8, "2024": 8, "21": 8, "22": 8, "23": 8, "24": 8, "25": 8, "26": 8, "27": 8, "28": 8, "29": 8, "3": 8, "30": 8, "31": 8, "4": 8, "5": 8, "6": 8, "7": 8, "8": 8, "9": 8, "add": 9, "api": [0, 1], "approach": 12, "author": 7, "avail": [10, 13], "branch": 9, "chang": 9, "changelog": [8, 9], "cli": 3, "clone": 9, "color": 2, "command": [10, 13], "comput": 9, "conda": 11, "contribut": 9, "creat": 9, "develop": 9, "document": 0, "fork": 9, "function": 3, "high": 1, "instal": [9, 11], "interfac": [10, 13], "level": 1, "librari": 0, "line": [10, 13], "log": 4, "main": 9, "mdanalysi": [10, 13], "modul": [10, 13], "new": 9, "philosophi": 12, "pip": 11, "project": 9, "pull": 9, "remot": 9, "repositori": 9, "request": 9, "result": 5, "run": 9, "save": 5, "start": 9, "support": 3, "test": 9, "thi": 9, "tox": 9, "updat": 9, "usag": 14, "util": 6, "v0": 8, "your": 9}}) \ No newline at end of file diff --git a/stable/sitemap.xml b/stable/sitemap.xml index 40091ea..deecdff 100644 --- a/stable/sitemap.xml +++ b/stable/sitemap.xml @@ -1,2 +1,2 @@ -https://mdacli.mdanalysis.org/en/0.1.32/api.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/api/cli.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/api/colors.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/api/libcli.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/api/logger.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/api/save.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/api/utils.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/authors.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/changelog.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/contributing.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/index.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/installation.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/philosophy.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/readme.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/usage.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/genindex.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/py-modindex.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/mdacli/cli.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/mdacli/colors.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/mdacli/libcli.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/mdacli/logger.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/mdacli/save.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/mdacli/utils.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/_modules/index.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/search.htmlhttps://mdacli.mdanalysis.org/en/0.1.32/opensearch.html \ No newline at end of file +https://mdacli.mdanalysis.org/en/0.1.31/api.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/api/cli.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/api/colors.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/api/libcli.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/api/logger.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/api/save.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/api/utils.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/authors.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/changelog.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/contributing.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/index.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/installation.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/philosophy.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/readme.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/usage.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/genindex.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/py-modindex.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/mdacli/cli.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/mdacli/colors.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/mdacli/libcli.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/mdacli/logger.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/mdacli/save.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/mdacli/utils.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/_modules/index.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/search.htmlhttps://mdacli.mdanalysis.org/en/0.1.31/opensearch.html \ No newline at end of file diff --git a/stable/usage.html b/stable/usage.html index b727c33..729b94b 100644 --- a/stable/usage.html +++ b/stable/usage.html @@ -4,7 +4,7 @@ - Usage — mdacli 0.1.32 documentation + Usage — mdacli 0.1.31 documentation @@ -18,13 +18,13 @@ - + @@ -45,7 +45,7 @@
                - 0.1.32 + 0.1.31
                @@ -178,7 +178,7 @@

                Usage - 0.1.32 + 0.1.31 diff --git a/versions.json b/versions.json index e9f4a59..937a963 100644 --- a/versions.json +++ b/versions.json @@ -1,8 +1,8 @@ [ { - "version": "0.1.32", - "display": "0.1.32", - "url": "https://mdacli.mdanalysis.org/0.1.32", + "version": "0.1.31", + "display": "0.1.31", + "url": "https://mdacli.mdanalysis.org/0.1.31", "latest": true }, {