diff --git a/.buildinfo b/.buildinfo index f738e16..a3269c3 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: edd266f8b85f32302a9b56e7c8909917 +# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 727a346649e8f140a23ff6388ebd638b tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_modules/index.html b/_modules/index.html index 74ed568..acdef24 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -7,7 +7,7 @@ - Overview: module code — SEAMM Loop Plug-in 2024.8.23 documentation + Overview: module code — SEAMM Loop Plug-in 2024.10.15 documentation @@ -45,8 +45,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/_modules/loop_step/loop.html b/_modules/loop_step/loop.html index 4a2060f..108fbfe 100644 --- a/_modules/loop_step/loop.html +++ b/_modules/loop_step/loop.html @@ -7,7 +7,7 @@ - loop_step.loop — SEAMM Loop Plug-in 2024.8.23 documentation + loop_step.loop — SEAMM Loop Plug-in 2024.10.15 documentation @@ -45,8 +45,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + @@ -632,7 +632,7 @@

Source code for loop_step.loop

         next_node = self.loop_node()
         while next_node is not None and next_node != join_node:
             text += "\n\n"
-            text += __(next_node.description_text(), indent=4 * " ").__str__()
+            text += str(__(next_node.description_text(), indent=4 * " ", wrap=False))
             next_node = next_node.next()
 
         return text
diff --git a/_modules/loop_step/loop_parameters.html b/_modules/loop_step/loop_parameters.html index a71a761..fc73ea6 100644 --- a/_modules/loop_step/loop_parameters.html +++ b/_modules/loop_step/loop_parameters.html @@ -7,7 +7,7 @@ - loop_step.loop_parameters — SEAMM Loop Plug-in 2024.8.23 documentation + loop_step.loop_parameters — SEAMM Loop Plug-in 2024.10.15 documentation @@ -45,8 +45,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/_modules/loop_step/loop_step.html b/_modules/loop_step/loop_step.html index 3e36825..6ace162 100644 --- a/_modules/loop_step/loop_step.html +++ b/_modules/loop_step/loop_step.html @@ -7,7 +7,7 @@ - loop_step.loop_step — SEAMM Loop Plug-in 2024.8.23 documentation + loop_step.loop_step — SEAMM Loop Plug-in 2024.10.15 documentation @@ -45,8 +45,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/_modules/loop_step/tk_loop.html b/_modules/loop_step/tk_loop.html index e28aeef..d6e99af 100644 --- a/_modules/loop_step/tk_loop.html +++ b/_modules/loop_step/tk_loop.html @@ -7,7 +7,7 @@ - loop_step.tk_loop — SEAMM Loop Plug-in 2024.8.23 documentation + loop_step.tk_loop — SEAMM Loop Plug-in 2024.10.15 documentation @@ -45,8 +45,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/_static/basic.css b/_static/basic.css index 2af6139..2a9e411 100644 --- a/_static/basic.css +++ b/_static/basic.css @@ -1,12 +1,5 @@ /* - * basic.css - * ~~~~~~~~~ - * * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ /* -- main layout ----------------------------------------------------------- */ @@ -115,15 +108,11 @@ img { /* -- search page ----------------------------------------------------------- */ ul.search { - margin: 10px 0 0 20px; - padding: 0; + margin-top: 10px; } ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; + padding: 5px 0; } ul.search li a { diff --git a/_static/doctools.js b/_static/doctools.js index 4d67807..0398ebb 100644 --- a/_static/doctools.js +++ b/_static/doctools.js @@ -1,12 +1,5 @@ /* - * doctools.js - * ~~~~~~~~~~~ - * * Base JavaScript utilities for all Sphinx HTML documentation. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ "use strict"; diff --git a/_static/documentation_options.js b/_static/documentation_options.js index 87ae279..ac29b67 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '2024.8.23', + VERSION: '2024.10.15', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/_static/language_data.js b/_static/language_data.js index 367b8ed..c7fe6c6 100644 --- a/_static/language_data.js +++ b/_static/language_data.js @@ -1,13 +1,6 @@ /* - * language_data.js - * ~~~~~~~~~~~~~~~~ - * * This script contains the language-specific data used by searchtools.js, * namely the list of stopwords, stemmer, scorer and splitter. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; diff --git a/_static/searchtools.js b/_static/searchtools.js index b08d58c..2c774d1 100644 --- a/_static/searchtools.js +++ b/_static/searchtools.js @@ -1,12 +1,5 @@ /* - * searchtools.js - * ~~~~~~~~~~~~~~~~ - * * Sphinx JavaScript utilities for the full-text search. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ "use strict"; @@ -20,7 +13,7 @@ if (typeof Scorer === "undefined") { // and returns the new score. /* score: result => { - const [docname, title, anchor, descr, score, filename] = result + const [docname, title, anchor, descr, score, filename, kind] = result return score }, */ @@ -47,6 +40,14 @@ if (typeof Scorer === "undefined") { }; } +// Global search result kind enum, used by themes to style search results. +class SearchResultKind { + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } +} + const _removeChildren = (element) => { while (element && element.lastChild) element.removeChild(element.lastChild); }; @@ -64,9 +65,13 @@ const _displayItem = (item, searchTerms, highlightTerms) => { const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; const contentRoot = document.documentElement.dataset.content_root; - const [docName, title, anchor, descr, score, _filename] = item; + const [docName, title, anchor, descr, score, _filename, kind] = item; let listItem = document.createElement("li"); + // Add a class representing the item's type: + // can be used by a theme's CSS selector for styling + // See SearchResultKind for the class names. + listItem.classList.add(`kind-${kind}`); let requestUrl; let linkUrl; if (docBuilder === "dirhtml") { @@ -115,8 +120,10 @@ const _finishSearch = (resultCount) => { "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." ); else - Search.status.innerText = _( - "Search finished, found ${resultCount} page(s) matching the search query." + Search.status.innerText = Documentation.ngettext( + "Search finished, found one page matching the search query.", + "Search finished, found ${resultCount} pages matching the search query.", + resultCount, ).replace('${resultCount}', resultCount); }; const _displayNextItem = ( @@ -138,7 +145,7 @@ const _displayNextItem = ( else _finishSearch(resultCount); }; // Helper function used by query() to order search results. -// Each input is an array of [docname, title, anchor, descr, score, filename]. +// Each input is an array of [docname, title, anchor, descr, score, filename, kind]. // Order the results by score (in opposite order of appearance, since the // `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. const _orderResultsByScoreThenName = (a, b) => { @@ -248,6 +255,7 @@ const Search = { searchSummary.classList.add("search-summary"); searchSummary.innerText = ""; const searchList = document.createElement("ul"); + searchList.setAttribute("role", "list"); searchList.classList.add("search"); const out = document.getElementById("search-results"); @@ -318,7 +326,7 @@ const Search = { const indexEntries = Search._index.indexentries; // Collect multiple result groups to be sorted separately and then ordered. - // Each is an array of [docname, title, anchor, descr, score, filename]. + // Each is an array of [docname, title, anchor, descr, score, filename, kind]. const normalResults = []; const nonMainIndexResults = []; @@ -337,6 +345,7 @@ const Search = { null, score + boost, filenames[file], + SearchResultKind.title, ]); } } @@ -354,6 +363,7 @@ const Search = { null, score, filenames[file], + SearchResultKind.index, ]; if (isMain) { normalResults.push(result); @@ -475,6 +485,7 @@ const Search = { descr, score, filenames[match[0]], + SearchResultKind.object, ]); }; Object.keys(objects).forEach((prefix) => @@ -585,6 +596,7 @@ const Search = { null, score, filenames[file], + SearchResultKind.text, ]); } return results; diff --git a/api/index.html b/api/index.html index 2f37ced..d71a6d9 100644 --- a/api/index.html +++ b/api/index.html @@ -8,7 +8,7 @@ - API Documentation — SEAMM Loop Plug-in 2024.8.23 documentation + API Documentation — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/api/loop_step.html b/api/loop_step.html index 047ac5a..bf277d5 100644 --- a/api/loop_step.html +++ b/api/loop_step.html @@ -8,7 +8,7 @@ - loop_step package — SEAMM Loop Plug-in 2024.8.23 documentation + loop_step package — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/api/modules.html b/api/modules.html index fd44967..574f5c3 100644 --- a/api/modules.html +++ b/api/modules.html @@ -8,7 +8,7 @@ - loop_step — SEAMM Loop Plug-in 2024.8.23 documentation + loop_step — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/authors.html b/authors.html index eecd94e..0484b43 100644 --- a/authors.html +++ b/authors.html @@ -8,7 +8,7 @@ - Development Team — SEAMM Loop Plug-in 2024.8.23 documentation + Development Team — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/developer_guide/contributing.html b/developer_guide/contributing.html index 2b0e0d8..4341695 100644 --- a/developer_guide/contributing.html +++ b/developer_guide/contributing.html @@ -8,7 +8,7 @@ - Contributing — SEAMM Loop Plug-in 2024.8.23 documentation + Contributing — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/developer_guide/index.html b/developer_guide/index.html index 31e52b9..3c97a7c 100644 --- a/developer_guide/index.html +++ b/developer_guide/index.html @@ -8,7 +8,7 @@ - Developer Documentation — SEAMM Loop Plug-in 2024.8.23 documentation + Developer Documentation — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/developer_guide/installation.html b/developer_guide/installation.html index 1e38ffb..a5bd8e2 100644 --- a/developer_guide/installation.html +++ b/developer_guide/installation.html @@ -8,7 +8,7 @@ - Installation — SEAMM Loop Plug-in 2024.8.23 documentation + Installation — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/developer_guide/readme.html b/developer_guide/readme.html index dbb4954..b4b31c5 100644 --- a/developer_guide/readme.html +++ b/developer_guide/readme.html @@ -8,7 +8,7 @@ - SEAMM Loop Plug-in — SEAMM Loop Plug-in 2024.8.23 documentation + SEAMM Loop Plug-in — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/developer_guide/usage.html b/developer_guide/usage.html index b18378f..67eed6e 100644 --- a/developer_guide/usage.html +++ b/developer_guide/usage.html @@ -8,7 +8,7 @@ - Usage — SEAMM Loop Plug-in 2024.8.23 documentation + Usage — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/genindex.html b/genindex.html index ded9bbf..9cdbb36 100644 --- a/genindex.html +++ b/genindex.html @@ -7,7 +7,7 @@ - Index — SEAMM Loop Plug-in 2024.8.23 documentation + Index — SEAMM Loop Plug-in 2024.10.15 documentation @@ -45,8 +45,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/getting_started/index.html b/getting_started/index.html index 0e26aea..9e4a849 100644 --- a/getting_started/index.html +++ b/getting_started/index.html @@ -8,7 +8,7 @@ - Getting Started — SEAMM Loop Plug-in 2024.8.23 documentation + Getting Started — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/history.html b/history.html index f132aad..4b4ac7a 100644 --- a/history.html +++ b/history.html @@ -8,7 +8,7 @@ - History — SEAMM Loop Plug-in 2024.8.23 documentation + History — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + @@ -499,6 +499,11 @@

History#

+
2024.10.15: Bugfix: incorrectly wrapping text description of substeps
    +

  • When printing the description of the substeps in the loop, the code incorrectly +wrapped the text, which caused issues with e.g. tables.

    • +
+
2024.8.23 – Enhancement to ‘For’ loops

  • For integer loops, ensure that the loop variable is an integer and make the directory name be value of the loop variable to make it easier diff --git a/index.html b/index.html index 84320d9..27c4deb 100644 --- a/index.html +++ b/index.html @@ -8,7 +8,7 @@ - Loop Step — SEAMM Loop Plug-in 2024.8.23 documentation + Loop Step — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/objects.inv b/objects.inv index 6aea540..03e52ad 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/py-modindex.html b/py-modindex.html index e0ce36a..884ba3e 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -7,7 +7,7 @@ - Python Module Index — SEAMM Loop Plug-in 2024.8.23 documentation + Python Module Index — SEAMM Loop Plug-in 2024.10.15 documentation @@ -45,8 +45,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/search.html b/search.html index 397824a..3fd3592 100644 --- a/search.html +++ b/search.html @@ -6,7 +6,7 @@ - Search - SEAMM Loop Plug-in 2024.8.23 documentation + Search - SEAMM Loop Plug-in 2024.10.15 documentation @@ -44,8 +44,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + + diff --git a/searchindex.js b/searchindex.js index d5086d0..49f217e 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"0.1.0 (2019-01-13)": [[10, "id4"]], "0.2.0 (2019-07-29)": [[10, "id3"]], "0.6 (8 September 2019)": [[10, "september-2019"]], "0.7.0 (17 December 2019)": [[10, "december-2019"]], "0.9 (15 April 2020)": [[10, "april-2020"]], "2020.10.1 (1 October 2020)": [[10, "october-2020"]], "2020.11.2 (2 November 2020)": [[10, "november-2020"]], "2020.12.4 (4 December 2020)": [[10, "december-2020"]], "2020.7.0 (23 July 2020)": [[10, "july-2020"]], "2020.8.3 (3 August 2020)": [[10, "august-2020"]], "2020.9.25 (25 September 2020)": [[10, "id2"]], "2020.9.25.1 (25 September 2020)": [[10, "september-2020"]], "2021.2.11 (11 February 2021)": [[10, "february-2021"]], "2021.2.4 (4 February 2021)": [[10, "id1"]], "API Documentation": [[0, null]], "Acknowledgements": [[7, "acknowledgements"]], "Contributing": [[4, null]], "Developer Documentation": [[5, null]], "Development Team": [[3, null]], "Features": [[7, "features"]], "Fix Bugs": [[4, "fix-bugs"]], "From sources": [[6, "from-sources"]], "Get Started!": [[4, "get-started"]], "Getting Started": [[9, null]], "History": [[10, null]], "Implement Features": [[4, "implement-features"]], "Index": [[12, "index"]], "Indices and tables": [[0, "indices-and-tables"], [5, "indices-and-tables"]], "Installation": [[6, null], [9, "installation"]], "Loop Step": [[11, null]], "Module contents": [[1, "module-loop_step"]], "More Information": [[11, "more-information"]], "Pull Request Guidelines": [[4, "pull-request-guidelines"]], "Replace this!": [[9, "replace-this"]], "Report Bugs": [[4, "report-bugs"]], "SEAMM Loop Plug-in": [[7, null]], "Stable release": [[6, "stable-release"]], "Submit Feedback": [[4, "submit-feedback"]], "Submodules": [[1, "submodules"]], "Tips": [[4, "tips"]], "Types of Contributions": [[4, "types-of-contributions"]], "Usage": [[8, null]], "User Guide": [[12, null]], "Write Documentation": [[4, "write-documentation"]], "loop_step": [[2, null]], "loop_step package": [[1, null]], "loop_step.loop module": [[1, "module-loop_step.loop"]], "loop_step.loop_parameters module": [[1, "module-loop_step.loop_parameters"]], "loop_step.loop_step module": [[1, "module-loop_step.loop_step"]], "loop_step.tk_loop module": [[1, "module-loop_step.tk_loop"]]}, "docnames": ["api/index", "api/loop_step", "api/modules", "authors", "developer_guide/contributing", "developer_guide/index", "developer_guide/installation", "developer_guide/readme", "developer_guide/usage", "getting_started/index", "history", "index", "user_guide/index"], "envversion": {"sphinx": 62, "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.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api/index.rst", "api/loop_step.rst", "api/modules.rst", "authors.rst", "developer_guide/contributing.rst", "developer_guide/index.rst", "developer_guide/installation.rst", "developer_guide/readme.rst", "developer_guide/usage.rst", "getting_started/index.rst", "history.rst", "index.rst", "user_guide/index.rst"], "indexentries": {"create_dialog() (loop_step.tk_loop.tkloop method)": [[1, "loop_step.tk_loop.TkLoop.create_dialog", false]], "create_node() (loop_step.loop_step.loopstep method)": [[1, "loop_step.loop_step.LoopStep.create_node", false]], "create_parser() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.create_parser", false]], "create_tk_node() (loop_step.loop_step.loopstep method)": [[1, "loop_step.loop_step.LoopStep.create_tk_node", false]], "criteria_callback() (loop_step.tk_loop.tkloop method)": [[1, "loop_step.tk_loop.TkLoop.criteria_callback", false]], "default_edge_subtype() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.default_edge_subtype", false]], "default_edge_subtype() (loop_step.tk_loop.tkloop method)": [[1, "loop_step.tk_loop.TkLoop.default_edge_subtype", false]], "describe() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.describe", false]], "description() (loop_step.loop_step.loopstep method)": [[1, "loop_step.loop_step.LoopStep.description", false]], "description_text() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.description_text", false]], "exit_node() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.exit_node", false]], "git_revision (loop_step.loop.loop property)": [[1, "loop_step.loop.Loop.git_revision", false]], "iter_format (loop_step.loop.loop property)": [[1, "loop_step.loop.Loop.iter_format", false]], "loop (class in loop_step.loop)": [[1, "loop_step.loop.Loop", false]], "loop_node() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.loop_node", false]], "loop_step": [[1, "module-loop_step", false]], "loop_step.loop": [[1, "module-loop_step.loop", false]], "loop_step.loop_parameters": [[1, "module-loop_step.loop_parameters", false]], "loop_step.loop_step": [[1, "module-loop_step.loop_step", false]], "loop_step.tk_loop": [[1, "module-loop_step.tk_loop", false]], "loopparameters (class in loop_step.loop_parameters)": [[1, "loop_step.loop_parameters.LoopParameters", false]], "loopstep (class in loop_step.loop_step)": [[1, "loop_step.loop_step.LoopStep", false]], "module": [[1, "module-loop_step", false], [1, "module-loop_step.loop", false], [1, "module-loop_step.loop_parameters", false], [1, "module-loop_step.loop_step", false], [1, "module-loop_step.tk_loop", false]], "my_description (loop_step.loop_step.loopstep attribute)": [[1, "loop_step.loop_step.LoopStep.my_description", false]], "next_anchor() (loop_step.tk_loop.tkloop method)": [[1, "loop_step.tk_loop.TkLoop.next_anchor", false]], "node_class (loop_step.tk_loop.tkloop attribute)": [[1, "loop_step.tk_loop.TkLoop.node_class", false]], "parameters (loop_step.loop_parameters.loopparameters attribute)": [[1, "loop_step.loop_parameters.LoopParameters.parameters", false]], "reset_dialog() (loop_step.tk_loop.tkloop method)": [[1, "loop_step.tk_loop.TkLoop.reset_dialog", false]], "right_click() (loop_step.tk_loop.tkloop method)": [[1, "loop_step.tk_loop.TkLoop.right_click", false]], "run() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.run", false]], "safe_filename() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.safe_filename", false]], "set_id() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.set_id", false]], "set_subids() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.set_subids", false]], "tkloop (class in loop_step.tk_loop)": [[1, "loop_step.tk_loop.TkLoop", false]], "version (loop_step.loop.loop property)": [[1, "loop_step.loop.Loop.version", false]], "working_path (loop_step.loop.loop property)": [[1, "loop_step.loop.Loop.working_path", false]], "write_final_structure() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.write_final_structure", false]]}, "objects": {"": [[1, 0, 0, "-", "loop_step"]], "loop_step": [[1, 0, 0, "-", "loop"], [1, 0, 0, "-", "loop_parameters"], [1, 0, 0, "-", "loop_step"], [1, 0, 0, "-", "tk_loop"]], "loop_step.loop": [[1, 1, 1, "", "Loop"]], "loop_step.loop.Loop": [[1, 2, 1, "", "create_parser"], [1, 2, 1, "", "default_edge_subtype"], [1, 2, 1, "", "describe"], [1, 2, 1, "", "description_text"], [1, 2, 1, "", "exit_node"], [1, 3, 1, "", "git_revision"], [1, 3, 1, "", "iter_format"], [1, 2, 1, "", "loop_node"], [1, 2, 1, "", "run"], [1, 2, 1, "", "safe_filename"], [1, 2, 1, "", "set_id"], [1, 2, 1, "", "set_subids"], [1, 3, 1, "", "version"], [1, 3, 1, "", "working_path"], [1, 2, 1, "", "write_final_structure"]], "loop_step.loop_parameters": [[1, 1, 1, "", "LoopParameters"]], "loop_step.loop_parameters.LoopParameters": [[1, 4, 1, "", "parameters"]], "loop_step.loop_step": [[1, 1, 1, "", "LoopStep"]], "loop_step.loop_step.LoopStep": [[1, 2, 1, "", "create_node"], [1, 2, 1, "", "create_tk_node"], [1, 2, 1, "", "description"], [1, 4, 1, "", "my_description"]], "loop_step.tk_loop": [[1, 1, 1, "", "TkLoop"]], "loop_step.tk_loop.TkLoop": [[1, 2, 1, "", "create_dialog"], [1, 2, 1, "", "criteria_callback"], [1, 2, 1, "", "default_edge_subtype"], [1, 2, 1, "", "next_anchor"], [1, 4, 1, "", "node_class"], [1, 2, 1, "", "reset_dialog"], [1, 2, 1, "", "right_click"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:attribute"}, "terms": {"": [1, 4], "1": [1, 11], "10": 1, "120": 1, "1547580": 7, "16": 10, "2": [4, 11], "20": 1, "200": 1, "2022": 10, "2023": 10, "2024": 10, "21": 10, "2136142": 7, "24": 10, "28": 10, "3": 4, "30": 10, "4": 4, "5": 4, "50": 1, "6": 4, "7": 4, "A": [1, 7, 11], "FOR": 11, "For": [1, 7, 9, 10], "If": [1, 4, 6, 9], "In": 9, "On": 1, "Or": 6, "That": 9, "The": [1, 4, 6, 9, 10, 11, 12], "There": 10, "To": [4, 6, 8, 11], "abil": 10, "about": [1, 4, 9], "accord": 1, "action": 10, "ad": [10, 11], "add": [1, 4, 10], "after": [1, 10], "aid": 10, "alia": 1, "all": [1, 4, 10], "allow": 1, "alreadi": [9, 10], "also": 9, "alwai": [4, 6], "an": [1, 4, 9, 10], "anchor": 1, "ani": [1, 4, 10], "anyth": [1, 4], "api": 11, "appreci": 4, "appropri": [1, 9], "ar": [4, 10], "argument": [1, 10], "articl": 4, "assum": 4, "award": 7, "b": 4, "base": 1, "becom": 3, "been": 10, "befor": [4, 10], "below": 1, "best": 4, "better": 10, "bit": 4, "blank": 10, "block": 10, "blog": 4, "bodi": [1, 10], "both": 9, "box": 9, "branch": [4, 10], "bsd": 7, "bug": [10, 11], "bugfix": [4, 10], "callback": 1, "can": [4, 6, 9, 10], "canva": 1, "caught": 10, "caus": [1, 10], "cd": 4, "chang": [1, 4, 10], "che": 7, "check": [4, 9, 10], "checkout": 4, "ci": [4, 10], "class": [1, 10], "clean": 10, "clear": 1, "click": 9, "clone": [4, 6], "code": [7, 10, 11], "column": 1, "com": [4, 6], "command": [1, 6, 10], "commandlin": 10, "commit": 4, "compat": 10, "complet": 11, "compon": 9, "conda": 9, "config": 1, "configur": [1, 10], "consist": 10, "consolid": 10, "contain": 1, "content": [0, 2, 5], "continu": 1, "contribut": [5, 11], "contributor": 3, "control": [1, 7, 11], "cookiecutt": 7, "copi": [4, 6], "correct": 10, "could": [4, 10], "count": 10, "crash": 10, "creat": [1, 4, 7, 10], "create_dialog": [1, 2], "create_nod": [1, 2], "create_pars": [1, 2], "create_tk_nod": [1, 2], "credit": 4, "criteria": 1, "criteria_callback": [1, 2], "criterion": 1, "curl": 6, "current": 1, "dashboard": 10, "data": 1, "databas": [1, 10], "date": 9, "debug": 10, "default": 1, "default_edge_subtyp": [1, 2], "default_unit": 1, "delimit": 10, "depend": 10, "describ": [1, 2], "descript": [1, 2, 4, 10], "description_text": [1, 2], "detail": [4, 9], "develop": [4, 7, 11], "dialog": 1, "dict": 1, "dictionari": 1, "differ": 10, "direct": [9, 10], "directori": [1, 10], "do": [1, 11], "doc": 4, "docstr": 4, "document": [7, 10], "doe": 1, "don": [3, 6], "done": 4, "download": 6, "driven": 4, "each": 10, "easier": [4, 10], "easiest": 9, "edg": 1, "edit": 1, "either": 6, "element": 7, "eman": 1, "embed": 10, "empti": 1, "end": [1, 10], "enhanc": [4, 10], "enough": 9, "ensur": [9, 10], "enumer": 1, "environ": 9, "error": [1, 10], "etc": 11, "even": 4, "event": 1, "everi": 4, "exampl": [1, 9], "exce": 1, "exist": 10, "exit": 1, "exit_nod": [1, 2], "explain": 4, "extens": 1, "factori": 1, "fail": 10, "field": 1, "file": [1, 4, 10], "filenam": 1, "filter": 1, "final": 1, "final_structur": 10, "find": 10, "first": [1, 10], "fix": [10, 11], "flake8": 4, "float": 1, "flowchart": [1, 7], "follow": 9, "foreach": [1, 7, 10], "fork": 4, "format": 1, "format_str": 1, "foundat": 7, "free": 7, "from": [1, 5, 7, 10], "function": [4, 9, 11], "fund": 7, "further": 10, "gap": 1, "gener": 10, "get": [5, 10, 11], "git": [1, 4, 6], "git_revis": [1, 2], "github": [4, 6, 7, 10], "give": 10, "given": 4, "graphic": [1, 9], "greatli": 4, "grid": 11, "group": 1, "gui": 1, "guid": [6, 9, 11], "guidelin": 5, "h": 1, "had": 10, "handl": [1, 10], "have": [4, 6, 10], "help": 4, "help_text": 1, "helper": 1, "here": [4, 9], "histori": 11, "how": [1, 4], "html": 7, "http": [4, 6, 7], "i": [1, 4, 6, 7, 9, 10], "id": 1, "ignor": 10, "import": 8, "improv": 10, "includ": 4, "inclus": 1, "increment": 1, "index": [0, 5, 7, 10], "indic": 1, "inform": [1, 10], "instal": [4, 5, 10], "institut": 7, "integ": 10, "integr": 1, "interest": 10, "interfac": 1, "intern": 10, "introduct": 11, "io": 7, "issu": 4, "item": [1, 11], "item_nnn": 10, "iter": [1, 10], "iter_format": [1, 2], "job": [1, 10], "join": 3, "just": 4, "keep": 4, "keyword": [1, 10], "kind": 1, "kwarg": 1, "lai": 1, "languag": 7, "last": 1, "lead": 3, "leav": 1, "licens": 7, "like": [7, 10, 11], "line": [1, 10], "linux": 10, "list": [1, 4, 7, 10, 11], "littl": 4, "local": 4, "logger": 1, "look": 4, "loop": [2, 4, 6, 8, 9, 10], "loop_nod": [1, 2], "loop_paramet": 2, "loop_step": [0, 4, 6, 7, 8], "loopparamet": [1, 2], "loopstep": [1, 2], "m": 4, "made": 10, "mai": 1, "main": 10, "make": [4, 10], "mani": [1, 4], "master": 6, "match": [1, 10], "meet": 4, "method": [1, 6], "might": 4, "miss": 10, "mkvirtualenv": 4, "mmcif": 10, "modul": [0, 2, 5], "molecular": 7, "molssi": [3, 6, 7, 10], "molsystem": 10, "more": [1, 4, 9, 10], "most": 6, "move": 10, "much": 10, "my_descript": [1, 2], "my_logg": 1, "name": [1, 4, 10], "narrow": 4, "nation": 7, "need": 1, "nest": 10, "new": [1, 4, 10], "next": [1, 9], "next_anchor": [1, 2], "nice": 1, "node": 1, "node_class": [1, 2], "node_id": 1, "non": [1, 9], "none": 1, "normal": 10, "now": [4, 10], "number": [1, 10, 11], "oac": 7, "object": 1, "offici": 4, "ol": 6, "onc": 6, "one": 9, "op": 1, "open": 4, "oper": [1, 4, 10], "option": 10, "org": [3, 4], "origin": 4, "other": 4, "our": 1, "out": [1, 10], "output": 10, "over": [1, 7, 10, 11], "p": 1, "packag": [0, 2, 7], "page": [0, 5, 10], "paramet": [1, 2], "pars": 10, "parser": 1, "part": [1, 4], "partner": 1, "pass": 4, "paul": 3, "paulsax": 4, "period": 10, "pip": [4, 6], "pleas": 4, "plot": 10, "plug": [6, 8, 9, 12], "plugin": 7, "point": 1, "posit": 1, "possibl": 4, "post": 4, "prefer": 6, "prepar": 10, "print": 10, "probabl": [1, 9], "problem": 10, "process": [6, 10], "program": 7, "project": [4, 7, 8], "properli": 10, "properti": 1, "propos": 4, "provid": [1, 7, 11], "psax": 3, "public": 6, "pull": 5, "pull_request": 4, "push": 4, "put": [4, 9], "py": [4, 6, 10], "pypi": [4, 10], "python": [4, 6, 10], "pyup": 10, "queri": [1, 10], "quot": 10, "rang": 11, "re": 4, "readi": 4, "readm": [4, 10], "readthedoc": 10, "real": 1, "receiv": 7, "recent": 6, "refer": 11, "regexp": [1, 10], "releas": [5, 10], "rememb": 4, "remov": [1, 10], "reorgan": 10, "repo": [4, 6], "repositori": 6, "reproduc": 4, "request": 5, "requir": 10, "rerun": 10, "reset_dialog": [1, 2], "restart": 10, "return": 1, "right_click": [1, 2], "row": [1, 7, 10, 11], "rst": 4, "run": [1, 2, 4, 6], "safe_filenam": [1, 2], "sax": 3, "scienc": 7, "scope": 4, "seamm": [1, 6, 9, 10], "search": [0, 1, 5], "searchabl": 10, "second": [1, 9], "see": [7, 9], "select": [1, 9, 10], "self": 1, "semant": 1, "send": 4, "sequenti": 1, "set": [1, 4], "set_id": [1, 2], "set_subid": [1, 2], "setup": [1, 4, 6, 10], "short": [1, 10], "shortcut": 9, "should": [1, 4, 9], "simpl": [7, 11], "simpli": 9, "so": 10, "softwar": 7, "sometim": 10, "sourc": [1, 5], "stabl": 5, "standard": 10, "start": [1, 5, 10, 11], "stderr": 10, "step": [1, 4, 9], "stevedor": 1, "stop": 1, "str": 1, "straightforward": 9, "string": 1, "structur": [1, 7, 10, 11], "subdirectori": 10, "submodul": 2, "subnod": 1, "subset": 4, "subtyp": 1, "support": [4, 10], "sure": 4, "sw": 1, "switch": [9, 10], "system": [1, 4, 10], "t": [3, 6], "tab": 9, "tabl": [1, 7, 10, 11], "table1": 1, "tag": 4, "tarbal": 6, "team": 11, "templat": 7, "termin": 6, "test": [1, 4], "test_loop_step": 4, "thei": 4, "them": [1, 4], "theme": 10, "thi": [1, 4, 6, 7, 11], "through": [4, 6], "tip": 5, "tk": 1, "tk_flowchart": 1, "tk_loop": 2, "tkloop": [1, 2], "tknode": 1, "too": 1, "tox": 4, "traceback": 10, "travi": 4, "travisci": 10, "troubleshoot": 4, "two": [1, 9], "two_valu": 1, "type": [1, 5, 9], "under": 7, "up": [4, 9, 10], "updat": [4, 9, 10], "us": [1, 4, 8, 9, 10, 11], "usag": 5, "user": [9, 10, 11], "usual": 1, "valu": [1, 10], "variabl": [1, 10], "version": [1, 2, 4, 10], "view": 10, "virtualenv": 4, "virtualenvwrapp": 4, "volunt": 4, "w": 1, "wa": [7, 10], "wai": [4, 10], "want": 4, "warn": 1, "web": 4, "websit": 4, "welcom": 4, "well": 10, "what": 1, "when": [4, 10], "where": [1, 10], "whether": 4, "which": [1, 7], "whoever": 4, "why": 3, "widget": 1, "wish": 9, "work": [4, 10], "working_path": [1, 2], "would": 4, "write": [1, 10], "write_final_structur": [1, 2], "wrote": 10, "x": 1, "xxxx": 12, "y": 1, "you": [3, 4, 6, 9], "your": [4, 6, 9], "your_name_her": 4}, "titles": ["API Documentation", "loop_step package", "loop_step", "Development Team", "Contributing", "Developer Documentation", "Installation", "SEAMM Loop Plug-in", "Usage", "Getting Started", "History", "Loop Step", "User Guide"], "titleterms": {"0": 10, "01": 10, "07": 10, "1": 10, "10": 10, "11": 10, "12": 10, "13": 10, "15": 10, "17": 10, "2": 10, "2019": 10, "2020": 10, "2021": 10, "23": 10, "25": 10, "29": 10, "3": 10, "4": 10, "6": 10, "7": 10, "8": 10, "9": 10, "acknowledg": 7, "api": 0, "april": 10, "august": 10, "bug": 4, "content": 1, "contribut": 4, "decemb": 10, "develop": [3, 5], "document": [0, 4, 5], "featur": [4, 7], "februari": 10, "feedback": 4, "fix": 4, "from": 6, "get": [4, 9], "guid": 12, "guidelin": 4, "histori": 10, "implement": 4, "index": 12, "indic": [0, 5], "inform": 11, "instal": [6, 9], "juli": 10, "loop": [1, 7, 11], "loop_paramet": 1, "loop_step": [1, 2], "modul": 1, "more": 11, "novemb": 10, "octob": 10, "packag": 1, "plug": 7, "pull": 4, "releas": 6, "replac": 9, "report": 4, "request": 4, "seamm": 7, "septemb": 10, "sourc": 6, "stabl": 6, "start": [4, 9], "step": 11, "submit": 4, "submodul": 1, "tabl": [0, 5], "team": 3, "thi": 9, "tip": 4, "tk_loop": 1, "type": 4, "usag": 8, "user": 12, "write": 4}}) \ No newline at end of file +Search.setIndex({"alltitles": {"0.1.0 (2019-01-13)": [[10, "id4"]], "0.2.0 (2019-07-29)": [[10, "id3"]], "0.6 (8 September 2019)": [[10, "september-2019"]], "0.7.0 (17 December 2019)": [[10, "december-2019"]], "0.9 (15 April 2020)": [[10, "april-2020"]], "2020.10.1 (1 October 2020)": [[10, "october-2020"]], "2020.11.2 (2 November 2020)": [[10, "november-2020"]], "2020.12.4 (4 December 2020)": [[10, "december-2020"]], "2020.7.0 (23 July 2020)": [[10, "july-2020"]], "2020.8.3 (3 August 2020)": [[10, "august-2020"]], "2020.9.25 (25 September 2020)": [[10, "id2"]], "2020.9.25.1 (25 September 2020)": [[10, "september-2020"]], "2021.2.11 (11 February 2021)": [[10, "february-2021"]], "2021.2.4 (4 February 2021)": [[10, "id1"]], "API Documentation": [[0, null]], "Acknowledgements": [[7, "acknowledgements"]], "Contributing": [[4, null]], "Developer Documentation": [[5, null]], "Development Team": [[3, null]], "Features": [[7, "features"]], "Fix Bugs": [[4, "fix-bugs"]], "From sources": [[6, "from-sources"]], "Get Started!": [[4, "get-started"]], "Getting Started": [[9, null]], "History": [[10, null]], "Implement Features": [[4, "implement-features"]], "Index": [[12, "index"]], "Indices and tables": [[0, "indices-and-tables"], [5, "indices-and-tables"]], "Installation": [[6, null], [9, "installation"]], "Loop Step": [[11, null]], "Module contents": [[1, "module-loop_step"]], "More Information": [[11, "more-information"]], "Pull Request Guidelines": [[4, "pull-request-guidelines"]], "Replace this!": [[9, "replace-this"]], "Report Bugs": [[4, "report-bugs"]], "SEAMM Loop Plug-in": [[7, null]], "Stable release": [[6, "stable-release"]], "Submit Feedback": [[4, "submit-feedback"]], "Submodules": [[1, "submodules"]], "Tips": [[4, "tips"]], "Types of Contributions": [[4, "types-of-contributions"]], "Usage": [[8, null]], "User Guide": [[12, null]], "Write Documentation": [[4, "write-documentation"]], "loop_step": [[2, null]], "loop_step package": [[1, null]], "loop_step.loop module": [[1, "module-loop_step.loop"]], "loop_step.loop_parameters module": [[1, "module-loop_step.loop_parameters"]], "loop_step.loop_step module": [[1, "module-loop_step.loop_step"]], "loop_step.tk_loop module": [[1, "module-loop_step.tk_loop"]]}, "docnames": ["api/index", "api/loop_step", "api/modules", "authors", "developer_guide/contributing", "developer_guide/index", "developer_guide/installation", "developer_guide/readme", "developer_guide/usage", "getting_started/index", "history", "index", "user_guide/index"], "envversion": {"sphinx": 64, "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.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api/index.rst", "api/loop_step.rst", "api/modules.rst", "authors.rst", "developer_guide/contributing.rst", "developer_guide/index.rst", "developer_guide/installation.rst", "developer_guide/readme.rst", "developer_guide/usage.rst", "getting_started/index.rst", "history.rst", "index.rst", "user_guide/index.rst"], "indexentries": {"create_dialog() (loop_step.tk_loop.tkloop method)": [[1, "loop_step.tk_loop.TkLoop.create_dialog", false]], "create_node() (loop_step.loop_step.loopstep method)": [[1, "loop_step.loop_step.LoopStep.create_node", false]], "create_parser() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.create_parser", false]], "create_tk_node() (loop_step.loop_step.loopstep method)": [[1, "loop_step.loop_step.LoopStep.create_tk_node", false]], "criteria_callback() (loop_step.tk_loop.tkloop method)": [[1, "loop_step.tk_loop.TkLoop.criteria_callback", false]], "default_edge_subtype() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.default_edge_subtype", false]], "default_edge_subtype() (loop_step.tk_loop.tkloop method)": [[1, "loop_step.tk_loop.TkLoop.default_edge_subtype", false]], "describe() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.describe", false]], "description() (loop_step.loop_step.loopstep method)": [[1, "loop_step.loop_step.LoopStep.description", false]], "description_text() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.description_text", false]], "exit_node() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.exit_node", false]], "git_revision (loop_step.loop.loop property)": [[1, "loop_step.loop.Loop.git_revision", false]], "iter_format (loop_step.loop.loop property)": [[1, "loop_step.loop.Loop.iter_format", false]], "loop (class in loop_step.loop)": [[1, "loop_step.loop.Loop", false]], "loop_node() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.loop_node", false]], "loop_step": [[1, "module-loop_step", false]], "loop_step.loop": [[1, "module-loop_step.loop", false]], "loop_step.loop_parameters": [[1, "module-loop_step.loop_parameters", false]], "loop_step.loop_step": [[1, "module-loop_step.loop_step", false]], "loop_step.tk_loop": [[1, "module-loop_step.tk_loop", false]], "loopparameters (class in loop_step.loop_parameters)": [[1, "loop_step.loop_parameters.LoopParameters", false]], "loopstep (class in loop_step.loop_step)": [[1, "loop_step.loop_step.LoopStep", false]], "module": [[1, "module-loop_step", false], [1, "module-loop_step.loop", false], [1, "module-loop_step.loop_parameters", false], [1, "module-loop_step.loop_step", false], [1, "module-loop_step.tk_loop", false]], "my_description (loop_step.loop_step.loopstep attribute)": [[1, "loop_step.loop_step.LoopStep.my_description", false]], "next_anchor() (loop_step.tk_loop.tkloop method)": [[1, "loop_step.tk_loop.TkLoop.next_anchor", false]], "node_class (loop_step.tk_loop.tkloop attribute)": [[1, "loop_step.tk_loop.TkLoop.node_class", false]], "parameters (loop_step.loop_parameters.loopparameters attribute)": [[1, "loop_step.loop_parameters.LoopParameters.parameters", false]], "reset_dialog() (loop_step.tk_loop.tkloop method)": [[1, "loop_step.tk_loop.TkLoop.reset_dialog", false]], "right_click() (loop_step.tk_loop.tkloop method)": [[1, "loop_step.tk_loop.TkLoop.right_click", false]], "run() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.run", false]], "safe_filename() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.safe_filename", false]], "set_id() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.set_id", false]], "set_subids() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.set_subids", false]], "tkloop (class in loop_step.tk_loop)": [[1, "loop_step.tk_loop.TkLoop", false]], "version (loop_step.loop.loop property)": [[1, "loop_step.loop.Loop.version", false]], "working_path (loop_step.loop.loop property)": [[1, "loop_step.loop.Loop.working_path", false]], "write_final_structure() (loop_step.loop.loop method)": [[1, "loop_step.loop.Loop.write_final_structure", false]]}, "objects": {"": [[1, 0, 0, "-", "loop_step"]], "loop_step": [[1, 0, 0, "-", "loop"], [1, 0, 0, "-", "loop_parameters"], [1, 0, 0, "-", "loop_step"], [1, 0, 0, "-", "tk_loop"]], "loop_step.loop": [[1, 1, 1, "", "Loop"]], "loop_step.loop.Loop": [[1, 2, 1, "", "create_parser"], [1, 2, 1, "", "default_edge_subtype"], [1, 2, 1, "", "describe"], [1, 2, 1, "", "description_text"], [1, 2, 1, "", "exit_node"], [1, 3, 1, "", "git_revision"], [1, 3, 1, "", "iter_format"], [1, 2, 1, "", "loop_node"], [1, 2, 1, "", "run"], [1, 2, 1, "", "safe_filename"], [1, 2, 1, "", "set_id"], [1, 2, 1, "", "set_subids"], [1, 3, 1, "", "version"], [1, 3, 1, "", "working_path"], [1, 2, 1, "", "write_final_structure"]], "loop_step.loop_parameters": [[1, 1, 1, "", "LoopParameters"]], "loop_step.loop_parameters.LoopParameters": [[1, 4, 1, "", "parameters"]], "loop_step.loop_step": [[1, 1, 1, "", "LoopStep"]], "loop_step.loop_step.LoopStep": [[1, 2, 1, "", "create_node"], [1, 2, 1, "", "create_tk_node"], [1, 2, 1, "", "description"], [1, 4, 1, "", "my_description"]], "loop_step.tk_loop": [[1, 1, 1, "", "TkLoop"]], "loop_step.tk_loop.TkLoop": [[1, 2, 1, "", "create_dialog"], [1, 2, 1, "", "criteria_callback"], [1, 2, 1, "", "default_edge_subtype"], [1, 2, 1, "", "next_anchor"], [1, 4, 1, "", "node_class"], [1, 2, 1, "", "reset_dialog"], [1, 2, 1, "", "right_click"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:attribute"}, "terms": {"": [1, 4], "1": [1, 11], "10": 1, "120": 1, "1547580": 7, "16": 10, "2": [4, 11], "20": 1, "200": 1, "2022": 10, "2023": 10, "2024": 10, "21": 10, "2136142": 7, "24": 10, "28": 10, "3": 4, "30": 10, "4": 4, "5": 4, "50": 1, "6": 4, "7": 4, "A": [1, 7, 11], "FOR": 11, "For": [1, 7, 9, 10], "If": [1, 4, 6, 9], "In": 9, "On": 1, "Or": 6, "That": 9, "The": [1, 4, 6, 9, 10, 11, 12], "There": 10, "To": [4, 6, 8, 11], "abil": 10, "about": [1, 4, 9], "accord": 1, "action": 10, "ad": [10, 11], "add": [1, 4, 10], "after": [1, 10], "aid": 10, "alia": 1, "all": [1, 4, 10], "allow": 1, "alreadi": [9, 10], "also": 9, "alwai": [4, 6], "an": [1, 4, 9, 10], "anchor": 1, "ani": [1, 4, 10], "anyth": [1, 4], "api": 11, "appreci": 4, "appropri": [1, 9], "ar": [4, 10], "argument": [1, 10], "articl": 4, "assum": 4, "award": 7, "b": 4, "base": 1, "becom": 3, "been": 10, "befor": [4, 10], "below": 1, "best": 4, "better": 10, "bit": 4, "blank": 10, "block": 10, "blog": 4, "bodi": [1, 10], "both": 9, "box": 9, "branch": [4, 10], "bsd": 7, "bug": [10, 11], "bugfix": [4, 10], "callback": 1, "can": [4, 6, 9, 10], "canva": 1, "caught": 10, "caus": [1, 10], "cd": 4, "chang": [1, 4, 10], "che": 7, "check": [4, 9, 10], "checkout": 4, "ci": [4, 10], "class": [1, 10], "clean": 10, "clear": 1, "click": 9, "clone": [4, 6], "code": [7, 10, 11], "column": 1, "com": [4, 6], "command": [1, 6, 10], "commandlin": 10, "commit": 4, "compat": 10, "complet": 11, "compon": 9, "conda": 9, "config": 1, "configur": [1, 10], "consist": 10, "consolid": 10, "contain": 1, "content": [0, 2, 5], "continu": 1, "contribut": [5, 11], "contributor": 3, "control": [1, 7, 11], "cookiecutt": 7, "copi": [4, 6], "correct": 10, "could": [4, 10], "count": 10, "crash": 10, "creat": [1, 4, 7, 10], "create_dialog": [1, 2], "create_nod": [1, 2], "create_pars": [1, 2], "create_tk_nod": [1, 2], "credit": 4, "criteria": 1, "criteria_callback": [1, 2], "criterion": 1, "curl": 6, "current": 1, "dashboard": 10, "data": 1, "databas": [1, 10], "date": 9, "debug": 10, "default": 1, "default_edge_subtyp": [1, 2], "default_unit": 1, "delimit": 10, "depend": 10, "describ": [1, 2], "descript": [1, 2, 4, 10], "description_text": [1, 2], "detail": [4, 9], "develop": [4, 7, 11], "dialog": 1, "dict": 1, "dictionari": 1, "differ": 10, "direct": [9, 10], "directori": [1, 10], "do": [1, 11], "doc": 4, "docstr": 4, "document": [7, 10], "doe": 1, "don": [3, 6], "done": 4, "download": 6, "driven": 4, "e": 10, "each": 10, "easier": [4, 10], "easiest": 9, "edg": 1, "edit": 1, "either": 6, "element": 7, "eman": 1, "embed": 10, "empti": 1, "end": [1, 10], "enhanc": [4, 10], "enough": 9, "ensur": [9, 10], "enumer": 1, "environ": 9, "error": [1, 10], "etc": 11, "even": 4, "event": 1, "everi": 4, "exampl": [1, 9], "exce": 1, "exist": 10, "exit": 1, "exit_nod": [1, 2], "explain": 4, "extens": 1, "factori": 1, "fail": 10, "field": 1, "file": [1, 4, 10], "filenam": 1, "filter": 1, "final": 1, "final_structur": 10, "find": 10, "first": [1, 10], "fix": [10, 11], "flake8": 4, "float": 1, "flowchart": [1, 7], "follow": 9, "foreach": [1, 7, 10], "fork": 4, "format": 1, "format_str": 1, "foundat": 7, "free": 7, "from": [1, 5, 7, 10], "function": [4, 9, 11], "fund": 7, "further": 10, "g": 10, "gap": 1, "gener": 10, "get": [5, 10, 11], "git": [1, 4, 6], "git_revis": [1, 2], "github": [4, 6, 7, 10], "give": 10, "given": 4, "graphic": [1, 9], "greatli": 4, "grid": 11, "group": 1, "gui": 1, "guid": [6, 9, 11], "guidelin": 5, "h": 1, "had": 10, "handl": [1, 10], "have": [4, 6, 10], "help": 4, "help_text": 1, "helper": 1, "here": [4, 9], "histori": 11, "how": [1, 4], "html": 7, "http": [4, 6, 7], "i": [1, 4, 6, 7, 9, 10], "id": 1, "ignor": 10, "import": 8, "improv": 10, "includ": 4, "inclus": 1, "incorrectli": 10, "increment": 1, "index": [0, 5, 7, 10], "indic": 1, "inform": [1, 10], "instal": [4, 5, 10], "institut": 7, "integ": 10, "integr": 1, "interest": 10, "interfac": 1, "intern": 10, "introduct": 11, "io": 7, "issu": [4, 10], "item": [1, 11], "item_nnn": 10, "iter": [1, 10], "iter_format": [1, 2], "job": [1, 10], "join": 3, "just": 4, "keep": 4, "keyword": [1, 10], "kind": 1, "kwarg": 1, "lai": 1, "languag": 7, "last": 1, "lead": 3, "leav": 1, "licens": 7, "like": [7, 10, 11], "line": [1, 10], "linux": 10, "list": [1, 4, 7, 10, 11], "littl": 4, "local": 4, "logger": 1, "look": 4, "loop": [2, 4, 6, 8, 9, 10], "loop_nod": [1, 2], "loop_paramet": 2, "loop_step": [0, 4, 6, 7, 8], "loopparamet": [1, 2], "loopstep": [1, 2], "m": 4, "made": 10, "mai": 1, "main": 10, "make": [4, 10], "mani": [1, 4], "master": 6, "match": [1, 10], "meet": 4, "method": [1, 6], "might": 4, "miss": 10, "mkvirtualenv": 4, "mmcif": 10, "modul": [0, 2, 5], "molecular": 7, "molssi": [3, 6, 7, 10], "molsystem": 10, "more": [1, 4, 9, 10], "most": 6, "move": 10, "much": 10, "my_descript": [1, 2], "my_logg": 1, "name": [1, 4, 10], "narrow": 4, "nation": 7, "need": 1, "nest": 10, "new": [1, 4, 10], "next": [1, 9], "next_anchor": [1, 2], "nice": 1, "node": 1, "node_class": [1, 2], "node_id": 1, "non": [1, 9], "none": 1, "normal": 10, "now": [4, 10], "number": [1, 10, 11], "oac": 7, "object": 1, "offici": 4, "ol": 6, "onc": 6, "one": 9, "op": 1, "open": 4, "oper": [1, 4, 10], "option": 10, "org": [3, 4], "origin": 4, "other": 4, "our": 1, "out": [1, 10], "output": 10, "over": [1, 7, 10, 11], "p": 1, "packag": [0, 2, 7], "page": [0, 5, 10], "paramet": [1, 2], "pars": 10, "parser": 1, "part": [1, 4], "partner": 1, "pass": 4, "paul": 3, "paulsax": 4, "period": 10, "pip": [4, 6], "pleas": 4, "plot": 10, "plug": [6, 8, 9, 12], "plugin": 7, "point": 1, "posit": 1, "possibl": 4, "post": 4, "prefer": 6, "prepar": 10, "print": 10, "probabl": [1, 9], "problem": 10, "process": [6, 10], "program": 7, "project": [4, 7, 8], "properli": 10, "properti": 1, "propos": 4, "provid": [1, 7, 11], "psax": 3, "public": 6, "pull": 5, "pull_request": 4, "push": 4, "put": [4, 9], "py": [4, 6, 10], "pypi": [4, 10], "python": [4, 6, 10], "pyup": 10, "queri": [1, 10], "quot": 10, "rang": 11, "re": 4, "readi": 4, "readm": [4, 10], "readthedoc": 10, "real": 1, "receiv": 7, "recent": 6, "refer": 11, "regexp": [1, 10], "releas": [5, 10], "rememb": 4, "remov": [1, 10], "reorgan": 10, "repo": [4, 6], "repositori": 6, "reproduc": 4, "request": 5, "requir": 10, "rerun": 10, "reset_dialog": [1, 2], "restart": 10, "return": 1, "right_click": [1, 2], "row": [1, 7, 10, 11], "rst": 4, "run": [1, 2, 4, 6], "safe_filenam": [1, 2], "sax": 3, "scienc": 7, "scope": 4, "seamm": [1, 6, 9, 10], "search": [0, 1, 5], "searchabl": 10, "second": [1, 9], "see": [7, 9], "select": [1, 9, 10], "self": 1, "semant": 1, "send": 4, "sequenti": 1, "set": [1, 4], "set_id": [1, 2], "set_subid": [1, 2], "setup": [1, 4, 6, 10], "short": [1, 10], "shortcut": 9, "should": [1, 4, 9], "simpl": [7, 11], "simpli": 9, "so": 10, "softwar": 7, "sometim": 10, "sourc": [1, 5], "stabl": 5, "standard": 10, "start": [1, 5, 10, 11], "stderr": 10, "step": [1, 4, 9], "stevedor": 1, "stop": 1, "str": 1, "straightforward": 9, "string": 1, "structur": [1, 7, 10, 11], "subdirectori": 10, "submodul": 2, "subnod": 1, "subset": 4, "substep": 10, "subtyp": 1, "support": [4, 10], "sure": 4, "sw": 1, "switch": [9, 10], "system": [1, 4, 10], "t": [3, 6], "tab": 9, "tabl": [1, 7, 10, 11], "table1": 1, "tag": 4, "tarbal": 6, "team": 11, "templat": 7, "termin": 6, "test": [1, 4], "test_loop_step": 4, "text": 10, "thei": 4, "them": [1, 4], "theme": 10, "thi": [1, 4, 6, 7, 11], "through": [4, 6], "tip": 5, "tk": 1, "tk_flowchart": 1, "tk_loop": 2, "tkloop": [1, 2], "tknode": 1, "too": 1, "tox": 4, "traceback": 10, "travi": 4, "travisci": 10, "troubleshoot": 4, "two": [1, 9], "two_valu": 1, "type": [1, 5, 9], "under": 7, "up": [4, 9, 10], "updat": [4, 9, 10], "us": [1, 4, 8, 9, 10, 11], "usag": 5, "user": [9, 10, 11], "usual": 1, "valu": [1, 10], "variabl": [1, 10], "version": [1, 2, 4, 10], "view": 10, "virtualenv": 4, "virtualenvwrapp": 4, "volunt": 4, "w": 1, "wa": [7, 10], "wai": [4, 10], "want": 4, "warn": 1, "web": 4, "websit": 4, "welcom": 4, "well": 10, "what": 1, "when": [4, 10], "where": [1, 10], "whether": 4, "which": [1, 7, 10], "whoever": 4, "why": 3, "widget": 1, "wish": 9, "work": [4, 10], "working_path": [1, 2], "would": 4, "wrap": 10, "write": [1, 10], "write_final_structur": [1, 2], "wrote": 10, "x": 1, "xxxx": 12, "y": 1, "you": [3, 4, 6, 9], "your": [4, 6, 9], "your_name_her": 4}, "titles": ["API Documentation", "loop_step package", "loop_step", "Development Team", "Contributing", "Developer Documentation", "Installation", "SEAMM Loop Plug-in", "Usage", "Getting Started", "History", "Loop Step", "User Guide"], "titleterms": {"0": 10, "01": 10, "07": 10, "1": 10, "10": 10, "11": 10, "12": 10, "13": 10, "15": 10, "17": 10, "2": 10, "2019": 10, "2020": 10, "2021": 10, "23": 10, "25": 10, "29": 10, "3": 10, "4": 10, "6": 10, "7": 10, "8": 10, "9": 10, "acknowledg": 7, "api": 0, "april": 10, "august": 10, "bug": 4, "content": 1, "contribut": 4, "decemb": 10, "develop": [3, 5], "document": [0, 4, 5], "featur": [4, 7], "februari": 10, "feedback": 4, "fix": 4, "from": 6, "get": [4, 9], "guid": 12, "guidelin": 4, "histori": 10, "implement": 4, "index": 12, "indic": [0, 5], "inform": 11, "instal": [6, 9], "juli": 10, "loop": [1, 7, 11], "loop_paramet": 1, "loop_step": [1, 2], "modul": 1, "more": 11, "novemb": 10, "octob": 10, "packag": 1, "plug": 7, "pull": 4, "releas": 6, "replac": 9, "report": 4, "request": 4, "seamm": 7, "septemb": 10, "sourc": 6, "stabl": 6, "start": [4, 9], "step": 11, "submit": 4, "submodul": 1, "tabl": [0, 5], "team": 3, "thi": 9, "tip": 4, "tk_loop": 1, "type": 4, "usag": 8, "user": 12, "write": 4}}) \ No newline at end of file diff --git a/user_guide/index.html b/user_guide/index.html index 7956b2c..785b6ee 100644 --- a/user_guide/index.html +++ b/user_guide/index.html @@ -8,7 +8,7 @@ - User Guide — SEAMM Loop Plug-in 2024.8.23 documentation + User Guide — SEAMM Loop Plug-in 2024.10.15 documentation @@ -46,8 +46,8 @@ })(window,document,'script','dataLayer','GTM-PQXXTJ2'); - - + +