diff --git a/docs/build/doctrees/cmpb/about-pipeline.doctree b/docs/build/doctrees/cmpb/about-pipeline.doctree index 95c7afe..a8d5046 100644 Binary files a/docs/build/doctrees/cmpb/about-pipeline.doctree and b/docs/build/doctrees/cmpb/about-pipeline.doctree differ diff --git a/docs/build/doctrees/cmpb/cmpb-config.doctree b/docs/build/doctrees/cmpb/cmpb-config.doctree index 7ed2f13..0a36fc8 100644 Binary files a/docs/build/doctrees/cmpb/cmpb-config.doctree and b/docs/build/doctrees/cmpb/cmpb-config.doctree differ diff --git a/docs/build/doctrees/cmpb/run-pipeline.doctree b/docs/build/doctrees/cmpb/run-pipeline.doctree index 04854ea..83249e7 100644 Binary files a/docs/build/doctrees/cmpb/run-pipeline.doctree and b/docs/build/doctrees/cmpb/run-pipeline.doctree differ diff --git a/docs/build/doctrees/dev-notes.doctree b/docs/build/doctrees/dev-notes.doctree index 5135c3f..df1baab 100644 Binary files a/docs/build/doctrees/dev-notes.doctree and b/docs/build/doctrees/dev-notes.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 239d327..08c4ef7 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/help.doctree b/docs/build/doctrees/help.doctree index 4d2376b..030104b 100644 Binary files a/docs/build/doctrees/help.doctree and b/docs/build/doctrees/help.doctree differ diff --git a/docs/build/doctrees/hqtb/about-pipeline.doctree b/docs/build/doctrees/hqtb/about-pipeline.doctree index e7f3ebc..949538e 100644 Binary files a/docs/build/doctrees/hqtb/about-pipeline.doctree and b/docs/build/doctrees/hqtb/about-pipeline.doctree differ diff --git a/docs/build/doctrees/hqtb/hqtb-config.doctree b/docs/build/doctrees/hqtb/hqtb-config.doctree index e40ffed..d0c4d75 100644 Binary files a/docs/build/doctrees/hqtb/hqtb-config.doctree and b/docs/build/doctrees/hqtb/hqtb-config.doctree differ diff --git a/docs/build/doctrees/hqtb/run-pipeline.doctree b/docs/build/doctrees/hqtb/run-pipeline.doctree index 8770276..00c8717 100644 Binary files a/docs/build/doctrees/hqtb/run-pipeline.doctree and b/docs/build/doctrees/hqtb/run-pipeline.doctree differ diff --git a/docs/build/doctrees/hqtb/step-desc/analysis.doctree b/docs/build/doctrees/hqtb/step-desc/analysis.doctree index 3ac4465..3060d06 100644 Binary files a/docs/build/doctrees/hqtb/step-desc/analysis.doctree and b/docs/build/doctrees/hqtb/step-desc/analysis.doctree differ diff --git a/docs/build/doctrees/hqtb/step-desc/bidirect_blast.doctree b/docs/build/doctrees/hqtb/step-desc/bidirect_blast.doctree index 2b6e346..da546ee 100644 Binary files a/docs/build/doctrees/hqtb/step-desc/bidirect_blast.doctree and b/docs/build/doctrees/hqtb/step-desc/bidirect_blast.doctree differ diff --git a/docs/build/doctrees/hqtb/step-desc/gen_draft.doctree b/docs/build/doctrees/hqtb/step-desc/gen_draft.doctree index d27f158..b91cb89 100644 Binary files a/docs/build/doctrees/hqtb/step-desc/gen_draft.doctree and b/docs/build/doctrees/hqtb/step-desc/gen_draft.doctree differ diff --git a/docs/build/doctrees/hqtb/step-desc/refine-parts/annot.doctree b/docs/build/doctrees/hqtb/step-desc/refine-parts/annot.doctree index b5618bc..192801e 100644 Binary files a/docs/build/doctrees/hqtb/step-desc/refine-parts/annot.doctree and b/docs/build/doctrees/hqtb/step-desc/refine-parts/annot.doctree differ diff --git a/docs/build/doctrees/hqtb/step-desc/refine-parts/cleanup.doctree b/docs/build/doctrees/hqtb/step-desc/refine-parts/cleanup.doctree index 44e12eb..40b0c8c 100644 Binary files a/docs/build/doctrees/hqtb/step-desc/refine-parts/cleanup.doctree and b/docs/build/doctrees/hqtb/step-desc/refine-parts/cleanup.doctree differ diff --git a/docs/build/doctrees/hqtb/step-desc/refine-parts/extension.doctree b/docs/build/doctrees/hqtb/step-desc/refine-parts/extension.doctree index b98ec03..226c6b5 100644 Binary files a/docs/build/doctrees/hqtb/step-desc/refine-parts/extension.doctree and b/docs/build/doctrees/hqtb/step-desc/refine-parts/extension.doctree differ diff --git a/docs/build/doctrees/hqtb/step-desc/refine-parts/smooth.doctree b/docs/build/doctrees/hqtb/step-desc/refine-parts/smooth.doctree index 9adc954..9a68df6 100644 Binary files a/docs/build/doctrees/hqtb/step-desc/refine-parts/smooth.doctree and b/docs/build/doctrees/hqtb/step-desc/refine-parts/smooth.doctree differ diff --git a/docs/build/doctrees/hqtb/step-desc/refinement.doctree b/docs/build/doctrees/hqtb/step-desc/refinement.doctree index 0fcf697..276e6de 100644 Binary files a/docs/build/doctrees/hqtb/step-desc/refinement.doctree and b/docs/build/doctrees/hqtb/step-desc/refinement.doctree differ diff --git a/docs/build/doctrees/hqtb/step-desc/validation.doctree b/docs/build/doctrees/hqtb/step-desc/validation.doctree index 4718890..3bf545b 100644 Binary files a/docs/build/doctrees/hqtb/step-desc/validation.doctree and b/docs/build/doctrees/hqtb/step-desc/validation.doctree differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index a500d18..df3d80c 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/installation.doctree b/docs/build/doctrees/installation.doctree index 71722de..a9d6992 100644 Binary files a/docs/build/doctrees/installation.doctree and b/docs/build/doctrees/installation.doctree differ diff --git a/docs/build/doctrees/modules/classes.doctree b/docs/build/doctrees/modules/classes.doctree index 6efd588..2e97771 100644 Binary files a/docs/build/doctrees/modules/classes.doctree and b/docs/build/doctrees/modules/classes.doctree differ diff --git a/docs/build/doctrees/modules/cmd.doctree b/docs/build/doctrees/modules/cmd.doctree index 33c5b22..1c1ab74 100644 Binary files a/docs/build/doctrees/modules/cmd.doctree and b/docs/build/doctrees/modules/cmd.doctree differ diff --git a/docs/build/doctrees/modules/cmpb.doctree b/docs/build/doctrees/modules/cmpb.doctree index 42578f3..d0ecfa5 100644 Binary files a/docs/build/doctrees/modules/cmpb.doctree and b/docs/build/doctrees/modules/cmpb.doctree differ diff --git a/docs/build/doctrees/modules/core.doctree b/docs/build/doctrees/modules/core.doctree index 9b9a62b..89557b0 100644 Binary files a/docs/build/doctrees/modules/core.doctree and b/docs/build/doctrees/modules/core.doctree differ diff --git a/docs/build/doctrees/modules/hqtb.doctree b/docs/build/doctrees/modules/hqtb.doctree index 66732df..a37c42e 100644 Binary files a/docs/build/doctrees/modules/hqtb.doctree and b/docs/build/doctrees/modules/hqtb.doctree differ diff --git a/docs/build/doctrees/modules/util.doctree b/docs/build/doctrees/modules/util.doctree index 6f34e67..5280c07 100644 Binary files a/docs/build/doctrees/modules/util.doctree and b/docs/build/doctrees/modules/util.doctree differ diff --git a/docs/build/doctrees/overview-pipes.doctree b/docs/build/doctrees/overview-pipes.doctree index 3baee64..83be64a 100644 Binary files a/docs/build/doctrees/overview-pipes.doctree and b/docs/build/doctrees/overview-pipes.doctree differ diff --git a/docs/build/doctrees/pipeline_idea.doctree b/docs/build/doctrees/pipeline_idea.doctree index a677ff4..5a4b668 100644 Binary files a/docs/build/doctrees/pipeline_idea.doctree and b/docs/build/doctrees/pipeline_idea.doctree differ diff --git a/docs/build/doctrees/specimen.doctree b/docs/build/doctrees/specimen.doctree index 6203013..7d06497 100644 Binary files a/docs/build/doctrees/specimen.doctree and b/docs/build/doctrees/specimen.doctree differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index 4a58b49..d8f805c 100644 --- a/docs/build/html/.buildinfo +++ b/docs/build/html/.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: 0fb85034dd4ee52eca935a0038112cc8 +config: e6df1f6e9c96870d3ba9c601c63df629 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_images/genome2draft.png b/docs/build/html/_images/genome2draft.png new file mode 100644 index 0000000..5239b6b Binary files /dev/null and b/docs/build/html/_images/genome2draft.png differ diff --git a/docs/build/html/_images/genome2draft.svg b/docs/build/html/_images/genome2draft.svg deleted file mode 100644 index 8c07bb3..0000000 --- a/docs/build/html/_images/genome2draft.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - - \ No newline at end of file diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html index 9f9c488..5793324 100644 --- a/docs/build/html/_modules/index.html +++ b/docs/build/html/_modules/index.html @@ -18,7 +18,7 @@ - + diff --git a/docs/build/html/_modules/specimen/classes/reports.html b/docs/build/html/_modules/specimen/classes/reports.html index 2e5442b..ea888e1 100644 --- a/docs/build/html/_modules/specimen/classes/reports.html +++ b/docs/build/html/_modules/specimen/classes/reports.html @@ -18,7 +18,7 @@ - + diff --git a/docs/build/html/_modules/specimen/cmpb/workflow.html b/docs/build/html/_modules/specimen/cmpb/workflow.html index d731c7b..3d40bd6 100644 --- a/docs/build/html/_modules/specimen/cmpb/workflow.html +++ b/docs/build/html/_modules/specimen/cmpb/workflow.html @@ -18,7 +18,7 @@ - + diff --git a/docs/build/html/_modules/specimen/hqtb/core/analysis.html b/docs/build/html/_modules/specimen/hqtb/core/analysis.html index 6d363a1..b29de01 100644 --- a/docs/build/html/_modules/specimen/hqtb/core/analysis.html +++ b/docs/build/html/_modules/specimen/hqtb/core/analysis.html @@ -18,7 +18,7 @@ - + diff --git a/docs/build/html/_modules/specimen/hqtb/core/bidirectional_blast.html b/docs/build/html/_modules/specimen/hqtb/core/bidirectional_blast.html index b49f30e..4676990 100644 --- a/docs/build/html/_modules/specimen/hqtb/core/bidirectional_blast.html +++ b/docs/build/html/_modules/specimen/hqtb/core/bidirectional_blast.html @@ -18,7 +18,7 @@ - + diff --git a/docs/build/html/_modules/specimen/hqtb/core/generate_draft_model.html b/docs/build/html/_modules/specimen/hqtb/core/generate_draft_model.html index 6135bc8..a0310c0 100644 --- a/docs/build/html/_modules/specimen/hqtb/core/generate_draft_model.html +++ b/docs/build/html/_modules/specimen/hqtb/core/generate_draft_model.html @@ -18,7 +18,7 @@ - + diff --git a/docs/build/html/_modules/specimen/hqtb/core/refinement/annotation.html b/docs/build/html/_modules/specimen/hqtb/core/refinement/annotation.html index c2c2e9e..5ec316c 100644 --- a/docs/build/html/_modules/specimen/hqtb/core/refinement/annotation.html +++ b/docs/build/html/_modules/specimen/hqtb/core/refinement/annotation.html @@ -18,7 +18,7 @@ - + diff --git a/docs/build/html/_modules/specimen/hqtb/core/refinement/cleanup.html b/docs/build/html/_modules/specimen/hqtb/core/refinement/cleanup.html index 9f1ec5b..d1d3753 100644 --- a/docs/build/html/_modules/specimen/hqtb/core/refinement/cleanup.html +++ b/docs/build/html/_modules/specimen/hqtb/core/refinement/cleanup.html @@ -18,7 +18,7 @@ - + diff --git a/docs/build/html/_modules/specimen/hqtb/core/refinement/extension.html b/docs/build/html/_modules/specimen/hqtb/core/refinement/extension.html index e2bd00a..b0bfb03 100644 --- a/docs/build/html/_modules/specimen/hqtb/core/refinement/extension.html +++ b/docs/build/html/_modules/specimen/hqtb/core/refinement/extension.html @@ -18,7 +18,7 @@ - + @@ -84,7 +84,7 @@
"""Part one of the third step of the pipeline: refinement - extension.
-Extents the model by mapping missing genes to reactions via NCBI, KEGG,
+Extends the model by mapping missing genes to reactions via NCBI, KEGG,
MetaNetX and BiGG.
"""
@@ -1052,7 +1052,7 @@ Source code for specimen.hqtb.core.refinement.extension
bigg_metabolites:pd.DataFrame,
namespace:Literal['BiGG']='BiGG') -> dict[cobra.Metabolite,int]:
"""Based on a given KEGG equation and a model, get or
- create metabolite entires in/for the model.
+ create metabolite entries in/for the model.
Args:
- model (cobra.Model):
diff --git a/docs/build/html/_modules/specimen/hqtb/core/refinement/smoothing.html b/docs/build/html/_modules/specimen/hqtb/core/refinement/smoothing.html
index c870bf8..bc228c2 100644
--- a/docs/build/html/_modules/specimen/hqtb/core/refinement/smoothing.html
+++ b/docs/build/html/_modules/specimen/hqtb/core/refinement/smoothing.html
@@ -18,7 +18,7 @@
-
+
diff --git a/docs/build/html/_modules/specimen/hqtb/core/validation.html b/docs/build/html/_modules/specimen/hqtb/core/validation.html
index 60358f6..b0da381 100644
--- a/docs/build/html/_modules/specimen/hqtb/core/validation.html
+++ b/docs/build/html/_modules/specimen/hqtb/core/validation.html
@@ -18,7 +18,7 @@
-
+
diff --git a/docs/build/html/_modules/specimen/hqtb/workflow.html b/docs/build/html/_modules/specimen/hqtb/workflow.html
index 83f402c..48ee9d9 100644
--- a/docs/build/html/_modules/specimen/hqtb/workflow.html
+++ b/docs/build/html/_modules/specimen/hqtb/workflow.html
@@ -18,7 +18,7 @@
-
+
diff --git a/docs/build/html/_modules/specimen/util/set_up.html b/docs/build/html/_modules/specimen/util/set_up.html
index 134e779..aa80413 100644
--- a/docs/build/html/_modules/specimen/util/set_up.html
+++ b/docs/build/html/_modules/specimen/util/set_up.html
@@ -18,7 +18,7 @@
-
+
@@ -225,7 +225,7 @@ Source code for specimen.util.set_up
The media config and the config for the cmpb / CarveMe + Modelpolisher based pipeline
can be downloaded using 'media' and 'cmpb' respectively
- For the htqb / high-quality template based pipeline:
+ For the hqtb / high-quality template based pipeline:
Depending on the knowledge of the user, either a 'hqtb-basic' or an 'hqtb-advanced' type
of configuration file can be downloaded (or 'hqtb-defaults' for developers).
@@ -234,7 +234,7 @@ Source code for specimen.util.set_up
- filename (str, optional):
Filename/filepath to save the downloaded config file under.
Defaults to 'my_basic_config.yaml'.
- - type (Literal['htqb-basic','htqb-advanced','htqb-defaults','media','cmpb'], optional):
+ - type (Literal['hqtb-basic','hqtb-advanced','hqtb-defaults','media','cmpb'], optional):
The type of file to download.
Can be 'hqtb-basic', 'hqtb-advanced' or 'hqtb-defaults' or 'media' or 'cmpb'.
Defaults to 'hqtb basic'.
@@ -247,19 +247,19 @@ Source code for specimen.util.set_up
match type:
# the 'beginner' version
case 'hqtb-basic':
- config_file = files('specimen.data.config').joinpath('htqb_basic_config_expl.yaml')
+ config_file = files('specimen.data.config').joinpath('hqtb_basic_config_expl.yaml')
with open(config_file, "r") as cfg_file, open(filename, 'w') as cfg_out:
for line in cfg_file:
cfg_out.write(line)
# for advanced users
case 'hqtb-advanced':
- config_file = files('specimen.data.config').joinpath('htqb_advanced_config_expl.yaml')
+ config_file = files('specimen.data.config').joinpath('hqtb_advanced_config_expl.yaml')
with open(config_file, "r") as cfg_file, open(filename, 'w') as cfg_out:
for line in cfg_file:
cfg_out.write(line)
# for developer: the config with all internal defaults
case 'hqtb-defaults':
- config_file = files('specimen.data.config').joinpath('htqb_config_default.yaml')
+ config_file = files('specimen.data.config').joinpath('hqtb_config_default.yaml')
with open(config_file, "r") as cfg_file, open(filename, 'w') as cfg_out:
for line in cfg_file:
cfg_out.write(line)
@@ -384,7 +384,7 @@ Source code for specimen.util.set_up
# load both files
match pipeline:
case 'hqtb':
- defaultc_path = files('specimen.data.config').joinpath('htqb_config_default.yaml')
+ defaultc_path = files('specimen.data.config').joinpath('hqtb_config_default.yaml')
case 'cmpb':
defaultc_path = files('specimen.data.config').joinpath('cmpb_config.yaml')
case _:
diff --git a/docs/build/html/_modules/specimen/util/util.html b/docs/build/html/_modules/specimen/util/util.html
index 0b81185..1c16c7f 100644
--- a/docs/build/html/_modules/specimen/util/util.html
+++ b/docs/build/html/_modules/specimen/util/util.html
@@ -18,7 +18,7 @@
-
+
diff --git a/docs/build/html/_sources/pipeline_idea.rst.txt b/docs/build/html/_sources/pipeline_idea.rst.txt
index d93a94e..772be29 100644
--- a/docs/build/html/_sources/pipeline_idea.rst.txt
+++ b/docs/build/html/_sources/pipeline_idea.rst.txt
@@ -32,7 +32,7 @@ workflow in Figure :numref:`pgab_workflow` can be used.
.. _pgab_workflow:
-.. figure:: images/genome2draft.svg
+.. figure:: images/genome2draft.png
:alt: Workflow from genome sequence to a draft model
Workflow from genome sequence to a draft model
diff --git a/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css
index 30fee9d..f316efc 100644
--- a/docs/build/html/_static/basic.css
+++ b/docs/build/html/_static/basic.css
@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/docs/build/html/_static/doctools.js b/docs/build/html/_static/doctools.js
index d06a71d..4d67807 100644
--- a/docs/build/html/_static/doctools.js
+++ b/docs/build/html/_static/doctools.js
@@ -4,7 +4,7 @@
*
* Base JavaScript utilities for all Sphinx HTML documentation.
*
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/docs/build/html/_static/language_data.js b/docs/build/html/_static/language_data.js
index 250f566..367b8ed 100644
--- a/docs/build/html/_static/language_data.js
+++ b/docs/build/html/_static/language_data.js
@@ -5,7 +5,7 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -13,7 +13,7 @@
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"];
-/* Non-minified version is copied as a separate JS file, is available */
+/* Non-minified version is copied as a separate JS file, if available */
/**
* Porter Stemmer
diff --git a/docs/build/html/_static/searchtools.js b/docs/build/html/_static/searchtools.js
index 7918c3f..92da3f8 100644
--- a/docs/build/html/_static/searchtools.js
+++ b/docs/build/html/_static/searchtools.js
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -99,7 +99,7 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
.then((data) => {
if (data)
listItem.appendChild(
- Search.makeSearchSummary(data, searchTerms)
+ Search.makeSearchSummary(data, searchTerms, anchor)
);
// highlight search terms in the summary
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
@@ -116,8 +116,8 @@ const _finishSearch = (resultCount) => {
);
else
Search.status.innerText = _(
- `Search finished, found ${resultCount} page(s) matching the search query.`
- );
+ "Search finished, found ${resultCount} page(s) matching the search query."
+ ).replace('${resultCount}', resultCount);
};
const _displayNextItem = (
results,
@@ -137,6 +137,22 @@ const _displayNextItem = (
// search finished, update title and status message
else _finishSearch(resultCount);
};
+// Helper function used by query() to order search results.
+// Each input is an array of [docname, title, anchor, descr, score, filename].
+// 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) => {
+ const leftScore = a[4];
+ const rightScore = b[4];
+ if (leftScore === rightScore) {
+ // same score: sort alphabetically
+ const leftTitle = a[1].toLowerCase();
+ const rightTitle = b[1].toLowerCase();
+ if (leftTitle === rightTitle) return 0;
+ return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+ }
+ return leftScore > rightScore ? 1 : -1;
+};
/**
* Default splitQuery function. Can be overridden in ``sphinx.search`` with a
@@ -160,13 +176,26 @@ const Search = {
_queued_query: null,
_pulse_status: -1,
- htmlToText: (htmlString) => {
+ htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
- htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
+ for (const removalQuery of [".headerlinks", "script", "style"]) {
+ htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
+ }
+ if (anchor) {
+ const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
+ if (anchorContent) return anchorContent.textContent;
+
+ console.warn(
+ `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
+ );
+ }
+
+ // if anchor not specified or not found, fall back to main content
const docContent = htmlElement.querySelector('[role="main"]');
- if (docContent !== undefined) return docContent.textContent;
+ if (docContent) return docContent.textContent;
+
console.warn(
- "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template."
+ "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
);
return "";
},
@@ -239,16 +268,7 @@ const Search = {
else Search.deferQuery(query);
},
- /**
- * execute search (requires search index to be loaded)
- */
- query: (query) => {
- const filenames = Search._index.filenames;
- const docNames = Search._index.docnames;
- const titles = Search._index.titles;
- const allTitles = Search._index.alltitles;
- const indexEntries = Search._index.indexentries;
-
+ _parseQuery: (query) => {
// stem the search terms and add them to the correct list
const stemmer = new Stemmer();
const searchTerms = new Set();
@@ -284,16 +304,32 @@ const Search = {
// console.info("required: ", [...searchTerms]);
// console.info("excluded: ", [...excludedTerms]);
- // array of [docname, title, anchor, descr, score, filename]
- let results = [];
+ return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
+ },
+
+ /**
+ * execute search (requires search index to be loaded)
+ */
+ _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+ const allTitles = Search._index.alltitles;
+ 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].
+ const normalResults = [];
+ const nonMainIndexResults = [];
+
_removeChildren(document.getElementById("search-progress"));
- const queryLower = query.toLowerCase();
+ const queryLower = query.toLowerCase().trim();
for (const [title, foundTitles] of Object.entries(allTitles)) {
- if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
+ if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
for (const [file, id] of foundTitles) {
let score = Math.round(100 * queryLower.length / title.length)
- results.push([
+ normalResults.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
@@ -308,46 +344,47 @@ const Search = {
// search for explicit entries in index directives
for (const [entry, foundEntries] of Object.entries(indexEntries)) {
if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
- for (const [file, id] of foundEntries) {
- let score = Math.round(100 * queryLower.length / entry.length)
- results.push([
+ for (const [file, id, isMain] of foundEntries) {
+ const score = Math.round(100 * queryLower.length / entry.length);
+ const result = [
docNames[file],
titles[file],
id ? "#" + id : "",
null,
score,
filenames[file],
- ]);
+ ];
+ if (isMain) {
+ normalResults.push(result);
+ } else {
+ nonMainIndexResults.push(result);
+ }
}
}
}
// lookup as object
objectTerms.forEach((term) =>
- results.push(...Search.performObjectSearch(term, objectTerms))
+ normalResults.push(...Search.performObjectSearch(term, objectTerms))
);
// lookup as search terms in fulltext
- results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+ normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
// let the scorer override scores with a custom scoring function
- if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item)));
-
- // now sort the results by score (in opposite order of appearance, since the
- // display function below uses pop() to retrieve items) and then
- // alphabetically
- results.sort((a, b) => {
- const leftScore = a[4];
- const rightScore = b[4];
- if (leftScore === rightScore) {
- // same score: sort alphabetically
- const leftTitle = a[1].toLowerCase();
- const rightTitle = b[1].toLowerCase();
- if (leftTitle === rightTitle) return 0;
- return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
- }
- return leftScore > rightScore ? 1 : -1;
- });
+ if (Scorer.score) {
+ normalResults.forEach((item) => (item[4] = Scorer.score(item)));
+ nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
+ }
+
+ // Sort each group of results by score and then alphabetically by name.
+ normalResults.sort(_orderResultsByScoreThenName);
+ nonMainIndexResults.sort(_orderResultsByScoreThenName);
+
+ // Combine the result groups in (reverse) order.
+ // Non-main index entries are typically arbitrary cross-references,
+ // so display them after other results.
+ let results = [...nonMainIndexResults, ...normalResults];
// remove duplicate search results
// note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
@@ -361,7 +398,12 @@ const Search = {
return acc;
}, []);
- results = results.reverse();
+ return results.reverse();
+ },
+
+ query: (query) => {
+ const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
+ const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
// for debugging
//Search.lastresults = results.slice(); // a copy
@@ -466,14 +508,18 @@ const Search = {
// add support for partial matches
if (word.length > 2) {
const escapedWord = _escapeRegExp(word);
- Object.keys(terms).forEach((term) => {
- if (term.match(escapedWord) && !terms[word])
- arr.push({ files: terms[term], score: Scorer.partialTerm });
- });
- Object.keys(titleTerms).forEach((term) => {
- if (term.match(escapedWord) && !titleTerms[word])
- arr.push({ files: titleTerms[word], score: Scorer.partialTitle });
- });
+ if (!terms.hasOwnProperty(word)) {
+ Object.keys(terms).forEach((term) => {
+ if (term.match(escapedWord))
+ arr.push({ files: terms[term], score: Scorer.partialTerm });
+ });
+ }
+ if (!titleTerms.hasOwnProperty(word)) {
+ Object.keys(titleTerms).forEach((term) => {
+ if (term.match(escapedWord))
+ arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
+ });
+ }
}
// no match but word was a required one
@@ -496,9 +542,8 @@ const Search = {
// create the mapping
files.forEach((file) => {
- if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1)
- fileMap.get(file).push(word);
- else fileMap.set(file, [word]);
+ if (!fileMap.has(file)) fileMap.set(file, [word]);
+ else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
});
});
@@ -549,8 +594,8 @@ const Search = {
* search summary for a given text. keywords is a list
* of stemmed words.
*/
- makeSearchSummary: (htmlText, keywords) => {
- const text = Search.htmlToText(htmlText);
+ makeSearchSummary: (htmlText, keywords, anchor) => {
+ const text = Search.htmlToText(htmlText, anchor);
if (text === "") return null;
const textLower = text.toLowerCase();
diff --git a/docs/build/html/cmpb/about-pipeline.html b/docs/build/html/cmpb/about-pipeline.html
index 825a824..0ebcc24 100644
--- a/docs/build/html/cmpb/about-pipeline.html
+++ b/docs/build/html/cmpb/about-pipeline.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/cmpb/cmpb-config.html b/docs/build/html/cmpb/cmpb-config.html
index 8e01ed3..907f0cf 100644
--- a/docs/build/html/cmpb/cmpb-config.html
+++ b/docs/build/html/cmpb/cmpb-config.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/cmpb/run-pipeline.html b/docs/build/html/cmpb/run-pipeline.html
index b81da49..348ef76 100644
--- a/docs/build/html/cmpb/run-pipeline.html
+++ b/docs/build/html/cmpb/run-pipeline.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/dev-notes.html b/docs/build/html/dev-notes.html
index e8df9f0..38d5c44 100644
--- a/docs/build/html/dev-notes.html
+++ b/docs/build/html/dev-notes.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
index 3596f2c..1769ec6 100644
--- a/docs/build/html/genindex.html
+++ b/docs/build/html/genindex.html
@@ -18,7 +18,7 @@
-
+
diff --git a/docs/build/html/help.html b/docs/build/html/help.html
index 92c0113..81cd7b9 100644
--- a/docs/build/html/help.html
+++ b/docs/build/html/help.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/hqtb/about-pipeline.html b/docs/build/html/hqtb/about-pipeline.html
index 60613b3..2f3aec5 100644
--- a/docs/build/html/hqtb/about-pipeline.html
+++ b/docs/build/html/hqtb/about-pipeline.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/hqtb/hqtb-config.html b/docs/build/html/hqtb/hqtb-config.html
index d4feef5..21fc6a1 100644
--- a/docs/build/html/hqtb/hqtb-config.html
+++ b/docs/build/html/hqtb/hqtb-config.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/hqtb/run-pipeline.html b/docs/build/html/hqtb/run-pipeline.html
index 9d8e091..c2b91ca 100644
--- a/docs/build/html/hqtb/run-pipeline.html
+++ b/docs/build/html/hqtb/run-pipeline.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/hqtb/step-desc/analysis.html b/docs/build/html/hqtb/step-desc/analysis.html
index b78ce06..4db7210 100644
--- a/docs/build/html/hqtb/step-desc/analysis.html
+++ b/docs/build/html/hqtb/step-desc/analysis.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/hqtb/step-desc/bidirect_blast.html b/docs/build/html/hqtb/step-desc/bidirect_blast.html
index d92079c..1295af1 100644
--- a/docs/build/html/hqtb/step-desc/bidirect_blast.html
+++ b/docs/build/html/hqtb/step-desc/bidirect_blast.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/hqtb/step-desc/gen_draft.html b/docs/build/html/hqtb/step-desc/gen_draft.html
index 7cad26c..52d7167 100644
--- a/docs/build/html/hqtb/step-desc/gen_draft.html
+++ b/docs/build/html/hqtb/step-desc/gen_draft.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/hqtb/step-desc/refine-parts/annot.html b/docs/build/html/hqtb/step-desc/refine-parts/annot.html
index 96945ee..3d0bcd9 100644
--- a/docs/build/html/hqtb/step-desc/refine-parts/annot.html
+++ b/docs/build/html/hqtb/step-desc/refine-parts/annot.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/hqtb/step-desc/refine-parts/cleanup.html b/docs/build/html/hqtb/step-desc/refine-parts/cleanup.html
index 97ba1fc..d09f5b0 100644
--- a/docs/build/html/hqtb/step-desc/refine-parts/cleanup.html
+++ b/docs/build/html/hqtb/step-desc/refine-parts/cleanup.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/hqtb/step-desc/refine-parts/extension.html b/docs/build/html/hqtb/step-desc/refine-parts/extension.html
index 56a3097..a7462a5 100644
--- a/docs/build/html/hqtb/step-desc/refine-parts/extension.html
+++ b/docs/build/html/hqtb/step-desc/refine-parts/extension.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/hqtb/step-desc/refine-parts/smooth.html b/docs/build/html/hqtb/step-desc/refine-parts/smooth.html
index 596cdc9..437609a 100644
--- a/docs/build/html/hqtb/step-desc/refine-parts/smooth.html
+++ b/docs/build/html/hqtb/step-desc/refine-parts/smooth.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/hqtb/step-desc/refinement.html b/docs/build/html/hqtb/step-desc/refinement.html
index 7f95084..69dce11 100644
--- a/docs/build/html/hqtb/step-desc/refinement.html
+++ b/docs/build/html/hqtb/step-desc/refinement.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/hqtb/step-desc/validation.html b/docs/build/html/hqtb/step-desc/validation.html
index ef4f1ca..0c017ac 100644
--- a/docs/build/html/hqtb/step-desc/validation.html
+++ b/docs/build/html/hqtb/step-desc/validation.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/index.html b/docs/build/html/index.html
index 5dda506..cca9701 100644
--- a/docs/build/html/index.html
+++ b/docs/build/html/index.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/installation.html b/docs/build/html/installation.html
index 150caaa..b47daa5 100644
--- a/docs/build/html/installation.html
+++ b/docs/build/html/installation.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/modules/classes.html b/docs/build/html/modules/classes.html
index e691b67..eee375c 100644
--- a/docs/build/html/modules/classes.html
+++ b/docs/build/html/modules/classes.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/modules/cmd.html b/docs/build/html/modules/cmd.html
index bc797eb..db80915 100644
--- a/docs/build/html/modules/cmd.html
+++ b/docs/build/html/modules/cmd.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/modules/cmpb.html b/docs/build/html/modules/cmpb.html
index 309e2fd..e888067 100644
--- a/docs/build/html/modules/cmpb.html
+++ b/docs/build/html/modules/cmpb.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/modules/core.html b/docs/build/html/modules/core.html
index 5c623e0..ad8469e 100644
--- a/docs/build/html/modules/core.html
+++ b/docs/build/html/modules/core.html
@@ -19,7 +19,7 @@
-
+
@@ -335,7 +335,7 @@ specimen.hqtb.core.refinement subpackage
-specimen.hqtb.core.refinement.cleanup.run(model: str, dir: str, biocyc_db: str | None = None, check_dupl_reac: bool = False, check_dupl_meta: bool = 'default', remove_unused_meta: bool = False, remove_dupl_reac: bool = False, remove_dupl_meta: bool = False, universal: str | None = None, media_path: str | None = None, namespace: Literal['BiGG'] = 'BiGG', growth_threshold: float = 0.05, iterations: int = 3, chunk_size: int = 10000, memote: bool = False)[source]
+specimen.hqtb.core.refinement.cleanup.run(model: str, dir: str, biocyc_db: str = None, check_dupl_reac: bool = False, check_dupl_meta: bool = 'default', remove_unused_meta: bool = False, remove_dupl_reac: bool = False, remove_dupl_meta: bool = False, universal: str = None, media_path: str = None, namespace: Literal['BiGG'] = 'BiGG', growth_threshold: float = 0.05, iterations: int = 3, chunk_size: int = 10000, memote: bool = False)[source]
Perform the second refinement step, cleanup, on a model.
The second refinement step resolves the following issues:
@@ -496,7 +496,7 @@ specimen.hqtb.core.refinement subpackage
specimen.hqtb.core.refinement.extension submodule
Part one of the third step of the pipeline: refinement - extension.
-Extents the model by mapping missing genes to reactions via NCBI, KEGG,
+
Extends the model by mapping missing genes to reactions via NCBI, KEGG,
MetaNetX and BiGG.
-
@@ -792,7 +792,7 @@
specimen.hqtb.core.refinement subpackage
specimen.hqtb.core.refinement.extension.get_metabolites_kegg(model: Model, equation: str, chem_xref: DataFrame, chem_prop: DataFrame, bigg_metabolites: DataFrame, namespace: Literal['BiGG'] = 'BiGG') dict[Metabolite, int] [source]
Based on a given KEGG equation and a model, get or
-create metabolite entires in/for the model.
+create metabolite entries in/for the model.
- Args:
@@ -886,7 +886,7 @@ specimen.hqtb.core.refinement subpackage
-
-specimen.hqtb.core.refinement.extension.get_ncbi_info(table: DataFrame, ncbi_map_file: str | None = None) DataFrame [source]
+specimen.hqtb.core.refinement.extension.get_ncbi_info(table: DataFrame, ncbi_map_file: str = None) DataFrame [source]
Retrieve information from NCBI via mapping to precomputed files.
If no mapping exists, try via Entrez - implemented, but does not work well
@@ -1051,7 +1051,7 @@ specimen.hqtb.core.refinement subpackage
-
-specimen.hqtb.core.refinement.extension.map_to_KEGG(gene_table: DataFrame, working_dir: str, manual_dir: str, genome_summary: str | None = None) Path [source]
+specimen.hqtb.core.refinement.extension.map_to_KEGG(gene_table: DataFrame, working_dir: str, manual_dir: str, genome_summary: str = None) Path [source]
Map entries of the table from get_ncbi_info()
to KEGG.
Get KEGG.reaction ID from locus tag, if available, otherwise try EC number.
Entries of the finalised table are saved depending whether they were assigned
@@ -1091,7 +1091,7 @@
specimen.hqtb.core.refinement subpackage
-
-specimen.hqtb.core.refinement.extension.map_to_KEGG_row(row: Series, loci_list: list[str] | None = None) Series [source]
+specimen.hqtb.core.refinement.extension.map_to_KEGG_row(row: Series, loci_list: list[str] = None) Series [source]
Map a single entry of the table in map_to_KEGG()
to KEGG.
- Args:
@@ -1346,7 +1346,7 @@ specimen.hqtb.core submodules
-
-specimen.hqtb.core.analysis.run(model_path: str, dir: str, media_path: str | None = None, namespace: Literal['BiGG'] = 'BiGG', pc_model_path: str | None = None, pc_based_on: Literal['id'] = 'id', test_aa_auxotrophies: bool = True, pathway: bool = True)[source]
+specimen.hqtb.core.analysis.run(model_path: str, dir: str, media_path: str = None, namespace: Literal['BiGG'] = 'BiGG', pc_model_path: str = None, pc_based_on: Literal['id'] = 'id', test_aa_auxotrophies: bool = True, pathway: bool = True)[source]
SPECIMEN Step 5: Analyse the generated model.
- Args:
@@ -1563,7 +1563,7 @@ specimen.hqtb.core submodules
-
-specimen.hqtb.core.bidirectional_blast.run(template: str, input: str, dir: str, template_name: str | None = None, input_name: str | None = None, temp_header: str = 'protein_id', in_header: str = 'locus_tag', threads: int = 2, extra_info: list[str] = ['locus_tag', 'product', 'protein_id'], sensitivity: Literal['sensitive', 'more-sensitive', 'very-sensitive', 'ultra-sensitive'] = 'more-sensitive')[source]
+specimen.hqtb.core.bidirectional_blast.run(template: str, input: str, dir: str, template_name: str = None, input_name: str = None, temp_header: str = 'protein_id', in_header: str = 'locus_tag', threads: int = 2, extra_info: list[str] = ['locus_tag', 'product', 'protein_id'], sensitivity: Literal['sensitive', 'more-sensitive', 'very-sensitive', 'ultra-sensitive'] = 'more-sensitive')[source]
Run the bidirectional blast on a template and input genome (annotated).
- Args:
diff --git a/docs/build/html/modules/hqtb.html b/docs/build/html/modules/hqtb.html
index d9c45f1..6d9fda2 100644
--- a/docs/build/html/modules/hqtb.html
+++ b/docs/build/html/modules/hqtb.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/modules/util.html b/docs/build/html/modules/util.html
index 9b6c1e5..e3bc7d9 100644
--- a/docs/build/html/modules/util.html
+++ b/docs/build/html/modules/util.html
@@ -19,7 +19,7 @@
-
+
@@ -146,7 +146,7 @@ specimen.util submodules
-- type (Literal[‘htqb-basic’,’htqb-advanced’,’htqb-defaults’,’media’,’cmpb’], optional):
The type of file to download.
+
- type (Literal[‘hqtb-basic’,’hqtb-advanced’,’hqtb-defaults’,’media’,’cmpb’], optional):
The type of file to download.
Can be ‘hqtb-basic’, ‘hqtb-advanced’ or ‘hqtb-defaults’ or ‘media’ or ‘cmpb’.
Defaults to ‘hqtb basic’.
diff --git a/docs/build/html/overview-pipes.html b/docs/build/html/overview-pipes.html
index f43ff44..eb21912 100644
--- a/docs/build/html/overview-pipes.html
+++ b/docs/build/html/overview-pipes.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/pipeline_idea.html b/docs/build/html/pipeline_idea.html
index 9411c48..ef37c9e 100644
--- a/docs/build/html/pipeline_idea.html
+++ b/docs/build/html/pipeline_idea.html
@@ -19,7 +19,7 @@
-
+
@@ -133,7 +133,8 @@ PGAB: From genome sequence to draft model
-
+
+
diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html
index 0168d64..3676542 100644
--- a/docs/build/html/py-modindex.html
+++ b/docs/build/html/py-modindex.html
@@ -18,7 +18,7 @@
-
+
diff --git a/docs/build/html/search.html b/docs/build/html/search.html
index 1666ce5..98f442d 100644
--- a/docs/build/html/search.html
+++ b/docs/build/html/search.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
index a538517..350f335 100644
--- a/docs/build/html/searchindex.js
+++ b/docs/build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["cmpb/about-pipeline", "cmpb/cmpb-config", "cmpb/run-pipeline", "dev-notes", "help", "hqtb/about-pipeline", "hqtb/hqtb-config", "hqtb/run-pipeline", "hqtb/step-desc/analysis", "hqtb/step-desc/bidirect_blast", "hqtb/step-desc/gen_draft", "hqtb/step-desc/refine-parts/annot", "hqtb/step-desc/refine-parts/cleanup", "hqtb/step-desc/refine-parts/extension", "hqtb/step-desc/refine-parts/smooth", "hqtb/step-desc/refinement", "hqtb/step-desc/validation", "index", "installation", "modules/classes", "modules/cmd", "modules/cmpb", "modules/core", "modules/hqtb", "modules/util", "overview-pipes", "pipeline_idea", "specimen"], "filenames": ["cmpb/about-pipeline.rst", "cmpb/cmpb-config.rst", "cmpb/run-pipeline.rst", "dev-notes.rst", "help.rst", "hqtb/about-pipeline.rst", "hqtb/hqtb-config.rst", "hqtb/run-pipeline.rst", "hqtb/step-desc/analysis.rst", "hqtb/step-desc/bidirect_blast.rst", "hqtb/step-desc/gen_draft.rst", "hqtb/step-desc/refine-parts/annot.rst", "hqtb/step-desc/refine-parts/cleanup.rst", "hqtb/step-desc/refine-parts/extension.rst", "hqtb/step-desc/refine-parts/smooth.rst", "hqtb/step-desc/refinement.rst", "hqtb/step-desc/validation.rst", "index.rst", "installation.rst", "modules/classes.rst", "modules/cmd.rst", "modules/cmpb.rst", "modules/core.rst", "modules/hqtb.rst", "modules/util.rst", "overview-pipes.rst", "pipeline_idea.rst", "specimen.rst"], "titles": ["About CMPB", "CMPB Configuration File", "Run the CMPB Pipeline", "Notes for Developers", "Help & FAQ", "About HQTB", "HQTB Configuration File", "Run the HTQB Pipeline", "5. Step 5: Analyse the Model", "1. Step 1: Bidirectional BLAST", "2. Step 2: Generate a Draft Model", "3.3. Step 3, Part 3: Further Annotate the Model", "3.2. Step 3, Part 2: Cleaning the Model", "3.1. Step 3, Part 1: Extending the Model", "3.4. Step 3, Part 4: Smoothing", "3. Step 3: Further Refine the Model", "4. Step 4: Model Validation", "Welcome to SPECIMEN!", "Installation", "specimen.classes package", "The specimen.cmd_access submodule", "specimen.cmpb package", "specimen.hqtb.core package", "specimen.hqtb package", "specimen.util package", "Overview of the Pipelines", "PGAB: From genome sequence to draft model", "Contents of SPECIMEN"], "terms": {"under": [0, 1, 10, 20, 22, 24, 25], "construct": [0, 7, 10, 20, 25], "The": [0, 1, 2, 3, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 18, 19, 21, 22, 23, 24, 25, 26, 27], "carvem": [0, 1, 2, 17, 21, 24, 26], "modelpolish": [0, 2, 17, 24], "base": [0, 1, 2, 3, 5, 6, 7, 9, 10, 16, 17, 19, 20, 22, 23, 24, 26], "below": [1, 3, 6, 8, 9, 10, 14, 16, 25, 27], "underli": [1, 6, 22], "default": [1, 6, 19, 20, 21, 22, 23, 24], "i": [1, 2, 3, 6, 7, 8, 9, 10, 11, 12, 13, 15, 17, 18, 20, 22, 24, 25, 26, 27], "list": [1, 5, 6, 7, 20, 22, 27], "specimen": [1, 2, 3, 5, 7, 18], "pipelin": [1, 3, 4, 6, 8, 9, 10, 11, 12, 15, 16, 20, 21, 22, 23, 24, 26], "explain": [1, 2, 7], "paramet": [1, 2, 5, 6, 7, 16, 20, 22, 24], "valu": [1, 9, 10, 20, 22], "__user__": [1, 6], "ar": [1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 16, 17, 20, 22, 24, 25, 27], "requir": [1, 2, 6, 7, 20, 22, 25], "specifi": [1, 20], "user": [1, 6, 7, 21, 24, 25], "onli": [1, 2, 6, 7, 12, 20, 22], "specif": [1, 3, 15, 17, 19, 20, 23], "case": [1, 2, 6, 7, 22], "meta": 1, "info": 1, "model": [1, 2, 3, 5, 6, 7, 9, 14, 17, 19, 20, 22, 23, 25], "organ": [1, 2, 6, 7, 20, 22, 25, 26], "date": 1, "author": 1, "input": [1, 2, 7, 9, 13, 15, 20, 22, 24, 25, 26], "modelpath": 1, "null": [1, 6], "option": [1, 2, 6, 7, 8, 12, 14, 18, 19, 22, 23, 24, 27], "path": [1, 2, 6, 7, 20, 21, 22, 23, 24], "If": [1, 3, 4, 7, 20, 21, 22], "given": [1, 2, 6, 19, 20, 21, 22, 24], "run": [1, 4, 5, 6, 16, 18, 21, 22, 23, 24, 25, 26, 27], "annotated_genom": [1, 6, 7, 23], "annot": [1, 2, 3, 5, 6, 7, 12, 15, 20, 23, 25, 26], "genom": [1, 2, 3, 5, 6, 7, 9, 10, 13, 15, 17, 20, 22, 23, 25], "mediapath": 1, "media": [1, 2, 6, 7, 20, 22, 24], "config": [1, 2, 6, 7, 20, 22, 23, 24], "test": [1, 2, 3, 4, 8, 20, 22], "growth": [1, 2, 8, 10, 20, 22], "gener": [1, 2, 3, 5, 6, 8, 9, 13, 15, 16, 19, 22, 23, 25, 26, 27], "dir": [1, 6, 19, 20, 22, 24], "name": [1, 6, 7, 10, 20, 22, 23, 24, 27], "directori": [1, 6, 7, 18, 20, 22, 23, 24], "save": [1, 19, 20, 22, 24], "output": [1, 6, 7, 20, 22, 23, 24], "colour": 1, "ylgn": [1, 19], "set": [1, 3, 6, 7, 8, 10, 19, 20, 22, 24, 25], "scheme": 1, "plot": 1, "should": [1, 2, 6, 20, 22, 24, 25], "valid": [1, 5, 6, 20, 23, 24, 26], "matplotlib": [1, 19], "continu": [1, 26], "color": [1, 19], "palett": [1, 19], "namespac": [1, 6, 20, 22], "bigg": [1, 4, 6, 20, 22], "us": [1, 2, 3, 6, 7, 9, 10, 12, 14, 17, 19, 20, 22, 23, 24, 25, 26, 27], "possibl": [1, 22, 24], "identifi": [1, 4, 7, 9, 20, 22, 26], "current": [1, 2, 4, 6, 7, 8, 11, 12, 16, 17, 22, 24, 25], "save_all_model": 1, "true": [1, 2, 3, 6, 20, 22], "all": [1, 2, 5, 6, 7, 10, 12, 18, 20, 22], "each": [1, 7], "step": [1, 2, 5, 6, 7, 17, 20, 21, 22, 24, 26], "memote_always_on": 1, "fals": [1, 6, 22], "memot": [1, 6, 20, 22], "after": [1, 2, 7, 16, 20, 22], "everi": 1, "stats_always_on": 1, "calcul": 1, "statist": [1, 8], "multipl": [1, 5, 7, 20, 22, 23], "refseq_gff": 1, "refseq": [1, 7, 22, 26], "gff": [1, 2], "gap": [1, 2], "analysi": [1, 2, 5, 6, 7, 8, 20, 23], "kegg": [1, 2, 6, 7, 11, 20, 22, 25], "can": [1, 2, 3, 5, 6, 7, 8, 10, 16, 18, 20, 22, 23, 24, 25, 26], "provid": 1, "cm": 1, "polish": [1, 2, 25], "kegg_organism_id": 1, "id": [1, 2, 6, 20, 22], "part": [1, 15, 16, 20, 22], "neccessari": [1, 2, 7, 10, 18, 20], "mode": [1, 20, 22], "ha": [1, 2, 3, 4, 16, 18, 24, 25, 26], "been": [1, 3, 4, 5, 7, 13, 16, 18], "build": [1, 5, 7, 22, 24], "inde": 1, "email": 1, "mail": 1, "entrez": [1, 22], "protein_fasta": 1, "except": [1, 6, 12], "is_lab_strain": 1, "protein": [1, 2, 20, 22, 26], "fasta": [1, 2, 20, 22, 24, 26], "creat": [1, 2, 3, 7, 16, 18, 22, 23, 24, 26], "whether": [1, 7, 22], "strain": [1, 5, 9, 10, 15, 17, 23], "origin": [1, 4, 19, 22, 25], "from": [1, 2, 5, 6, 7, 10, 13, 20, 22, 24, 25, 27], "lab": 1, "need": [1, 2, 5, 6, 7, 10, 18, 20, 21, 22, 24], "ensur": [1, 7, 9, 16], "get": [1, 22], "bqbiol": 1, "ishomologto": 1, "qualifi": [1, 20, 22, 24], "locus_tag": [1, 6, 7, 20, 22, 24], "ones": [1, 6, 22], "obtain": [1, 26], "gapfil": [1, 2, 6, 7, 12, 20, 22, 25], "automat": 1, "fill": 1, "db_to_compar": 1, "choic": [1, 20], "biocyc_fil": 1, "which": [1, 16, 20, 22, 24, 25, 27], "gap_fill_param": 1, "One": 1, "biocyc": [1, 2, 6, 7, 12, 20, 22, 25], "txt": [1, 2], "contain": [1, 2, 7, 17, 20, 21, 22, 23, 24, 26, 27], "smarttabl": 1, "column": [1, 2, 7, 20, 22, 24], "access": [1, 2, 5, 7, 18, 20, 22, 27], "2": [1, 2, 6, 18, 19, 20, 22, 24], "reaction": [1, 2, 6, 7, 11, 12, 13, 19, 20, 22], "gene": [1, 2, 9, 10, 13, 20, 22, 26], "relev": [1, 2, 3], "inform": [1, 2, 5, 6, 7, 14, 17, 19, 20, 21, 22, 23, 24, 26], "metabolit": [1, 2, 12, 13, 20, 22], "locu": [1, 22], "tag": [1, 7, 22], "reactant": 1, "product": [1, 22], "ec": [1, 7, 20, 22, 24], "number": [1, 7, 20, 22, 24, 27], "metanetx": [1, 6, 7, 20, 22, 24], "direct": [1, 7, 10, 22, 27], "spontan": 1, "compound": [1, 22], "object": [1, 2, 20, 22, 26], "chemic": 1, "formula": 1, "inchi": 1, "kei": 1, "chebi": 1, "gap_fill_fil": 1, "excel": [1, 2], "either": [1, 2, 7, 18, 20, 22, 24], "hand": 1, "same": [1, 5, 7, 22, 23, 26], "structur": [1, 6, 7, 20, 22, 24], "result": [1, 7, 10, 20, 22, 26], "exampl": 1, "data": [1, 6, 20, 22, 23, 24, 25], "modelname_gapfill_analysis_date_exampl": 1, "xlsx": 1, "add": [1, 3, 7, 13, 22, 26], "pathwai": [1, 6, 8, 11, 20, 22], "group": 1, "kegg_pathway_group": 1, "decid": [1, 22], "thi": [1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 16, 20, 21, 22, 23, 25, 26], "resolv": [1, 12, 22, 26], "duplic": [1, 12, 20, 22], "three": [1, 2, 7, 22], "follow": [1, 2, 5, 6, 7, 16, 17, 18, 20, 22, 24, 25], "entiti": [1, 12], "check": [1, 5, 7, 10, 12, 14, 20, 22, 24, 26], "simpli": 1, "report": [1, 2, 7, 20, 27], "them": [1, 3, 22], "remov": [1, 4, 10, 14, 20, 22], "skip": [1, 6, 8, 20, 22], "addit": [1, 2, 3, 5, 6, 7, 22, 25], "unus": [1, 12, 20, 22], "reduc": 1, "knowledg": [1, 5, 24, 25], "remove_unused_metab": 1, "bofdat": [1, 2, 18, 20, 22], "biomass": [1, 2, 22], "function": [1, 2, 3, 5, 7, 16, 17, 18, 19, 20, 22, 24], "bof": [1, 14], "run_bofdat": 1, "out": [1, 6, 8, 22, 24, 25], "param": 1, "bofdat_param": 1, "full_genome_sequ": 1, "whole": [1, 20], "sequenc": [1, 2, 7, 20, 22, 23], "dna_weight_fract": 1, "dna": [1, 2, 20, 22], "weight": [1, 2, 20, 22], "fraction": [1, 2, 20, 22], "weight_fract": 1, "ezym": 1, "ion": [1, 2, 20, 22], "page": [2, 3, 4, 7, 20], "how": [2, 7, 22], "complet": [2, 7, 12, 15, 20, 22, 23], "For": [2, 3, 7, 10, 18, 22, 24], "more": [2, 3, 6, 7, 15, 16, 17, 20, 22], "about": [2, 6, 7, 24, 25], "see": [2, 5, 7, 22, 27], "overview": [2, 7, 8, 9, 14, 17], "an": [2, 4, 5, 6, 7, 9, 18, 20, 22, 24, 25, 26], "alreadi": [2, 5, 22, 25], "connect": [2, 18, 22, 25], "ad": [2, 6, 7, 13, 16, 20, 22, 25], "futur": [2, 4, 11, 12, 16, 25, 26], "updat": [2, 4, 11, 12, 16, 22, 25, 26], "directli": [2, 4, 7, 20, 22], "command": [2, 5, 7, 18, 20, 27], "line": [2, 5, 7, 18, 20, 27], "its": [2, 7, 12, 22, 25], "call": [2, 7, 14, 20], "insid": [2, 7, 18, 20], "python": [2, 5, 7, 17, 18, 20], "script": [2, 7, 18, 22], "both": [2, 7, 9], "configur": [2, 5, 7, 16, 20, 21, 23, 24, 25], "file": [2, 3, 5, 7, 16, 18, 20, 21, 22, 23, 24, 26], "download": [2, 6, 7, 18, 20, 22, 24], "setup": [2, 6, 7, 27], "t": [2, 7, 20], "To": [2, 7, 16, 26, 27], "import": [2, 7, 18], "download_config": [2, 7, 24, 27], "filenam": [2, 7, 20, 22, 24], "my_basic_config": [2, 7, 24], "yaml": [2, 7, 23, 24], "type": [2, 3, 5, 7, 19, 20, 22, 24, 25], "open": [2, 7, 10], "editor": [2, 7], "chang": [2, 7, 16, 18, 20], "miss": [2, 7, 22], "entri": [2, 7, 20, 22], "when": [2, 7, 20, 22], "start": [2, 5, 7, 20, 22], "workflow": [2, 7, 9, 10, 17, 22, 26, 27], "config_fil": [2, 7, 23], "jupyt": [2, 7], "notebook": [2, 7], "being": [2, 7], "your": [2, 3, 5, 7, 20, 22, 25, 26], "two": [2, 7, 19, 22], "absolut": 2, "refinegem": [2, 3, 7, 10, 17, 19, 20, 22, 25], "": [2, 18, 20, 25, 26], "further": [2, 3, 7, 20, 22], "avail": [2, 3, 8, 12, 20, 22, 25], "total": 2, "draft": [2, 5, 13, 15, 20, 22, 25], "e": [2, 3, 7, 18, 20, 22, 24, 25, 26], "g": [2, 3, 7, 20, 22, 24, 25, 26], "refer": [2, 3, 7, 17, 22], "lab_strain": 2, "otherwis": [2, 18, 20, 22], "bullet": 2, "point": [2, 20, 22], "abov": [2, 7, 11, 20, 22, 24], "smart": [2, 7, 22], "tabl": [2, 7, 8, 19, 22, 24], "manual": [2, 6, 7, 22, 25], "curat": [2, 5, 8, 17, 22, 25], "sheet": 2, "potenti": [2, 6, 7, 22, 25], "enabl": [2, 20, 22], "adjust": [2, 7, 14, 22], "full": [2, 5, 7, 20, 22, 23], "sequenec": 2, "experiment": 2, "determin": [2, 22, 24], "retriev": [2, 22, 24], "literatur": 2, "research": 2, "enzmi": 2, "you": [3, 4, 7, 25], "find": [3, 12, 22], "branch": 3, "plan": 3, "new": [3, 6, 7, 10, 20, 22, 25], "featur": [3, 4, 20, 22], "extens": [3, 5, 13, 15, 20, 23, 24], "pleas": [3, 4, 22], "own": 3, "implic": 3, "other": [3, 4], "main": [3, 5], "version": [3, 7, 18, 20, 22], "successfulli": [3, 22], "klebsiella": [3, 6, 20, 22], "pneumonia": [3, 22], "oxytoca": 3, "sp": 3, "databas": [3, 5, 7, 10, 20, 22, 24, 25, 26], "templat": [3, 5, 6, 7, 9, 10, 17, 20, 22, 23, 24], "yet": [3, 4, 22], "differ": [3, 6, 7, 17, 20], "speci": [3, 5], "eukarya": 3, "work": [3, 10, 12, 22], "without": [3, 22, 26], "problem": [3, 4, 22, 26], "those": 3, "well": [3, 7, 22], "integr": [3, 5], "ongo": 3, "vice": 3, "versa": 3, "done": [3, 5, 7, 26], "cleanup": [3, 20, 23], "first": [3, 7, 9, 13, 20, 22, 26], "releas": 3, "pend": 3, "found": [3, 8, 9, 10, 16, 20, 22, 23, 25], "dev": 3, "folder": [3, 6, 7, 23, 24], "github": [3, 4, 17], "sphinx": 3, "ext": 3, "autodoc": 3, "A": [3, 7, 8, 9, 10, 16, 19, 22, 24], "mustach": 3, "format": [3, 7, 19, 22, 24, 26], "readi": [3, 7, 22], "vscode": 3, "restructur": 3, "text": 3, "includ": [3, 4, 8, 12, 17, 19, 20, 22], "furthermor": 3, "def": 3, "func": [3, 22], "num": 3, "int": [3, 22, 24], "squar": 3, "bool": [3, 22], "return": [3, 19, 22, 24], "x": [3, 6], "ani": [4, 26], "reagrd": 4, "have": [4, 5, 7, 10, 13, 22], "wish": [4, 25], "idea": [4, 9, 10, 17, 26], "write": [4, 24], "our": [4, 11], "contact": 4, "u": [4, 20], "warn": 4, "underscore_attrs_are_priv": 4, "caus": [4, 26], "howev": [4, 25], "core": [4, 6, 7, 8, 20, 23, 27], "what": [4, 7], "wa": [4, 10, 20, 22], "written": 4, "prokaryota": 4, "adapt": 4, "someth": 4, "we": 4, "hope": 4, "archiev": 4, "witha": 4, "than": 4, "while": [4, 7, 18], "toward": 4, "indep": 4, "advis": [4, 10, 18, 24], "stick": 4, "high": [5, 7, 9, 17, 23, 24], "qualiti": [5, 7, 17, 23, 24], "htqb": [5, 24], "interest": 5, "ideal": [5, 17], "veri": [5, 22, 25], "close": [5, 15], "relat": [5, 22], "aim": [5, 9, 11, 12, 13, 25], "upon": 5, "exist": [5, 20, 22, 24, 25], "speed": [5, 7], "up": [5, 7, 15, 22, 24], "minim": [5, 7, 22], "perform": [5, 6, 9, 12, 16, 20, 22, 25], "again": [5, 26], "similar": [5, 22, 25], "concept": 5, "imag": 5, "show": [5, 22], "overrview": 5, "consist": [5, 7, 17], "five": 5, "bidirect": [5, 20, 22], "blast": [5, 7, 10, 20, 22, 26], "refin": [5, 11, 12, 13, 14, 23, 26], "clean": [5, 15, 22], "smooth": [5, 15, 20, 23], "wrapper": [5, 7, 20, 21, 22], "allow": [5, 7, 17, 22], "sequenti": 5, "boudari": 5, "condit": [5, 10], "mani": 5, "fine": [5, 6], "tune": [5, 12], "turn": [5, 8], "off": [5, 8, 22], "separatli": [5, 17], "via": [5, 7, 16, 17, 20, 22, 24, 26], "content": [5, 8], "section": 5, "subject": [6, 22, 23], "full_sequ": 6, "specimen_run": 6, "specimen_model": 6, "program": [6, 7, 26], "assum": 6, "parent": [6, 22, 24], "rel": 6, "data_direc": 6, "diamond": [6, 7, 9, 18, 20, 22, 24, 26], "mnx_chem_prop": [6, 22], "chem_prop": [6, 20, 22], "tsv": [6, 22], "mnx_chem_xref": [6, 22], "chem_xref": [6, 20, 22], "mnx_reac_prop": [6, 22], "reac_prop": [6, 20, 22], "mnx_reac_xref": [6, 22], "reac_xref": [6, 20, 22], "good": 6, "ncbi_map": [6, 20, 22], "ncbi_dat": [6, 20, 22], "direction": [6, 12, 20], "control": 6, "pan": [6, 7, 8, 20, 22], "univers": [6, 7, 20, 22], "also": [6, 22], "too": 6, "small": 6, "none": [6, 19, 21, 22, 24], "paramt": 6, "singl": [6, 22], "bidirectional_blast": [6, 23], "suffic": 6, "special": 6, "template_nam": [6, 22], "input_nam": [6, 22], "temp_head": [6, 22], "in_head": [6, 22], "want": 6, "necessari": [6, 7, 20, 24], "sensit": [6, 20, 22], "generate_draft_model": [6, 23], "edit_nam": [6, 22], "pid": [6, 10, 20, 22], "80": [6, 20, 22], "0": [6, 18, 20, 22], "medium": [6, 7, 10, 20, 22], "refinement_extens": 6, "usual": 6, "alright": 6, "edit": [6, 20, 22, 24], "try": [6, 20, 22], "coverag": [6, 20, 22], "95": [6, 22], "90": [6, 20, 22], "almost": 6, "exclude_dna": [6, 22], "exclude_rna": [6, 22], "refinement_cleanup": 6, "standart": 6, "check_dupl_reac": [6, 20, 22], "check_dupl_meta": [6, 20, 22], "remove_unused_meta": [6, 20, 22], "remove_dupl_reac": [6, 20, 22], "remove_dupl_meta": [6, 20, 22], "mean": 6, "media_gap": 6, "refinement_annot": 6, "viaec": [6, 22], "viarc": [6, 22], "refinement_smooth": 6, "mcc": [6, 14, 18, 20, 22], "ecg": 6, "correct": [6, 7], "egc": [6, 14, 20, 22], "depend": [6, 22, 24, 25], "dna_weight_frac": [6, 20, 22], "023": [6, 20, 22], "ion_weight_frac": [6, 20, 22], "05": [6, 20, 22], "pc_based_on": [6, 22], "media_analysi": 6, "fit": [6, 10, 15, 20, 22], "test_aa_auxotrophi": [6, 22], "thread": [6, 20, 22, 24], "iter": [6, 20, 22], "chunk_siz": [6, 20, 22, 24], "heurist": [6, 20, 22], "faster": [6, 22], "instead": [6, 20], "onc": 6, "inter": 6, "n": [6, 20], "size": [6, 20, 24], "randomis": 6, "chunk": [6, 20, 22, 24], "3": [6, 18, 20, 22], "2000": 6, "basic": [7, 20, 24], "suitabl": 7, "beginn": 7, "advanc": [7, 20, 24], "help": [7, 17, 20], "util": [7, 27], "set_up": [7, 27], "As": [7, 11], "run_complet": [7, 23], "addition": [7, 17, 18, 22], "susequ": 7, "wrapper_pipelin": [7, 23], "parent_dir": [7, 23], "just": [7, 20], "project": 7, "do": [7, 22], "go": 7, "build_data_directori": [7, 24, 27], "your_folder_nam": 7, "extern": 7, "map": [7, 18, 20, 22, 24], "autom": [7, 17, 25], "semi": 7, "In": 7, "suppos": [7, 22], "regard": [7, 12], "support": 7, "gbff": [7, 20, 22, 24], "faa": [7, 22, 24], "fna": [7, 20, 22], "detail": 7, "subscript": 7, "one": [7, 10, 18, 22, 25], "wai": 7, "builf": 7, "ncbi": [7, 18, 20, 22, 24, 26], "create_diamond_db_from_fold": [7, 24, 27], "extent": [7, 19, 22], "create_ncbiinfo_map": [7, 24, 27], "csv": [7, 20, 22], "taken": 7, "previou": [7, 16, 22], "last": 7, "enter": [7, 21], "pure": 7, "lead": [7, 22], "better": [7, 22], "1": [7, 10, 17, 19, 20, 25, 26], "toolbox": [7, 17], "examplari": 7, "my_media_config": 7, "Or": 7, "flag": [7, 22, 26], "f": [7, 18, 20], "famk": [7, 17], "b": [7, 17], "\u00e4": [7, 17], "uerl": [7, 17], "gwendolyn": [7, 17], "o": [7, 9, 10, 17], "d": [7, 17, 20], "\u00f6": [7, 17], "bel": [7, 17], "laura": [7, 17], "camu": [7, 17], "simon": [7, 17], "heilbronn": [7, 17], "andrea": [7, 17], "dr": [7, 17], "ger": [7, 17], "scale": [7, 9, 10, 17, 22], "metabol": [7, 9, 10, 17, 22], "predict": [7, 17], "vitro": [7, 17], "characterist": [7, 17], "corynebacterium": [7, 17], "striatum": [7, 17], "frontier": [7, 17], "bioinformat": [7, 17], "2023": [7, 17], "fifth": 8, "final": [8, 14, 16], "graphic": [8, 10, 14, 19], "nice": 8, "displai": 8, "most": [8, 17], "exclud": [8, 20, 22], "silico": 8, "auxotrophi": [8, 20, 22], "certainti": 9, "describ": 9, "norsigian": [9, 10], "et": [9, 10, 20, 22], "al": [9, 10, 20, 22], "charl": [9, 10], "j": [9, 10], "xin": [9, 10], "fang": [9, 10], "yara": [9, 10], "seif": [9, 10], "jonathan": [9, 10], "m": [9, 10], "monk": [9, 10], "bernhard": [9, 10], "palsson": [9, 10], "multi": [9, 10], "prokaryot": [9, 10, 26], "natur": [9, 10], "protocol": [9, 10], "15": [9, 10], "14": [9, 10], "2020": [9, 10], "against": [10, 22], "represent": [10, 16], "filter": [10, 20, 22], "best": [10, 22], "hit": [10, 20, 22], "percentag": [10, 20, 22], "ident": [10, 20, 22], "threshold": [10, 20, 22], "homolog": [10, 22], "choos": [10, 20], "exchang": [10, 20, 22], "load": [10, 19, 22, 24], "renam": [10, 22], "unchang": 10, "essenti": 10, "third": [11, 12, 15, 22], "improv": 11, "seen": 11, "pictur": 11, "cover": 11, "sboterm": 11, "goal": 11, "extend": [11, 19, 20, 22, 25], "modul": [11, 27], "metacyc": [12, 20, 22], "present": [12, 22], "delet": [12, 22], "bio": 12, "cobrapi": [12, 16, 19, 22], "variant": 12, "still": [12, 22, 25, 26], "process": [12, 15], "stai": 12, "dure": [13, 24], "fourth": [14, 16, 22], "ajdust": 14, "numer": 14, "inlcud": 14, "mass": [14, 22], "charg": [14, 22], "masschargecur": [14, 18, 20], "previous": 15, "make": [15, 22], "split": 15, "four": 15, "acorrect": 16, "sbml": [16, 22], "implement": [16, 22, 25], "cobra": [16, 22], "io": 16, "validate_sbml_model": 16, "geaphic": 16, "packag": [17, 18, 27], "grow": [17, 20, 22], "collect": [17, 22, 24, 25], "gem": [17, 19, 22, 23], "These": 17, "mainli": [17, 24], "summari": 17, "come": 17, "soon": 17, "instal": [17, 20], "cmpb": [17, 24, 27], "hqtb": [17, 24, 27], "subpackag": [17, 21], "submodul": 17, "faq": 17, "known": [17, 26], "bug": 17, "issu": [17, 22, 26], "note": [17, 22, 24], "develop": [17, 20, 22, 24], "statu": 17, "document": 17, "repositori": 18, "here": 18, "pip": 18, "top": 18, "level": 18, "error": 18, "free": 18, "tool": [18, 25, 27], "4": [18, 20, 22, 26], "higher": 18, "entrezdirect": [18, 22], "beforehand": 18, "expect": 18, "solut": [18, 22], "objective_valu": 18, "coenzymes_and_ion": 18, "py": [18, 22], "rais": [18, 22, 23, 24], "afterward": 18, "It": 18, "conda": 18, "environ": [18, 20, 24], "10": 18, "handl": 19, "manipul": 19, "specimenmodelinforeport": [19, 27], "sourc": [19, 21, 22, 23, 24], "modelinforeport": 19, "child": 19, "attribut": 19, "__init__": 19, "__module__": 19, "format_t": 19, "datafram": [19, 22, 24], "functin": 19, "pd": [19, 22, 24], "str": [19, 21, 22, 23, 24], "color_palett": 19, "arg": [19, 20, 21, 22, 23, 24], "_description_": 19, "visualis": 19, "tupl": 19, "figur": [19, 26], "graph": 19, "creation": [19, 22, 24], "code": [20, 22], "successful": 20, "doenload": 20, "web": 20, "bdb": 20, "extract": [20, 22], "temp": 20, "header": [20, 22], "protein_id": [20, 22, 24], "sensitv": 20, "bpbbh": [20, 22], "percent": 20, "thei": [20, 22], "keyword": [20, 22], "contruct": 20, "5": [20, 22], "comparison": 20, "pcc": 20, "pcm": 20, "mp": 20, "aa": 20, "taa": 20, "cd": [20, 22], "db": [20, 22], "mnx": 20, "chem": 20, "prop": 20, "xref": 20, "reac": [20, 22], "recommend": [20, 22], "were": [20, 22], "blastp": [20, 22], "c": 20, "queri": [20, 22], "hist": [20, 22], "equal": [20, 22], "kept": [20, 22], "include_dna": 20, "include_rna": 20, "rna": [20, 22], "second": [20, 22], "biocyc_db": [20, 22], "cdr": 20, "cdm": 20, "exhaust": [20, 22], "over": [20, 25], "objective_funct": 20, "rdm": 20, "replac": 20, "rum": 20, "rdr": 20, "nsp": 20, "growth_threshold": [20, 22], "gt": 20, "consid": [20, 22], "pass": 20, "simultani": 20, "appli": [20, 22], "thrid": 20, "cannot": 20, "rc": 20, "solver": [20, 22], "string": 20, "solv": [20, 22], "extra": [20, 22], "deafult": 20, "macromolecular": 20, "liao": [20, 22], "coenzym": 20, "everyth": [21, 23, 24], "configpath": [21, 24], "union": [21, 22, 24], "prompt": 21, "kegg_reaction_to_kegg_pathwai": [22, 23], "search": [22, 23, 24, 26], "class": [22, 27], "unsucces": 22, "kegg_viaec": 22, "kegg_viarc": 22, "sbo": 22, "sboannot": 22, "check_direct": [22, 23], "data_fil": 22, "newli": [22, 26], "01": 22, "match": 22, "least": 22, "metabcyc": 22, "cobra_gapfill_wrapp": [22, 23], "liter": [22, 24], "float": 22, "10000": 22, "single_cobra_gapfil": [22, 23], "random": 22, "runtim": 22, "laptop": 22, "awar": 22, "doe": [22, 24], "combin": 22, "approach": 22, "he": 22, "time": [22, 23], "multiple_cobra_gapfil": [22, 23], "media_list": 22, "ofmedia": 22, "media_path": 22, "inconsist": 22, "todo": 22, "valueerror": [22, 23, 24], "unknown": [22, 24], "attempt": 22, "rate": 22, "add_gen": [22, 23], "row": 22, "seri": 22, "map_bigg_react": [22, 23], "add_react": [22, 23], "bigg_metabolit": 22, "helper": 22, "extent_model": [22, 23], "correspond": [22, 25], "extend_model": 22, "build_metabolite_kegg": [22, 23], "kegg_id": 22, "model_kegg_id": 22, "question": 22, "build_metabolite_mnx": [22, 23], "chem_prop_fil": 22, "chem_xref_fil": 22, "reac_prop_fil": 22, "reac_xref_fil": 22, "map_to_bigg": 22, "find_best_diamond_hit": [22, 23], "missing_gen": 22, "between": 22, "100": 22, "get_metabolites_kegg": [22, 23], "equat": 22, "dict": [22, 24], "entir": 22, "dictonari": 22, "stoichiometr": 22, "factor": 22, "get_metabolites_mnx": [22, 23], "get_ncbi_info": [22, 23], "ncbi_map_fil": 22, "precomput": 22, "rewrit": 22, "bioppython": 22, "must": 22, "ncbi_accession_vers": [22, 24], "identify_missing_gen": [22, 23], "gene_path": 22, "fasta_path": 22, "isreaction_complet": [22, 23], "reation": 22, "success": 22, "els": 22, "table_fil": 22, "map_to_kegg": [22, 23], "rewritten": 22, "auxilliari": 22, "map_bigg_reactions_row": [22, 23], "where": [22, 26], "exactli": 22, "rare": 22, "belong": 22, "enzym": 22, "omit": 22, "gene_t": 22, "working_dir": 22, "manual_dir": 22, "genome_summari": 22, "finalis": 22, "assign": 22, "place": [22, 23], "map_to_kegg_row": [22, 23], "loci_list": 22, "letter": 22, "map_to_ncbi_efetch_row": [22, 23], "gene_list": 22, "ultra": 22, "multitud": 22, "unad": 22, "egc_solv": 22, "greedi": 22, "energi": 22, "cycl": 22, "analys": 22, "model_path": 22, "pc_model_path": 22, "simul": 22, "compar": 22, "amino": 22, "acid": 22, "bdbp_diamond": [22, 23], "template_path": 22, "input_path": 22, "create_diamond_db": [22, 23], "extract_bestbdbp_hit": [22, 23], "tvq": 22, "qvt": 22, "cov": 22, "25": 22, "v": 22, "cut": 22, "extract_cd": [22, 23], "collect_info": 22, "genbank": [22, 24], "produc": 22, "ouput": 22, "extra_info": 22, "prokka": 22, "implememt": 22, "run_diamond_blastp": [22, 23], "reli": 22, "check_unchang": [22, 23], "bbh": 22, "correctli": 22, "col_nam": 22, "keep": 22, "edit_template_identifi": [22, 23], "dot": 22, "underscor": 22, "frame": 22, "un": 22, "gen_draft_model": [22, 23], "pid_filt": [22, 23], "remove_absent_gen": [22, 23], "copi": [22, 24], "befor": 22, "rename_found_homolog": [22, 23], "correnspondingli": 22, "count": 22, "absent": 22, "take": 22, "run_al": 22, "overwrit": 22, "subspack": 23, "funktion": 23, "test_config": 23, "unkown": 23, "subfold": 23, "empti": 23, "No": 23, "2048": 24, "respect": 24, "filepath": 24, "detect": 24, "download_mnx": [24, 27], "1024": 24, "memori": 24, "save_cmpb_user_input": [24, 27], "guid": 24, "throuh": 24, "commandlin": 24, "dictionari": 24, "validate_config": [24, 27], "userc": 24, "filenotfounderror": 24, "direc": 24, "read": 24, "nest": 24, "recurs": 24, "leav": 24, "get_info_genbank_record": [24, 27], "file_path": 24, "conta": 24, "db_xref": 24, "old_locus_tag": 24, "ec_numb": 24, "locus_tag_ref": 24, "geneid": 24, "differnt": 25, "heavili": 25, "subsequ": 25, "variou": 25, "littl": 25, "quickstart": 25, "plu": 25, "profit": 25, "carri": 25, "closer": 25, "therefor": 25, "some": 25, "mai": 25, "pgab": 25, "pgap": 26, "stage": 26, "geneproduct": 26, "fig": 26, "taxonomi": 26, "Then": 26, "nr": 26, "restrict": 26, "taxon": 26, "ye": 26, "rerun": 26, "NO": 26, "occur": 26, "individu": 26, "remain": 26, "ii": 26, "iii": 26, "seach": 27, "index": 27, "cmd_access": 27}, "objects": {"specimen.classes": [[19, 0, 0, "-", "reports"]], "specimen.classes.reports": [[19, 1, 1, "", "SpecimenModelInfoReport"]], "specimen.classes.reports.SpecimenModelInfoReport": [[19, 2, 1, "", "__init__"], [19, 3, 1, "", "__module__"], [19, 2, 1, "", "format_table"], [19, 2, 1, "", "save"], [19, 2, 1, "", "visualise"]], "specimen": [[20, 0, 0, "-", "cmd_access"]], "specimen.cmpb": [[21, 0, 0, "-", "workflow"]], "specimen.cmpb.workflow": [[21, 4, 1, "", "run"], [21, 4, 1, "", "wrapper"]], "specimen.hqtb.core": [[22, 0, 0, "-", "analysis"], [22, 0, 0, "-", "bidirectional_blast"], [22, 0, 0, "-", "generate_draft_model"], [22, 0, 0, "-", "validation"]], "specimen.hqtb.core.analysis": [[22, 4, 1, "", "run"]], "specimen.hqtb.core.bidirectional_blast": [[22, 4, 1, "", "bdbp_diamond"], [22, 4, 1, "", "create_diamond_db"], [22, 4, 1, "", "extract_bestbdbp_hits"], [22, 4, 1, "", "extract_cds"], [22, 4, 1, "", "run"], [22, 4, 1, "", "run_diamond_blastp"]], "specimen.hqtb.core.generate_draft_model": [[22, 4, 1, "", "check_unchanged"], [22, 4, 1, "", "edit_template_identifiers"], [22, 4, 1, "", "gen_draft_model"], [22, 4, 1, "", "pid_filter"], [22, 4, 1, "", "remove_absent_genes"], [22, 4, 1, "", "rename_found_homologs"], [22, 4, 1, "", "run"]], "specimen.hqtb.core.refinement": [[22, 0, 0, "-", "annotation"], [22, 0, 0, "-", "cleanup"], [22, 0, 0, "-", "extension"], [22, 0, 0, "-", "smoothing"]], "specimen.hqtb.core.refinement.annotation": [[22, 4, 1, "", "kegg_reaction_to_kegg_pathway"], [22, 4, 1, "", "run"]], "specimen.hqtb.core.refinement.cleanup": [[22, 4, 1, "", "check_direction"], [22, 4, 1, "", "cobra_gapfill_wrapper"], [22, 4, 1, "", "multiple_cobra_gapfill"], [22, 4, 1, "", "run"], [22, 4, 1, "", "single_cobra_gapfill"]], "specimen.hqtb.core.refinement.extension": [[22, 4, 1, "", "add_gene"], [22, 4, 1, "", "add_reaction"], [22, 4, 1, "", "build_metabolite_kegg"], [22, 4, 1, "", "build_metabolite_mnx"], [22, 4, 1, "", "extent_model"], [22, 4, 1, "", "find_best_diamond_hits"], [22, 4, 1, "", "get_metabolites_kegg"], [22, 4, 1, "", "get_metabolites_mnx"], [22, 4, 1, "", "get_ncbi_info"], [22, 4, 1, "", "identify_missing_genes"], [22, 4, 1, "", "isreaction_complete"], [22, 4, 1, "", "map_BiGG_reactions"], [22, 4, 1, "", "map_BiGG_reactions_row"], [22, 4, 1, "", "map_to_KEGG"], [22, 4, 1, "", "map_to_KEGG_row"], [22, 4, 1, "", "map_to_NCBI_efetch_row"], [22, 4, 1, "", "run"]], "specimen.hqtb.core.refinement.smoothing": [[22, 4, 1, "", "run"]], "specimen.hqtb.core.validation": [[22, 4, 1, "", "run"]], "specimen.hqtb": [[23, 0, 0, "-", "workflow"]], "specimen.hqtb.workflow": [[23, 4, 1, "", "run_complete"], [23, 4, 1, "", "wrapper_pipeline"]], "specimen.util": [[24, 0, 0, "-", "set_up"], [24, 0, 0, "-", "util"]], "specimen.util.set_up": [[24, 4, 1, "", "build_data_directories"], [24, 4, 1, "", "download_config"], [24, 4, 1, "", "download_mnx"], [24, 4, 1, "", "save_cmpb_user_input"], [24, 4, 1, "", "validate_config"]], "specimen.util.util": [[24, 4, 1, "", "create_DIAMOND_db_from_folder"], [24, 4, 1, "", "create_NCBIinfo_mapping"], [24, 4, 1, "", "get_info_GenBank_Record"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "function", "Python function"]}, "titleterms": {"about": [0, 5], "cmpb": [0, 1, 2, 21, 25], "overview": [0, 5, 25], "pipelin": [0, 2, 5, 7, 17, 25], "configur": [1, 6], "file": [1, 6], "run": [2, 7, 20], "quickstart": [2, 7], "collect": [2, 7], "data": [2, 7], "note": 3, "develop": 3, "current": 3, "statu": 3, "inform": [3, 25], "document": 3, "help": 4, "faq": 4, "known": 4, "bug": 4, "issu": 4, "pydant": 4, "which": 4, "organ": 4, "work": 4, "specimen": [4, 17, 19, 20, 21, 22, 23, 24, 27], "namespac": 4, "can": 4, "i": 4, "us": 4, "hqtb": [5, 6, 7, 22, 23, 25], "htqb": 7, "step": [8, 9, 10, 11, 12, 13, 14, 15, 16], "5": 8, "analys": 8, "model": [8, 10, 11, 12, 13, 15, 16, 26], "1": [9, 13], "bidirect": 9, "blast": 9, "2": [10, 12], "gener": [10, 20], "draft": [10, 26], "3": [11, 12, 13, 14, 15], "part": [11, 12, 13, 14], "further": [11, 15, 25], "annot": [11, 22], "clean": 12, "extend": 13, "4": [14, 16], "smooth": [14, 22], "refin": [15, 20, 22], "valid": [16, 22], "welcom": 17, "avail": 17, "how": 17, "cite": 17, "content": [17, 27], "instal": 18, "via": 18, "github": 18, "class": 19, "packag": [19, 21, 22, 23, 24], "report": 19, "submodul": [19, 20, 21, 22, 23, 24, 27], "The": 20, "cmd_access": 20, "option": 20, "setup": 20, "workflow": [21, 23], "core": 22, "subpackag": [22, 23, 27], "cleanup": 22, "extens": 22, "analysi": 22, "bidirectional_blast": 22, "generate_draft_model": 22, "util": 24, "set_up": 24, "modul": 24, "carvem": 25, "modelpolish": 25, "base": 25, "high": 25, "qualiti": 25, "templat": 25, "more": 25, "idea": 25, "pgab": 26, "from": 26, "genom": 26, "sequenc": 26}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "nbsphinx": 4, "sphinxcontrib.bibtex": 9, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"About CMPB": [[0, "about-cmpb"]], "Overview of the CMPB Pipeline": [[0, "overview-of-the-cmpb-pipeline"]], "CMPB Configuration File": [[1, "cmpb-configuration-file"]], "Run the CMPB Pipeline": [[2, "run-the-cmpb-pipeline"]], "CMPB: Quickstart": [[2, "cmpb-quickstart"]], "CMPB: Collecting Data": [[2, "cmpb-collecting-data"]], "Notes for Developers": [[3, "notes-for-developers"]], "Current Status": [[3, "current-status"]], "Developer Information": [[3, "developer-information"]], "Documentation Notes": [[3, "documentation-notes"]], "Help & FAQ": [[4, "help-faq"]], "Known Bugs and Issues": [[4, "known-bugs-and-issues"]], "Pydantic": [[4, "pydantic"]], "FAQs": [[4, "faqs"]], "Which organisms work with SPECIMEN?": [[4, "which-organisms-work-with-specimen"]], "Which namespaces can I use?": [[4, "which-namespaces-can-i-use"]], "About HQTB": [[5, "about-hqtb"]], "Overview of the HQTB Pipeline": [[5, "overview-of-the-hqtb-pipeline"]], "HQTB Configuration File": [[6, "hqtb-configuration-file"]], "Run the HTQB Pipeline": [[7, "run-the-htqb-pipeline"]], "HQTB: Quickstart": [[7, "hqtb-quickstart"]], "HQTB: Collecting Data": [[7, "hqtb-collecting-data"]], "Step 5: Analyse the Model": [[8, "step-5-analyse-the-model"]], "Step 1: Bidirectional BLAST": [[9, "step-1-bidirectional-blast"]], "Step 2: Generate a Draft Model": [[10, "step-2-generate-a-draft-model"]], "Step 3, Part 3: Further Annotate the Model": [[11, "step-3-part-3-further-annotate-the-model"]], "Step 3, Part 2: Cleaning the Model": [[12, "step-3-part-2-cleaning-the-model"]], "Step 3, Part 1: Extending the Model": [[13, "step-3-part-1-extending-the-model"]], "Step 3, Part 4: Smoothing": [[14, "step-3-part-4-smoothing"]], "Step 3: Further Refine the Model": [[15, "step-3-further-refine-the-model"]], "Step 4: Model Validation": [[16, "step-4-model-validation"]], "Welcome to SPECIMEN!": [[17, "welcome-to-specimen"]], "Available Pipelines": [[17, "available-pipelines"]], "How to Cite": [[17, "how-to-cite"]], "Content": [[17, null]], "Installation": [[18, "installation"]], "Installation via github": [[18, "installation-via-github"]], "specimen.classes package": [[19, "specimen-classes-package"]], "specimen.classes.reports submodule": [[19, "module-specimen.classes.reports"]], "The specimen.cmd_access submodule": [[20, "module-specimen.cmd_access"]], "General Options": [[20, "general-options"]], "specimen setup": [[20, "specimen-setup"]], "specimen run": [[20, "specimen-run"]], "specimen run refinement": [[20, "specimen-run-refinement"]], "specimen.cmpb package": [[21, "specimen-cmpb-package"]], "specimen.cmpb submodules": [[21, "specimen-cmpb-submodules"]], "specimen.cmpb.workflow": [[21, "module-specimen.cmpb.workflow"]], "specimen.hqtb.core package": [[22, "specimen-hqtb-core-package"]], "specimen.hqtb.core.refinement subpackage": [[22, "specimen-hqtb-core-refinement-subpackage"]], "specimen.hqtb.core.refinement.annotation submodule": [[22, "module-specimen.hqtb.core.refinement.annotation"]], "specimen.hqtb.core.refinement.cleanup submodule": [[22, "module-specimen.hqtb.core.refinement.cleanup"]], "specimen.hqtb.core.refinement.extension submodule": [[22, "module-specimen.hqtb.core.refinement.extension"]], "specimen.hqtb.core.refinement.smoothing submodule": [[22, "module-specimen.hqtb.core.refinement.smoothing"]], "specimen.hqtb.core submodules": [[22, "specimen-hqtb-core-submodules"]], "specimen.hqtb.core.analysis": [[22, "module-specimen.hqtb.core.analysis"]], "specimen.hqtb.core.bidirectional_blast": [[22, "module-specimen.hqtb.core.bidirectional_blast"]], "specimen.hqtb.core.generate_draft_model": [[22, "module-specimen.hqtb.core.generate_draft_model"]], "specimen.hqtb.core.validation": [[22, "module-specimen.hqtb.core.validation"]], "specimen.hqtb package": [[23, "specimen-hqtb-package"]], "specimen.hqtb subpackages": [[23, "specimen-hqtb-subpackages"]], "specimen.hqtb submodules": [[23, "specimen-hqtb-submodules"]], "specimen.hqtb.workflow": [[23, "module-specimen.hqtb.workflow"]], "specimen.util package": [[24, "specimen-util-package"]], "specimen.util submodules": [[24, "specimen-util-submodules"]], "specimen.util.set_up module": [[24, "module-specimen.util.set_up"]], "specimen.util.util module": [[24, "module-specimen.util.util"]], "Overview of the Pipelines": [[25, "overview-of-the-pipelines"]], "CarveMe + ModelPolisher based (CMPB) pipeline": [[25, "carveme-modelpolisher-based-cmpb-pipeline"]], "Further Information": [[25, null], [25, null]], "High-quality template based (HQTB) pipeline": [[25, "high-quality-template-based-hqtb-pipeline"]], "More ideas for pipelines": [[25, "more-ideas-for-pipelines"]], "PGAB: From genome sequence to draft model": [[26, "pgab-from-genome-sequence-to-draft-model"]], "Contents of SPECIMEN": [[27, "contents-of-specimen"]], "specimen subpackages": [[27, "specimen-subpackages"]], "specimen submodules": [[27, "specimen-submodules"]]}, "indexentries": {"specimenmodelinforeport (class in specimen.classes.reports)": [[19, "specimen.classes.reports.SpecimenModelInfoReport"]], "__init__() (specimen.classes.reports.specimenmodelinforeport method)": [[19, "specimen.classes.reports.SpecimenModelInfoReport.__init__"]], "__module__ (specimen.classes.reports.specimenmodelinforeport attribute)": [[19, "specimen.classes.reports.SpecimenModelInfoReport.__module__"]], "format_table() (specimen.classes.reports.specimenmodelinforeport method)": [[19, "specimen.classes.reports.SpecimenModelInfoReport.format_table"]], "module": [[19, "module-specimen.classes.reports"], [20, "module-specimen.cmd_access"], [21, "module-specimen.cmpb.workflow"], [22, "module-specimen.hqtb.core.analysis"], [22, "module-specimen.hqtb.core.bidirectional_blast"], [22, "module-specimen.hqtb.core.generate_draft_model"], [22, "module-specimen.hqtb.core.refinement.annotation"], [22, "module-specimen.hqtb.core.refinement.cleanup"], [22, "module-specimen.hqtb.core.refinement.extension"], [22, "module-specimen.hqtb.core.refinement.smoothing"], [22, "module-specimen.hqtb.core.validation"], [23, "module-specimen.hqtb.workflow"], [24, "module-specimen.util.set_up"], [24, "module-specimen.util.util"]], "save() (specimen.classes.reports.specimenmodelinforeport method)": [[19, "specimen.classes.reports.SpecimenModelInfoReport.save"]], "specimen.classes.reports": [[19, "module-specimen.classes.reports"]], "visualise() (specimen.classes.reports.specimenmodelinforeport method)": [[19, "specimen.classes.reports.SpecimenModelInfoReport.visualise"]], "specimen.cmd_access": [[20, "module-specimen.cmd_access"]], "run() (in module specimen.cmpb.workflow)": [[21, "specimen.cmpb.workflow.run"]], "specimen.cmpb.workflow": [[21, "module-specimen.cmpb.workflow"]], "wrapper() (in module specimen.cmpb.workflow)": [[21, "specimen.cmpb.workflow.wrapper"]], "add_gene() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.add_gene"]], "add_reaction() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.add_reaction"]], "bdbp_diamond() (in module specimen.hqtb.core.bidirectional_blast)": [[22, "specimen.hqtb.core.bidirectional_blast.bdbp_diamond"]], "build_metabolite_kegg() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.build_metabolite_kegg"]], "build_metabolite_mnx() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.build_metabolite_mnx"]], "check_direction() (in module specimen.hqtb.core.refinement.cleanup)": [[22, "specimen.hqtb.core.refinement.cleanup.check_direction"]], "check_unchanged() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.check_unchanged"]], "cobra_gapfill_wrapper() (in module specimen.hqtb.core.refinement.cleanup)": [[22, "specimen.hqtb.core.refinement.cleanup.cobra_gapfill_wrapper"]], "create_diamond_db() (in module specimen.hqtb.core.bidirectional_blast)": [[22, "specimen.hqtb.core.bidirectional_blast.create_diamond_db"]], "edit_template_identifiers() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.edit_template_identifiers"]], "extent_model() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.extent_model"]], "extract_bestbdbp_hits() (in module specimen.hqtb.core.bidirectional_blast)": [[22, "specimen.hqtb.core.bidirectional_blast.extract_bestbdbp_hits"]], "extract_cds() (in module specimen.hqtb.core.bidirectional_blast)": [[22, "specimen.hqtb.core.bidirectional_blast.extract_cds"]], "find_best_diamond_hits() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.find_best_diamond_hits"]], "gen_draft_model() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.gen_draft_model"]], "get_metabolites_kegg() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.get_metabolites_kegg"]], "get_metabolites_mnx() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.get_metabolites_mnx"]], "get_ncbi_info() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.get_ncbi_info"]], "identify_missing_genes() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.identify_missing_genes"]], "isreaction_complete() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.isreaction_complete"]], "kegg_reaction_to_kegg_pathway() (in module specimen.hqtb.core.refinement.annotation)": [[22, "specimen.hqtb.core.refinement.annotation.kegg_reaction_to_kegg_pathway"]], "map_bigg_reactions() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.map_BiGG_reactions"]], "map_bigg_reactions_row() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.map_BiGG_reactions_row"]], "map_to_kegg() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.map_to_KEGG"]], "map_to_kegg_row() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.map_to_KEGG_row"]], "map_to_ncbi_efetch_row() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.map_to_NCBI_efetch_row"]], "multiple_cobra_gapfill() (in module specimen.hqtb.core.refinement.cleanup)": [[22, "specimen.hqtb.core.refinement.cleanup.multiple_cobra_gapfill"]], "pid_filter() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.pid_filter"]], "remove_absent_genes() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.remove_absent_genes"]], "rename_found_homologs() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.rename_found_homologs"]], "run() (in module specimen.hqtb.core.analysis)": [[22, "specimen.hqtb.core.analysis.run"]], "run() (in module specimen.hqtb.core.bidirectional_blast)": [[22, "specimen.hqtb.core.bidirectional_blast.run"]], "run() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.run"]], "run() (in module specimen.hqtb.core.refinement.annotation)": [[22, "specimen.hqtb.core.refinement.annotation.run"]], "run() (in module specimen.hqtb.core.refinement.cleanup)": [[22, "specimen.hqtb.core.refinement.cleanup.run"]], "run() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.run"]], "run() (in module specimen.hqtb.core.refinement.smoothing)": [[22, "specimen.hqtb.core.refinement.smoothing.run"]], "run() (in module specimen.hqtb.core.validation)": [[22, "specimen.hqtb.core.validation.run"]], "run_diamond_blastp() (in module specimen.hqtb.core.bidirectional_blast)": [[22, "specimen.hqtb.core.bidirectional_blast.run_diamond_blastp"]], "single_cobra_gapfill() (in module specimen.hqtb.core.refinement.cleanup)": [[22, "specimen.hqtb.core.refinement.cleanup.single_cobra_gapfill"]], "specimen.hqtb.core.analysis": [[22, "module-specimen.hqtb.core.analysis"]], "specimen.hqtb.core.bidirectional_blast": [[22, "module-specimen.hqtb.core.bidirectional_blast"]], "specimen.hqtb.core.generate_draft_model": [[22, "module-specimen.hqtb.core.generate_draft_model"]], "specimen.hqtb.core.refinement.annotation": [[22, "module-specimen.hqtb.core.refinement.annotation"]], "specimen.hqtb.core.refinement.cleanup": [[22, "module-specimen.hqtb.core.refinement.cleanup"]], "specimen.hqtb.core.refinement.extension": [[22, "module-specimen.hqtb.core.refinement.extension"]], "specimen.hqtb.core.refinement.smoothing": [[22, "module-specimen.hqtb.core.refinement.smoothing"]], "specimen.hqtb.core.validation": [[22, "module-specimen.hqtb.core.validation"]], "run_complete() (in module specimen.hqtb.workflow)": [[23, "specimen.hqtb.workflow.run_complete"]], "specimen.hqtb.workflow": [[23, "module-specimen.hqtb.workflow"]], "wrapper_pipeline() (in module specimen.hqtb.workflow)": [[23, "specimen.hqtb.workflow.wrapper_pipeline"]], "build_data_directories() (in module specimen.util.set_up)": [[24, "specimen.util.set_up.build_data_directories"]], "create_diamond_db_from_folder() (in module specimen.util.util)": [[24, "specimen.util.util.create_DIAMOND_db_from_folder"]], "create_ncbiinfo_mapping() (in module specimen.util.util)": [[24, "specimen.util.util.create_NCBIinfo_mapping"]], "download_config() (in module specimen.util.set_up)": [[24, "specimen.util.set_up.download_config"]], "download_mnx() (in module specimen.util.set_up)": [[24, "specimen.util.set_up.download_mnx"]], "get_info_genbank_record() (in module specimen.util.util)": [[24, "specimen.util.util.get_info_GenBank_Record"]], "save_cmpb_user_input() (in module specimen.util.set_up)": [[24, "specimen.util.set_up.save_cmpb_user_input"]], "specimen.util.set_up": [[24, "module-specimen.util.set_up"]], "specimen.util.util": [[24, "module-specimen.util.util"]], "validate_config() (in module specimen.util.set_up)": [[24, "specimen.util.set_up.validate_config"]]}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"About CMPB": [[0, "about-cmpb"]], "About HQTB": [[5, "about-hqtb"]], "Available Pipelines": [[17, "available-pipelines"]], "CMPB Configuration File": [[1, "cmpb-configuration-file"]], "CMPB: Collecting Data": [[2, "cmpb-collecting-data"]], "CMPB: Quickstart": [[2, "cmpb-quickstart"]], "CarveMe + ModelPolisher based (CMPB) pipeline": [[25, "carveme-modelpolisher-based-cmpb-pipeline"]], "Content": [[17, null]], "Contents of SPECIMEN": [[27, "contents-of-specimen"]], "Current Status": [[3, "current-status"]], "Developer Information": [[3, "developer-information"]], "Documentation Notes": [[3, "documentation-notes"]], "FAQs": [[4, "faqs"]], "Further Information": [[25, null], [25, null]], "General Options": [[20, "general-options"]], "HQTB Configuration File": [[6, "hqtb-configuration-file"]], "HQTB: Collecting Data": [[7, "hqtb-collecting-data"]], "HQTB: Quickstart": [[7, "hqtb-quickstart"]], "Help & FAQ": [[4, "help-faq"]], "High-quality template based (HQTB) pipeline": [[25, "high-quality-template-based-hqtb-pipeline"]], "How to Cite": [[17, "how-to-cite"]], "Installation": [[18, "installation"]], "Installation via github": [[18, "installation-via-github"]], "Known Bugs and Issues": [[4, "known-bugs-and-issues"]], "More ideas for pipelines": [[25, "more-ideas-for-pipelines"]], "Notes for Developers": [[3, "notes-for-developers"]], "Overview of the CMPB Pipeline": [[0, "overview-of-the-cmpb-pipeline"]], "Overview of the HQTB Pipeline": [[5, "overview-of-the-hqtb-pipeline"]], "Overview of the Pipelines": [[25, "overview-of-the-pipelines"]], "PGAB: From genome sequence to draft model": [[26, "pgab-from-genome-sequence-to-draft-model"]], "Pydantic": [[4, "pydantic"]], "Run the CMPB Pipeline": [[2, "run-the-cmpb-pipeline"]], "Run the HTQB Pipeline": [[7, "run-the-htqb-pipeline"]], "Step 1: Bidirectional BLAST": [[9, "step-1-bidirectional-blast"]], "Step 2: Generate a Draft Model": [[10, "step-2-generate-a-draft-model"]], "Step 3, Part 1: Extending the Model": [[13, "step-3-part-1-extending-the-model"]], "Step 3, Part 2: Cleaning the Model": [[12, "step-3-part-2-cleaning-the-model"]], "Step 3, Part 3: Further Annotate the Model": [[11, "step-3-part-3-further-annotate-the-model"]], "Step 3, Part 4: Smoothing": [[14, "step-3-part-4-smoothing"]], "Step 3: Further Refine the Model": [[15, "step-3-further-refine-the-model"]], "Step 4: Model Validation": [[16, "step-4-model-validation"]], "Step 5: Analyse the Model": [[8, "step-5-analyse-the-model"]], "The specimen.cmd_access submodule": [[20, "module-specimen.cmd_access"]], "Welcome to SPECIMEN!": [[17, "welcome-to-specimen"]], "Which namespaces can I use?": [[4, "which-namespaces-can-i-use"]], "Which organisms work with SPECIMEN?": [[4, "which-organisms-work-with-specimen"]], "specimen run": [[20, "specimen-run"]], "specimen run refinement": [[20, "specimen-run-refinement"]], "specimen setup": [[20, "specimen-setup"]], "specimen submodules": [[27, "specimen-submodules"]], "specimen subpackages": [[27, "specimen-subpackages"]], "specimen.classes package": [[19, "specimen-classes-package"]], "specimen.classes.reports submodule": [[19, "module-specimen.classes.reports"]], "specimen.cmpb package": [[21, "specimen-cmpb-package"]], "specimen.cmpb submodules": [[21, "specimen-cmpb-submodules"]], "specimen.cmpb.workflow": [[21, "module-specimen.cmpb.workflow"]], "specimen.hqtb package": [[23, "specimen-hqtb-package"]], "specimen.hqtb submodules": [[23, "specimen-hqtb-submodules"]], "specimen.hqtb subpackages": [[23, "specimen-hqtb-subpackages"]], "specimen.hqtb.core package": [[22, "specimen-hqtb-core-package"]], "specimen.hqtb.core submodules": [[22, "specimen-hqtb-core-submodules"]], "specimen.hqtb.core.analysis": [[22, "module-specimen.hqtb.core.analysis"]], "specimen.hqtb.core.bidirectional_blast": [[22, "module-specimen.hqtb.core.bidirectional_blast"]], "specimen.hqtb.core.generate_draft_model": [[22, "module-specimen.hqtb.core.generate_draft_model"]], "specimen.hqtb.core.refinement subpackage": [[22, "specimen-hqtb-core-refinement-subpackage"]], "specimen.hqtb.core.refinement.annotation submodule": [[22, "module-specimen.hqtb.core.refinement.annotation"]], "specimen.hqtb.core.refinement.cleanup submodule": [[22, "module-specimen.hqtb.core.refinement.cleanup"]], "specimen.hqtb.core.refinement.extension submodule": [[22, "module-specimen.hqtb.core.refinement.extension"]], "specimen.hqtb.core.refinement.smoothing submodule": [[22, "module-specimen.hqtb.core.refinement.smoothing"]], "specimen.hqtb.core.validation": [[22, "module-specimen.hqtb.core.validation"]], "specimen.hqtb.workflow": [[23, "module-specimen.hqtb.workflow"]], "specimen.util package": [[24, "specimen-util-package"]], "specimen.util submodules": [[24, "specimen-util-submodules"]], "specimen.util.set_up module": [[24, "module-specimen.util.set_up"]], "specimen.util.util module": [[24, "module-specimen.util.util"]]}, "docnames": ["cmpb/about-pipeline", "cmpb/cmpb-config", "cmpb/run-pipeline", "dev-notes", "help", "hqtb/about-pipeline", "hqtb/hqtb-config", "hqtb/run-pipeline", "hqtb/step-desc/analysis", "hqtb/step-desc/bidirect_blast", "hqtb/step-desc/gen_draft", "hqtb/step-desc/refine-parts/annot", "hqtb/step-desc/refine-parts/cleanup", "hqtb/step-desc/refine-parts/extension", "hqtb/step-desc/refine-parts/smooth", "hqtb/step-desc/refinement", "hqtb/step-desc/validation", "index", "installation", "modules/classes", "modules/cmd", "modules/cmpb", "modules/core", "modules/hqtb", "modules/util", "overview-pipes", "pipeline_idea", "specimen"], "envversion": {"nbsphinx": 4, "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.viewcode": 1, "sphinxcontrib.bibtex": 9}, "filenames": ["cmpb/about-pipeline.rst", "cmpb/cmpb-config.rst", "cmpb/run-pipeline.rst", "dev-notes.rst", "help.rst", "hqtb/about-pipeline.rst", "hqtb/hqtb-config.rst", "hqtb/run-pipeline.rst", "hqtb/step-desc/analysis.rst", "hqtb/step-desc/bidirect_blast.rst", "hqtb/step-desc/gen_draft.rst", "hqtb/step-desc/refine-parts/annot.rst", "hqtb/step-desc/refine-parts/cleanup.rst", "hqtb/step-desc/refine-parts/extension.rst", "hqtb/step-desc/refine-parts/smooth.rst", "hqtb/step-desc/refinement.rst", "hqtb/step-desc/validation.rst", "index.rst", "installation.rst", "modules/classes.rst", "modules/cmd.rst", "modules/cmpb.rst", "modules/core.rst", "modules/hqtb.rst", "modules/util.rst", "overview-pipes.rst", "pipeline_idea.rst", "specimen.rst"], "indexentries": {"__init__() (specimen.classes.reports.specimenmodelinforeport method)": [[19, "specimen.classes.reports.SpecimenModelInfoReport.__init__", false]], "__module__ (specimen.classes.reports.specimenmodelinforeport attribute)": [[19, "specimen.classes.reports.SpecimenModelInfoReport.__module__", false]], "add_gene() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.add_gene", false]], "add_reaction() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.add_reaction", false]], "bdbp_diamond() (in module specimen.hqtb.core.bidirectional_blast)": [[22, "specimen.hqtb.core.bidirectional_blast.bdbp_diamond", false]], "build_data_directories() (in module specimen.util.set_up)": [[24, "specimen.util.set_up.build_data_directories", false]], "build_metabolite_kegg() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.build_metabolite_kegg", false]], "build_metabolite_mnx() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.build_metabolite_mnx", false]], "check_direction() (in module specimen.hqtb.core.refinement.cleanup)": [[22, "specimen.hqtb.core.refinement.cleanup.check_direction", false]], "check_unchanged() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.check_unchanged", false]], "cobra_gapfill_wrapper() (in module specimen.hqtb.core.refinement.cleanup)": [[22, "specimen.hqtb.core.refinement.cleanup.cobra_gapfill_wrapper", false]], "create_diamond_db() (in module specimen.hqtb.core.bidirectional_blast)": [[22, "specimen.hqtb.core.bidirectional_blast.create_diamond_db", false]], "create_diamond_db_from_folder() (in module specimen.util.util)": [[24, "specimen.util.util.create_DIAMOND_db_from_folder", false]], "create_ncbiinfo_mapping() (in module specimen.util.util)": [[24, "specimen.util.util.create_NCBIinfo_mapping", false]], "download_config() (in module specimen.util.set_up)": [[24, "specimen.util.set_up.download_config", false]], "download_mnx() (in module specimen.util.set_up)": [[24, "specimen.util.set_up.download_mnx", false]], "edit_template_identifiers() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.edit_template_identifiers", false]], "extent_model() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.extent_model", false]], "extract_bestbdbp_hits() (in module specimen.hqtb.core.bidirectional_blast)": [[22, "specimen.hqtb.core.bidirectional_blast.extract_bestbdbp_hits", false]], "extract_cds() (in module specimen.hqtb.core.bidirectional_blast)": [[22, "specimen.hqtb.core.bidirectional_blast.extract_cds", false]], "find_best_diamond_hits() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.find_best_diamond_hits", false]], "format_table() (specimen.classes.reports.specimenmodelinforeport method)": [[19, "specimen.classes.reports.SpecimenModelInfoReport.format_table", false]], "gen_draft_model() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.gen_draft_model", false]], "get_info_genbank_record() (in module specimen.util.util)": [[24, "specimen.util.util.get_info_GenBank_Record", false]], "get_metabolites_kegg() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.get_metabolites_kegg", false]], "get_metabolites_mnx() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.get_metabolites_mnx", false]], "get_ncbi_info() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.get_ncbi_info", false]], "identify_missing_genes() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.identify_missing_genes", false]], "isreaction_complete() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.isreaction_complete", false]], "kegg_reaction_to_kegg_pathway() (in module specimen.hqtb.core.refinement.annotation)": [[22, "specimen.hqtb.core.refinement.annotation.kegg_reaction_to_kegg_pathway", false]], "map_bigg_reactions() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.map_BiGG_reactions", false]], "map_bigg_reactions_row() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.map_BiGG_reactions_row", false]], "map_to_kegg() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.map_to_KEGG", false]], "map_to_kegg_row() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.map_to_KEGG_row", false]], "map_to_ncbi_efetch_row() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.map_to_NCBI_efetch_row", false]], "module": [[19, "module-specimen.classes.reports", false], [20, "module-specimen.cmd_access", false], [21, "module-specimen.cmpb.workflow", false], [22, "module-specimen.hqtb.core.analysis", false], [22, "module-specimen.hqtb.core.bidirectional_blast", false], [22, "module-specimen.hqtb.core.generate_draft_model", false], [22, "module-specimen.hqtb.core.refinement.annotation", false], [22, "module-specimen.hqtb.core.refinement.cleanup", false], [22, "module-specimen.hqtb.core.refinement.extension", false], [22, "module-specimen.hqtb.core.refinement.smoothing", false], [22, "module-specimen.hqtb.core.validation", false], [23, "module-specimen.hqtb.workflow", false], [24, "module-specimen.util.set_up", false], [24, "module-specimen.util.util", false]], "multiple_cobra_gapfill() (in module specimen.hqtb.core.refinement.cleanup)": [[22, "specimen.hqtb.core.refinement.cleanup.multiple_cobra_gapfill", false]], "pid_filter() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.pid_filter", false]], "remove_absent_genes() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.remove_absent_genes", false]], "rename_found_homologs() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.rename_found_homologs", false]], "run() (in module specimen.cmpb.workflow)": [[21, "specimen.cmpb.workflow.run", false]], "run() (in module specimen.hqtb.core.analysis)": [[22, "specimen.hqtb.core.analysis.run", false]], "run() (in module specimen.hqtb.core.bidirectional_blast)": [[22, "specimen.hqtb.core.bidirectional_blast.run", false]], "run() (in module specimen.hqtb.core.generate_draft_model)": [[22, "specimen.hqtb.core.generate_draft_model.run", false]], "run() (in module specimen.hqtb.core.refinement.annotation)": [[22, "specimen.hqtb.core.refinement.annotation.run", false]], "run() (in module specimen.hqtb.core.refinement.cleanup)": [[22, "specimen.hqtb.core.refinement.cleanup.run", false]], "run() (in module specimen.hqtb.core.refinement.extension)": [[22, "specimen.hqtb.core.refinement.extension.run", false]], "run() (in module specimen.hqtb.core.refinement.smoothing)": [[22, "specimen.hqtb.core.refinement.smoothing.run", false]], "run() (in module specimen.hqtb.core.validation)": [[22, "specimen.hqtb.core.validation.run", false]], "run_complete() (in module specimen.hqtb.workflow)": [[23, "specimen.hqtb.workflow.run_complete", false]], "run_diamond_blastp() (in module specimen.hqtb.core.bidirectional_blast)": [[22, "specimen.hqtb.core.bidirectional_blast.run_diamond_blastp", false]], "save() (specimen.classes.reports.specimenmodelinforeport method)": [[19, "specimen.classes.reports.SpecimenModelInfoReport.save", false]], "save_cmpb_user_input() (in module specimen.util.set_up)": [[24, "specimen.util.set_up.save_cmpb_user_input", false]], "single_cobra_gapfill() (in module specimen.hqtb.core.refinement.cleanup)": [[22, "specimen.hqtb.core.refinement.cleanup.single_cobra_gapfill", false]], "specimen.classes.reports": [[19, "module-specimen.classes.reports", false]], "specimen.cmd_access": [[20, "module-specimen.cmd_access", false]], "specimen.cmpb.workflow": [[21, "module-specimen.cmpb.workflow", false]], "specimen.hqtb.core.analysis": [[22, "module-specimen.hqtb.core.analysis", false]], "specimen.hqtb.core.bidirectional_blast": [[22, "module-specimen.hqtb.core.bidirectional_blast", false]], "specimen.hqtb.core.generate_draft_model": [[22, "module-specimen.hqtb.core.generate_draft_model", false]], "specimen.hqtb.core.refinement.annotation": [[22, "module-specimen.hqtb.core.refinement.annotation", false]], "specimen.hqtb.core.refinement.cleanup": [[22, "module-specimen.hqtb.core.refinement.cleanup", false]], "specimen.hqtb.core.refinement.extension": [[22, "module-specimen.hqtb.core.refinement.extension", false]], "specimen.hqtb.core.refinement.smoothing": [[22, "module-specimen.hqtb.core.refinement.smoothing", false]], "specimen.hqtb.core.validation": [[22, "module-specimen.hqtb.core.validation", false]], "specimen.hqtb.workflow": [[23, "module-specimen.hqtb.workflow", false]], "specimen.util.set_up": [[24, "module-specimen.util.set_up", false]], "specimen.util.util": [[24, "module-specimen.util.util", false]], "specimenmodelinforeport (class in specimen.classes.reports)": [[19, "specimen.classes.reports.SpecimenModelInfoReport", false]], "validate_config() (in module specimen.util.set_up)": [[24, "specimen.util.set_up.validate_config", false]], "visualise() (specimen.classes.reports.specimenmodelinforeport method)": [[19, "specimen.classes.reports.SpecimenModelInfoReport.visualise", false]], "wrapper() (in module specimen.cmpb.workflow)": [[21, "specimen.cmpb.workflow.wrapper", false]], "wrapper_pipeline() (in module specimen.hqtb.workflow)": [[23, "specimen.hqtb.workflow.wrapper_pipeline", false]]}, "objects": {"specimen": [[20, 0, 0, "-", "cmd_access"]], "specimen.classes": [[19, 0, 0, "-", "reports"]], "specimen.classes.reports": [[19, 1, 1, "", "SpecimenModelInfoReport"]], "specimen.classes.reports.SpecimenModelInfoReport": [[19, 2, 1, "", "__init__"], [19, 3, 1, "", "__module__"], [19, 2, 1, "", "format_table"], [19, 2, 1, "", "save"], [19, 2, 1, "", "visualise"]], "specimen.cmpb": [[21, 0, 0, "-", "workflow"]], "specimen.cmpb.workflow": [[21, 4, 1, "", "run"], [21, 4, 1, "", "wrapper"]], "specimen.hqtb": [[23, 0, 0, "-", "workflow"]], "specimen.hqtb.core": [[22, 0, 0, "-", "analysis"], [22, 0, 0, "-", "bidirectional_blast"], [22, 0, 0, "-", "generate_draft_model"], [22, 0, 0, "-", "validation"]], "specimen.hqtb.core.analysis": [[22, 4, 1, "", "run"]], "specimen.hqtb.core.bidirectional_blast": [[22, 4, 1, "", "bdbp_diamond"], [22, 4, 1, "", "create_diamond_db"], [22, 4, 1, "", "extract_bestbdbp_hits"], [22, 4, 1, "", "extract_cds"], [22, 4, 1, "", "run"], [22, 4, 1, "", "run_diamond_blastp"]], "specimen.hqtb.core.generate_draft_model": [[22, 4, 1, "", "check_unchanged"], [22, 4, 1, "", "edit_template_identifiers"], [22, 4, 1, "", "gen_draft_model"], [22, 4, 1, "", "pid_filter"], [22, 4, 1, "", "remove_absent_genes"], [22, 4, 1, "", "rename_found_homologs"], [22, 4, 1, "", "run"]], "specimen.hqtb.core.refinement": [[22, 0, 0, "-", "annotation"], [22, 0, 0, "-", "cleanup"], [22, 0, 0, "-", "extension"], [22, 0, 0, "-", "smoothing"]], "specimen.hqtb.core.refinement.annotation": [[22, 4, 1, "", "kegg_reaction_to_kegg_pathway"], [22, 4, 1, "", "run"]], "specimen.hqtb.core.refinement.cleanup": [[22, 4, 1, "", "check_direction"], [22, 4, 1, "", "cobra_gapfill_wrapper"], [22, 4, 1, "", "multiple_cobra_gapfill"], [22, 4, 1, "", "run"], [22, 4, 1, "", "single_cobra_gapfill"]], "specimen.hqtb.core.refinement.extension": [[22, 4, 1, "", "add_gene"], [22, 4, 1, "", "add_reaction"], [22, 4, 1, "", "build_metabolite_kegg"], [22, 4, 1, "", "build_metabolite_mnx"], [22, 4, 1, "", "extent_model"], [22, 4, 1, "", "find_best_diamond_hits"], [22, 4, 1, "", "get_metabolites_kegg"], [22, 4, 1, "", "get_metabolites_mnx"], [22, 4, 1, "", "get_ncbi_info"], [22, 4, 1, "", "identify_missing_genes"], [22, 4, 1, "", "isreaction_complete"], [22, 4, 1, "", "map_BiGG_reactions"], [22, 4, 1, "", "map_BiGG_reactions_row"], [22, 4, 1, "", "map_to_KEGG"], [22, 4, 1, "", "map_to_KEGG_row"], [22, 4, 1, "", "map_to_NCBI_efetch_row"], [22, 4, 1, "", "run"]], "specimen.hqtb.core.refinement.smoothing": [[22, 4, 1, "", "run"]], "specimen.hqtb.core.validation": [[22, 4, 1, "", "run"]], "specimen.hqtb.workflow": [[23, 4, 1, "", "run_complete"], [23, 4, 1, "", "wrapper_pipeline"]], "specimen.util": [[24, 0, 0, "-", "set_up"], [24, 0, 0, "-", "util"]], "specimen.util.set_up": [[24, 4, 1, "", "build_data_directories"], [24, 4, 1, "", "download_config"], [24, 4, 1, "", "download_mnx"], [24, 4, 1, "", "save_cmpb_user_input"], [24, 4, 1, "", "validate_config"]], "specimen.util.util": [[24, 4, 1, "", "create_DIAMOND_db_from_folder"], [24, 4, 1, "", "create_NCBIinfo_mapping"], [24, 4, 1, "", "get_info_GenBank_Record"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:function"}, "terms": {"": [2, 18, 20, 25, 26], "0": [6, 18, 20, 22], "01": 22, "023": [6, 20, 22], "05": [6, 20, 22], "1": [7, 10, 17, 19, 20, 25, 26], "10": 18, "100": 22, "10000": 22, "1024": 24, "14": [9, 10], "15": [9, 10], "2": [1, 2, 6, 18, 19, 20, 22, 24], "2000": 6, "2020": [9, 10], "2023": [7, 17], "2048": 24, "25": 22, "3": [6, 18, 20, 22], "4": [18, 20, 22, 26], "5": [20, 22], "80": [6, 20, 22], "90": [6, 20, 22], "95": [6, 22], "A": [3, 7, 8, 9, 10, 16, 19, 22, 24], "As": [7, 11], "For": [2, 3, 7, 10, 18, 22, 24], "If": [1, 3, 4, 7, 20, 21, 22], "In": 7, "It": 18, "NO": 26, "No": 23, "One": 1, "Or": 7, "The": [0, 1, 2, 3, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 18, 19, 21, 22, 23, 24, 25, 26, 27], "Then": 26, "These": 17, "To": [2, 7, 16, 26, 27], "__init__": 19, "__module__": 19, "__user__": [1, 6], "_description_": 19, "aa": 20, "about": [2, 6, 7, 24, 25], "abov": [2, 7, 11, 20, 22, 24], "absent": 22, "absolut": 2, "access": [1, 2, 5, 7, 18, 20, 22, 27], "acid": 22, "acorrect": 16, "ad": [2, 6, 7, 13, 16, 20, 22, 25], "adapt": 4, "add": [1, 3, 7, 13, 22, 26], "add_gen": [22, 23], "add_react": [22, 23], "addit": [1, 2, 3, 5, 6, 7, 22, 25], "addition": [7, 17, 18, 22], "adjust": [2, 7, 14, 22], "advanc": [7, 20, 24], "advis": [4, 10, 18, 24], "after": [1, 2, 7, 16, 20, 22], "afterward": 18, "again": [5, 26], "against": [10, 22], "aim": [5, 9, 11, 12, 13, 25], "ajdust": 14, "al": [9, 10, 20, 22], "all": [1, 2, 5, 6, 7, 10, 12, 18, 20, 22], "allow": [5, 7, 17, 22], "almost": 6, "alreadi": [2, 5, 22, 25], "alright": 6, "also": [6, 22], "amino": 22, "an": [2, 4, 5, 6, 7, 9, 18, 20, 22, 24, 25, 26], "analys": 22, "analysi": [1, 2, 5, 6, 7, 8, 20, 23], "andrea": [7, 17], "ani": [4, 26], "annot": [1, 2, 3, 5, 6, 7, 12, 15, 20, 23, 25, 26], "annotated_genom": [1, 6, 7, 23], "appli": [20, 22], "approach": 22, "ar": [1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 16, 17, 20, 22, 24, 25, 27], "archiev": 4, "arg": [19, 20, 21, 22, 23, 24], "assign": 22, "assum": 6, "attempt": 22, "attribut": 19, "author": 1, "autodoc": 3, "autom": [7, 17, 25], "automat": 1, "auxilliari": 22, "auxotrophi": [8, 20, 22], "avail": [2, 3, 8, 12, 20, 22, 25], "awar": 22, "b": [7, 17], "base": [0, 1, 2, 3, 5, 6, 7, 9, 10, 16, 17, 19, 20, 22, 23, 24, 26], "basic": [7, 20, 24], "bbh": 22, "bdb": 20, "bdbp_diamond": [22, 23], "been": [1, 3, 4, 5, 7, 13, 16, 18], "befor": 22, "beforehand": 18, "beginn": 7, "being": [2, 7], "bel": [7, 17], "belong": 22, "below": [1, 3, 6, 8, 9, 10, 14, 16, 25, 27], "bernhard": [9, 10], "best": [10, 22], "better": [7, 22], "between": 22, "bidirect": [5, 20, 22], "bidirectional_blast": [6, 23], "bigg": [1, 4, 6, 20, 22], "bigg_metabolit": 22, "bio": 12, "biocyc": [1, 2, 6, 7, 12, 20, 22, 25], "biocyc_db": [20, 22], "biocyc_fil": 1, "bioinformat": [7, 17], "biomass": [1, 2, 22], "bioppython": 22, "blast": [5, 7, 10, 20, 22, 26], "blastp": [20, 22], "bof": [1, 14], "bofdat": [1, 2, 18, 20, 22], "bofdat_param": 1, "bool": [3, 22], "both": [2, 7, 9], "boudari": 5, "bpbbh": [20, 22], "bqbiol": 1, "branch": 3, "bug": 17, "build": [1, 5, 7, 22, 24], "build_data_directori": [7, 24, 27], "build_metabolite_kegg": [22, 23], "build_metabolite_mnx": [22, 23], "builf": 7, "bullet": 2, "c": 20, "calcul": 1, "call": [2, 7, 14, 20], "camu": [7, 17], "can": [1, 2, 3, 5, 6, 7, 8, 10, 16, 18, 20, 22, 23, 24, 25, 26], "cannot": 20, "carri": 25, "carvem": [0, 1, 2, 17, 21, 24, 26], "case": [1, 2, 6, 7, 22], "caus": [4, 26], "cd": [20, 22], "cdm": 20, "cdr": 20, "certainti": 9, "chang": [2, 7, 16, 18, 20], "characterist": [7, 17], "charg": [14, 22], "charl": [9, 10], "chebi": 1, "check": [1, 5, 7, 10, 12, 14, 20, 22, 24, 26], "check_direct": [22, 23], "check_dupl_meta": [6, 20, 22], "check_dupl_reac": [6, 20, 22], "check_unchang": [22, 23], "chem": 20, "chem_prop": [6, 20, 22], "chem_prop_fil": 22, "chem_xref": [6, 20, 22], "chem_xref_fil": 22, "chemic": 1, "child": 19, "choic": [1, 20], "choos": [10, 20], "chunk": [6, 20, 22, 24], "chunk_siz": [6, 20, 22, 24], "class": [22, 27], "clean": [5, 15, 22], "cleanup": [3, 20, 23], "close": [5, 15], "closer": 25, "cm": 1, "cmd_access": 27, "cmpb": [17, 24, 27], "cobra": [16, 22], "cobra_gapfill_wrapp": [22, 23], "cobrapi": [12, 16, 19, 22], "code": [20, 22], "coenzym": 20, "coenzymes_and_ion": 18, "col_nam": 22, "collect": [17, 22, 24, 25], "collect_info": 22, "color": [1, 19], "color_palett": 19, "colour": 1, "column": [1, 2, 7, 20, 22, 24], "combin": 22, "come": 17, "command": [2, 5, 7, 18, 20, 27], "commandlin": 24, "compar": 22, "comparison": 20, "complet": [2, 7, 12, 15, 20, 22, 23], "compound": [1, 22], "concept": 5, "conda": 18, "condit": [5, 10], "config": [1, 2, 6, 7, 20, 22, 23, 24], "config_fil": [2, 7, 23], "configpath": [21, 24], "configur": [2, 5, 7, 16, 20, 21, 23, 24, 25], "connect": [2, 18, 22, 25], "consid": [20, 22], "consist": [5, 7, 17], "construct": [0, 7, 10, 20, 25], "conta": 24, "contact": 4, "contain": [1, 2, 7, 17, 20, 21, 22, 23, 24, 26, 27], "content": [5, 8], "continu": [1, 26], "control": 6, "contruct": 20, "copi": [22, 24], "core": [4, 6, 7, 8, 20, 23, 27], "correct": [6, 7], "correctli": 22, "correnspondingli": 22, "correspond": [22, 25], "corynebacterium": [7, 17], "count": 22, "cov": 22, "cover": 11, "coverag": [6, 20, 22], "creat": [1, 2, 3, 7, 16, 18, 22, 23, 24, 26], "create_diamond_db": [22, 23], "create_diamond_db_from_fold": [7, 24, 27], "create_ncbiinfo_map": [7, 24, 27], "creation": [19, 22, 24], "csv": [7, 20, 22], "curat": [2, 5, 8, 17, 22, 25], "current": [1, 2, 4, 6, 7, 8, 11, 12, 16, 17, 22, 24, 25], "cut": 22, "cycl": 22, "d": [7, 17, 20], "data": [1, 6, 20, 22, 23, 24, 25], "data_direc": 6, "data_fil": 22, "databas": [3, 5, 7, 10, 20, 22, 24, 25, 26], "datafram": [19, 22, 24], "date": 1, "db": [20, 22], "db_to_compar": 1, "db_xref": 24, "deafult": 20, "decid": [1, 22], "def": 3, "default": [1, 6, 19, 20, 21, 22, 23, 24], "delet": [12, 22], "depend": [6, 22, 24, 25], "describ": 9, "detail": 7, "detect": 24, "determin": [2, 22, 24], "dev": 3, "develop": [17, 20, 22, 24], "diamond": [6, 7, 9, 18, 20, 22, 24, 26], "dict": [22, 24], "dictionari": 24, "dictonari": 22, "differ": [3, 6, 7, 17, 20], "differnt": 25, "dir": [1, 6, 19, 20, 22, 24], "direc": 24, "direct": [1, 7, 10, 22, 27], "direction": [6, 12, 20], "directli": [2, 4, 7, 20, 22], "directori": [1, 6, 7, 18, 20, 22, 23, 24], "displai": 8, "dna": [1, 2, 20, 22], "dna_weight_frac": [6, 20, 22], "dna_weight_fract": 1, "do": [7, 22], "document": 17, "doe": [22, 24], "doenload": 20, "done": [3, 5, 7, 26], "dot": 22, "download": [2, 6, 7, 18, 20, 22, 24], "download_config": [2, 7, 24, 27], "download_mnx": [24, 27], "dr": [7, 17], "draft": [2, 5, 13, 15, 20, 22, 25], "duplic": [1, 12, 20, 22], "dure": [13, 24], "e": [2, 3, 7, 18, 20, 22, 24, 25, 26], "each": [1, 7], "ec": [1, 7, 20, 22, 24], "ec_numb": 24, "ecg": 6, "edit": [6, 20, 22, 24], "edit_nam": [6, 22], "edit_template_identifi": [22, 23], "editor": [2, 7], "egc": [6, 14, 20, 22], "egc_solv": 22, "either": [1, 2, 7, 18, 20, 22, 24], "els": 22, "email": 1, "empti": 23, "enabl": [2, 20, 22], "energi": 22, "ensur": [1, 7, 9, 16], "enter": [7, 21], "entir": 22, "entiti": [1, 12], "entrez": [1, 22], "entrezdirect": [18, 22], "entri": [2, 7, 20, 22], "environ": [18, 20, 24], "enzmi": 2, "enzym": 22, "equal": [20, 22], "equat": 22, "error": 18, "essenti": 10, "et": [9, 10, 20, 22], "eukarya": 3, "everi": 1, "everyth": [21, 23, 24], "exactli": 22, "exampl": 1, "examplari": 7, "excel": [1, 2], "except": [1, 6, 12], "exchang": [10, 20, 22], "exclud": [8, 20, 22], "exclude_dna": [6, 22], "exclude_rna": [6, 22], "exhaust": [20, 22], "exist": [5, 20, 22, 24, 25], "expect": 18, "experiment": 2, "explain": [1, 2, 7], "ext": 3, "extend": [11, 19, 20, 22, 25], "extend_model": 22, "extens": [3, 5, 13, 15, 20, 23, 24], "extent": [7, 19, 22], "extent_model": [22, 23], "extern": 7, "extra": [20, 22], "extra_info": 22, "extract": [20, 22], "extract_bestbdbp_hit": [22, 23], "extract_cd": [22, 23], "ezym": 1, "f": [7, 18, 20], "faa": [7, 22, 24], "factor": 22, "fals": [1, 6, 22], "famk": [7, 17], "fang": [9, 10], "faq": 17, "fasta": [1, 2, 20, 22, 24, 26], "fasta_path": 22, "faster": [6, 22], "featur": [3, 4, 20, 22], "fifth": 8, "fig": 26, "figur": [19, 26], "file": [2, 3, 5, 7, 16, 18, 20, 21, 22, 23, 24, 26], "file_path": 24, "filenam": [2, 7, 20, 22, 24], "filenotfounderror": 24, "filepath": 24, "fill": 1, "filter": [10, 20, 22], "final": [8, 14, 16], "finalis": 22, "find": [3, 12, 22], "find_best_diamond_hit": [22, 23], "fine": [5, 6], "first": [3, 7, 9, 13, 20, 22, 26], "fit": [6, 10, 15, 20, 22], "five": 5, "flag": [7, 22, 26], "float": 22, "fna": [7, 20, 22], "folder": [3, 6, 7, 23, 24], "follow": [1, 2, 5, 6, 7, 16, 17, 18, 20, 22, 24, 25], "format": [3, 7, 19, 22, 24, 26], "format_t": 19, "formula": 1, "found": [3, 8, 9, 10, 16, 20, 22, 23, 25], "four": 15, "fourth": [14, 16, 22], "fraction": [1, 2, 20, 22], "frame": 22, "free": 18, "from": [1, 2, 5, 6, 7, 10, 13, 20, 22, 24, 25, 27], "frontier": [7, 17], "full": [2, 5, 7, 20, 22, 23], "full_genome_sequ": 1, "full_sequ": 6, "func": [3, 22], "functin": 19, "function": [1, 2, 3, 5, 7, 16, 17, 18, 19, 20, 22, 24], "funktion": 23, "further": [2, 3, 7, 20, 22], "furthermor": 3, "futur": [2, 4, 11, 12, 16, 25, 26], "g": [2, 3, 7, 20, 22, 24, 25, 26], "gap": [1, 2], "gap_fill_fil": 1, "gap_fill_param": 1, "gapfil": [1, 2, 6, 7, 12, 20, 22, 25], "gbff": [7, 20, 22, 24], "geaphic": 16, "gem": [17, 19, 22, 23], "gen_draft_model": [22, 23], "genbank": [22, 24], "gene": [1, 2, 9, 10, 13, 20, 22, 26], "gene_list": 22, "gene_path": 22, "gene_t": 22, "geneid": 24, "geneproduct": 26, "gener": [1, 2, 3, 5, 6, 8, 9, 13, 15, 16, 19, 22, 23, 25, 26, 27], "generate_draft_model": [6, 23], "genom": [1, 2, 3, 5, 6, 7, 9, 10, 13, 15, 17, 20, 22, 23, 25], "genome_summari": 22, "ger": [7, 17], "get": [1, 22], "get_info_genbank_record": [24, 27], "get_metabolites_kegg": [22, 23], "get_metabolites_mnx": [22, 23], "get_ncbi_info": [22, 23], "gff": [1, 2], "github": [3, 4, 17], "given": [1, 2, 6, 19, 20, 21, 22, 24], "go": 7, "goal": 11, "good": 6, "graph": 19, "graphic": [8, 10, 14, 19], "greedi": 22, "group": 1, "grow": [17, 20, 22], "growth": [1, 2, 8, 10, 20, 22], "growth_threshold": [20, 22], "gt": 20, "guid": 24, "gwendolyn": [7, 17], "ha": [1, 2, 3, 4, 16, 18, 24, 25, 26], "hand": 1, "handl": 19, "have": [4, 5, 7, 10, 13, 22], "he": 22, "header": [20, 22], "heavili": 25, "heilbronn": [7, 17], "help": [7, 17, 20], "helper": 22, "here": 18, "heurist": [6, 20, 22], "high": [5, 7, 9, 17, 23, 24], "higher": 18, "hist": [20, 22], "hit": [10, 20, 22], "homolog": [10, 22], "hope": 4, "how": [2, 7, 22], "howev": [4, 25], "hqtb": [17, 24, 27], "htqb": 5, "i": [1, 2, 3, 6, 7, 8, 9, 10, 11, 12, 13, 15, 17, 18, 20, 22, 24, 25, 26, 27], "id": [1, 2, 6, 20, 22], "idea": [4, 9, 10, 17, 26], "ideal": [5, 17], "ident": [10, 20, 22], "identifi": [1, 4, 7, 9, 20, 22, 26], "identify_missing_gen": [22, 23], "ii": 26, "iii": 26, "imag": 5, "implememt": 22, "implement": [16, 22, 25], "implic": 3, "import": [2, 7, 18], "improv": 11, "in_head": [6, 22], "inchi": 1, "includ": [3, 4, 8, 12, 17, 19, 20, 22], "include_dna": 20, "include_rna": 20, "inconsist": 22, "inde": 1, "indep": 4, "index": 27, "individu": 26, "info": 1, "inform": [1, 2, 5, 6, 7, 14, 17, 19, 20, 21, 22, 23, 24, 26], "inlcud": 14, "input": [1, 2, 7, 9, 13, 15, 20, 22, 24, 25, 26], "input_nam": [6, 22], "input_path": 22, "insid": [2, 7, 18, 20], "instal": [17, 20], "instead": [6, 20], "int": [3, 22, 24], "integr": [3, 5], "inter": 6, "interest": 5, "io": 16, "ion": [1, 2, 20, 22], "ion_weight_frac": [6, 20, 22], "is_lab_strain": 1, "ishomologto": 1, "isreaction_complet": [22, 23], "issu": [17, 22, 26], "iter": [6, 20, 22], "its": [2, 7, 12, 22, 25], "j": [9, 10], "jonathan": [9, 10], "jupyt": [2, 7], "just": [7, 20], "keep": 22, "kegg": [1, 2, 6, 7, 11, 20, 22, 25], "kegg_id": 22, "kegg_organism_id": 1, "kegg_pathway_group": 1, "kegg_reaction_to_kegg_pathwai": [22, 23], "kegg_viaec": 22, "kegg_viarc": 22, "kei": 1, "kept": [20, 22], "keyword": [20, 22], "klebsiella": [3, 6, 20, 22], "knowledg": [1, 5, 24, 25], "known": [17, 26], "lab": 1, "lab_strain": 2, "laptop": 22, "last": 7, "laura": [7, 17], "lead": [7, 22], "least": 22, "leav": 24, "letter": 22, "level": 18, "liao": [20, 22], "line": [2, 5, 7, 18, 20, 27], "list": [1, 5, 6, 7, 20, 22, 27], "liter": [22, 24], "literatur": 2, "littl": 25, "load": [10, 19, 22, 24], "loci_list": 22, "locu": [1, 22], "locus_tag": [1, 6, 7, 20, 22, 24], "locus_tag_ref": 24, "m": [9, 10], "macromolecular": 20, "mai": 25, "mail": 1, "main": [3, 5], "mainli": [17, 24], "make": [15, 22], "mani": 5, "manipul": 19, "manual": [2, 6, 7, 22, 25], "manual_dir": 22, "map": [7, 18, 20, 22, 24], "map_bigg_react": [22, 23], "map_bigg_reactions_row": [22, 23], "map_to_bigg": 22, "map_to_kegg": [22, 23], "map_to_kegg_row": [22, 23], "map_to_ncbi_efetch_row": [22, 23], "mass": [14, 22], "masschargecur": [14, 18, 20], "match": 22, "matplotlib": [1, 19], "mcc": [6, 14, 18, 20, 22], "mean": 6, "media": [1, 2, 6, 7, 20, 22, 24], "media_analysi": 6, "media_gap": 6, "media_list": 22, "media_path": 22, "mediapath": 1, "medium": [6, 7, 10, 20, 22], "memori": 24, "memot": [1, 6, 20, 22], "memote_always_on": 1, "meta": 1, "metabcyc": 22, "metabol": [7, 9, 10, 17, 22], "metabolit": [1, 2, 12, 13, 20, 22], "metacyc": [12, 20, 22], "metanetx": [1, 6, 7, 20, 22, 24], "minim": [5, 7, 22], "miss": [2, 7, 22], "missing_gen": 22, "mnx": 20, "mnx_chem_prop": [6, 22], "mnx_chem_xref": [6, 22], "mnx_reac_prop": [6, 22], "mnx_reac_xref": [6, 22], "mode": [1, 20, 22], "model": [1, 2, 3, 5, 6, 7, 9, 14, 17, 19, 20, 22, 23, 25], "model_kegg_id": 22, "model_path": 22, "modelinforeport": 19, "modelname_gapfill_analysis_date_exampl": 1, "modelpath": 1, "modelpolish": [0, 2, 17, 24], "modul": [11, 27], "monk": [9, 10], "more": [2, 3, 6, 7, 15, 16, 17, 20, 22], "most": [8, 17], "mp": 20, "multi": [9, 10], "multipl": [1, 5, 7, 20, 22, 23], "multiple_cobra_gapfil": [22, 23], "multitud": 22, "must": 22, "mustach": 3, "my_basic_config": [2, 7, 24], "my_media_config": 7, "n": [6, 20], "name": [1, 6, 7, 10, 20, 22, 23, 24, 27], "namespac": [1, 6, 20, 22], "natur": [9, 10], "ncbi": [7, 18, 20, 22, 24, 26], "ncbi_accession_vers": [22, 24], "ncbi_dat": [6, 20, 22], "ncbi_map": [6, 20, 22], "ncbi_map_fil": 22, "neccessari": [1, 2, 7, 10, 18, 20], "necessari": [6, 7, 20, 24], "need": [1, 2, 5, 6, 7, 10, 18, 20, 21, 22, 24], "nest": 24, "new": [3, 6, 7, 10, 20, 22, 25], "newli": [22, 26], "nice": 8, "none": [6, 19, 21, 22, 24], "norsigian": [9, 10], "note": [17, 22, 24], "notebook": [2, 7], "nr": 26, "nsp": 20, "null": [1, 6], "num": 3, "number": [1, 7, 20, 22, 24, 27], "numer": 14, "o": [7, 9, 10, 17], "object": [1, 2, 20, 22, 26], "objective_funct": 20, "objective_valu": 18, "obtain": [1, 26], "occur": 26, "off": [5, 8, 22], "ofmedia": 22, "old_locus_tag": 24, "omit": 22, "onc": 6, "one": [7, 10, 18, 22, 25], "ones": [1, 6, 22], "ongo": 3, "onli": [1, 2, 6, 7, 12, 20, 22], "open": [2, 7, 10], "option": [1, 2, 6, 7, 8, 12, 14, 18, 19, 22, 23, 24, 27], "organ": [1, 2, 6, 7, 20, 22, 25, 26], "origin": [1, 4, 19, 22, 25], "other": [3, 4], "otherwis": [2, 18, 20, 22], "ouput": 22, "our": [4, 11], "out": [1, 6, 8, 22, 24, 25], "output": [1, 6, 7, 20, 22, 23, 24], "over": [20, 25], "overrview": 5, "overview": [2, 7, 8, 9, 14, 17], "overwrit": 22, "own": 3, "oxytoca": 3, "packag": [17, 18, 27], "page": [2, 3, 4, 7, 20], "palett": [1, 19], "palsson": [9, 10], "pan": [6, 7, 8, 20, 22], "param": 1, "paramet": [1, 2, 5, 6, 7, 16, 20, 22, 24], "paramt": 6, "parent": [6, 22, 24], "parent_dir": [7, 23], "part": [1, 15, 16, 20, 22], "pass": 20, "path": [1, 2, 6, 7, 20, 21, 22, 23, 24], "pathwai": [1, 6, 8, 11, 20, 22], "pc_based_on": [6, 22], "pc_model_path": 22, "pcc": 20, "pcm": 20, "pd": [19, 22, 24], "pend": 3, "percent": 20, "percentag": [10, 20, 22], "perform": [5, 6, 9, 12, 16, 20, 22, 25], "pgab": 25, "pgap": 26, "pictur": 11, "pid": [6, 10, 20, 22], "pid_filt": [22, 23], "pip": 18, "pipelin": [1, 3, 4, 6, 8, 9, 10, 11, 12, 15, 16, 20, 21, 22, 23, 24, 26], "place": [22, 23], "plan": 3, "pleas": [3, 4, 22], "plot": 1, "plu": 25, "pneumonia": [3, 22], "point": [2, 20, 22], "polish": [1, 2, 25], "possibl": [1, 22, 24], "potenti": [2, 6, 7, 22, 25], "precomput": 22, "predict": [7, 17], "present": [12, 22], "previou": [7, 16, 22], "previous": 15, "problem": [3, 4, 22, 26], "process": [12, 15], "produc": 22, "product": [1, 22], "profit": 25, "program": [6, 7, 26], "project": 7, "prokaryot": [9, 10, 26], "prokaryota": 4, "prokka": 22, "prompt": 21, "prop": 20, "protein": [1, 2, 20, 22, 26], "protein_fasta": 1, "protein_id": [20, 22, 24], "protocol": [9, 10], "provid": 1, "pure": 7, "py": [18, 22], "python": [2, 5, 7, 17, 18, 20], "qualifi": [1, 20, 22, 24], "qualiti": [5, 7, 17, 23, 24], "queri": [20, 22], "question": 22, "quickstart": 25, "qvt": 22, "rais": [18, 22, 23, 24], "random": 22, "randomis": 6, "rare": 22, "rate": 22, "rc": 20, "rdm": 20, "rdr": 20, "reac": [20, 22], "reac_prop": [6, 20, 22], "reac_prop_fil": 22, "reac_xref": [6, 20, 22], "reac_xref_fil": 22, "reactant": 1, "reaction": [1, 2, 6, 7, 11, 12, 13, 19, 20, 22], "read": 24, "readi": [3, 7, 22], "reagrd": 4, "reation": 22, "recommend": [20, 22], "recurs": 24, "reduc": 1, "refer": [2, 3, 7, 17, 22], "refin": [5, 11, 12, 13, 14, 23, 26], "refinegem": [2, 3, 7, 10, 17, 19, 20, 22, 25], "refinement_annot": 6, "refinement_cleanup": 6, "refinement_extens": 6, "refinement_smooth": 6, "refseq": [1, 7, 22, 26], "refseq_gff": 1, "regard": [7, 12], "rel": 6, "relat": [5, 22], "releas": 3, "relev": [1, 2, 3], "reli": 22, "remain": 26, "remov": [1, 4, 10, 14, 20, 22], "remove_absent_gen": [22, 23], "remove_dupl_meta": [6, 20, 22], "remove_dupl_reac": [6, 20, 22], "remove_unused_meta": [6, 20, 22], "remove_unused_metab": 1, "renam": [10, 22], "rename_found_homolog": [22, 23], "replac": 20, "report": [1, 2, 7, 20, 27], "repositori": 18, "represent": [10, 16], "requir": [1, 2, 6, 7, 20, 22, 25], "rerun": 26, "research": 2, "resolv": [1, 12, 22, 26], "respect": 24, "restrict": 26, "restructur": 3, "result": [1, 7, 10, 20, 22, 26], "retriev": [2, 22, 24], "return": [3, 19, 22, 24], "rewrit": 22, "rewritten": 22, "rna": [20, 22], "row": 22, "rum": 20, "run": [1, 4, 5, 6, 16, 18, 21, 22, 23, 24, 25, 26, 27], "run_al": 22, "run_bofdat": 1, "run_complet": [7, 23], "run_diamond_blastp": [22, 23], "runtim": 22, "same": [1, 5, 7, 22, 23, 26], "save": [1, 19, 20, 22, 24], "save_all_model": 1, "save_cmpb_user_input": [24, 27], "sbml": [16, 22], "sbo": 22, "sboannot": 22, "sboterm": 11, "scale": [7, 9, 10, 17, 22], "scheme": 1, "script": [2, 7, 18, 22], "seach": 27, "search": [22, 23, 24, 26], "second": [20, 22], "section": 5, "see": [2, 5, 7, 22, 27], "seen": 11, "seif": [9, 10], "semi": 7, "sensit": [6, 20, 22], "sensitv": 20, "separatli": [5, 17], "sequenc": [1, 2, 7, 20, 22, 23], "sequenec": 2, "sequenti": 5, "seri": 22, "set": [1, 3, 6, 7, 8, 10, 19, 20, 22, 24, 25], "set_up": [7, 27], "setup": [2, 6, 7, 27], "sheet": 2, "should": [1, 2, 6, 20, 22, 24, 25], "show": [5, 22], "silico": 8, "similar": [5, 22, 25], "simon": [7, 17], "simpli": 1, "simul": 22, "simultani": 20, "singl": [6, 22], "single_cobra_gapfil": [22, 23], "size": [6, 20, 24], "skip": [1, 6, 8, 20, 22], "small": 6, "smart": [2, 7, 22], "smarttabl": 1, "smooth": [5, 15, 20, 23], "solut": [18, 22], "solv": [20, 22], "solver": [20, 22], "some": 25, "someth": 4, "soon": 17, "sourc": [19, 21, 22, 23, 24], "sp": 3, "speci": [3, 5], "special": 6, "specif": [1, 3, 15, 17, 19, 20, 23], "specifi": [1, 20], "specimen": [1, 2, 3, 5, 7, 18], "specimen_model": 6, "specimen_run": 6, "specimenmodelinforeport": [19, 27], "speed": [5, 7], "sphinx": 3, "split": 15, "spontan": 1, "squar": 3, "stage": 26, "stai": 12, "standart": 6, "start": [2, 5, 7, 20, 22], "statist": [1, 8], "stats_always_on": 1, "statu": 17, "step": [1, 2, 5, 6, 7, 17, 20, 21, 22, 24, 26], "stick": 4, "still": [12, 22, 25, 26], "stoichiometr": 22, "str": [19, 21, 22, 23, 24], "strain": [1, 5, 9, 10, 15, 17, 23], "striatum": [7, 17], "string": 20, "structur": [1, 6, 7, 20, 22, 24], "subfold": 23, "subject": [6, 22, 23], "submodul": 17, "subpackag": [17, 21], "subscript": 7, "subsequ": 25, "subspack": 23, "success": 22, "successful": 20, "successfulli": [3, 22], "suffic": 6, "suitabl": 7, "summari": 17, "support": 7, "suppos": [7, 22], "susequ": 7, "t": [2, 7, 20], "taa": 20, "tabl": [2, 7, 8, 19, 22, 24], "table_fil": 22, "tag": [1, 7, 22], "take": 22, "taken": 7, "taxon": 26, "taxonomi": 26, "temp": 20, "temp_head": [6, 22], "templat": [3, 5, 6, 7, 9, 10, 17, 20, 22, 23, 24], "template_nam": [6, 22], "template_path": 22, "test": [1, 2, 3, 4, 8, 20, 22], "test_aa_auxotrophi": [6, 22], "test_config": 23, "text": 3, "than": 4, "thei": [20, 22], "them": [1, 3, 22], "therefor": 25, "thi": [1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 16, 20, 21, 22, 23, 25, 26], "third": [11, 12, 15, 22], "those": 3, "thread": [6, 20, 22, 24], "three": [1, 2, 7, 22], "threshold": [10, 20, 22], "thrid": 20, "throuh": 24, "time": [22, 23], "todo": 22, "too": 6, "tool": [18, 25, 27], "toolbox": [7, 17], "top": 18, "total": 2, "toward": 4, "true": [1, 2, 3, 6, 20, 22], "try": [6, 20, 22], "tsv": [6, 22], "tune": [5, 12], "tupl": 19, "turn": [5, 8], "tvq": 22, "two": [2, 7, 19, 22], "txt": [1, 2], "type": [2, 3, 5, 7, 19, 20, 22, 24, 25], "u": [4, 20], "uerl": [7, 17], "ultra": 22, "un": 22, "unad": 22, "unchang": 10, "under": [0, 1, 10, 20, 22, 24, 25], "underli": [1, 6, 22], "underscor": 22, "underscore_attrs_are_priv": 4, "union": [21, 22, 24], "univers": [6, 7, 20, 22], "unknown": [22, 24], "unkown": 23, "unsucces": 22, "unus": [1, 12, 20, 22], "up": [5, 7, 15, 22, 24], "updat": [2, 4, 11, 12, 16, 22, 25, 26], "upon": 5, "us": [1, 2, 3, 6, 7, 9, 10, 12, 14, 17, 19, 20, 22, 23, 24, 25, 26, 27], "user": [1, 6, 7, 21, 24, 25], "userc": 24, "usual": 6, "util": [7, 27], "v": 22, "valid": [1, 5, 6, 20, 23, 24, 26], "validate_config": [24, 27], "validate_sbml_model": 16, "valu": [1, 9, 10, 20, 22], "valueerror": [22, 23, 24], "variant": 12, "variou": 25, "veri": [5, 22, 25], "versa": 3, "version": [3, 7, 18, 20, 22], "via": [5, 7, 16, 17, 20, 22, 24, 26], "viaec": [6, 22], "viarc": [6, 22], "vice": 3, "visualis": 19, "vitro": [7, 17], "vscode": 3, "wa": [4, 10, 20, 22], "wai": 7, "want": 6, "warn": 4, "we": 4, "web": 20, "weight": [1, 2, 20, 22], "weight_fract": 1, "well": [3, 7, 22], "were": [20, 22], "what": [4, 7], "when": [2, 7, 20, 22], "where": [22, 26], "whether": [1, 7, 22], "which": [1, 16, 20, 22, 24, 25, 27], "while": [4, 7, 18], "whole": [1, 20], "wish": [4, 25], "witha": 4, "without": [3, 22, 26], "work": [3, 10, 12, 22], "workflow": [2, 7, 9, 10, 17, 22, 26, 27], "working_dir": 22, "wrapper": [5, 7, 20, 21, 22], "wrapper_pipelin": [7, 23], "write": [4, 24], "written": 4, "x": [3, 6], "xin": [9, 10], "xlsx": 1, "xref": 20, "yaml": [2, 7, 23, 24], "yara": [9, 10], "ye": 26, "yet": [3, 4, 22], "ylgn": [1, 19], "you": [3, 4, 7, 25], "your": [2, 3, 5, 7, 20, 22, 25, 26], "your_folder_nam": 7, "\u00e4": [7, 17], "\u00f6": [7, 17]}, "titles": ["About CMPB", "CMPB Configuration File", "Run the CMPB Pipeline", "Notes for Developers", "Help & FAQ", "About HQTB", "HQTB Configuration File", "Run the HTQB Pipeline", "5. Step 5: Analyse the Model", "1. Step 1: Bidirectional BLAST", "2. Step 2: Generate a Draft Model", "3.3. Step 3, Part 3: Further Annotate the Model", "3.2. Step 3, Part 2: Cleaning the Model", "3.1. Step 3, Part 1: Extending the Model", "3.4. Step 3, Part 4: Smoothing", "3. Step 3: Further Refine the Model", "4. Step 4: Model Validation", "Welcome to SPECIMEN!", "Installation", "specimen.classes package", "The specimen.cmd_access submodule", "specimen.cmpb package", "specimen.hqtb.core package", "specimen.hqtb package", "specimen.util package", "Overview of the Pipelines", "PGAB: From genome sequence to draft model", "Contents of SPECIMEN"], "titleterms": {"1": [9, 13], "2": [10, 12], "3": [11, 12, 13, 14, 15], "4": [14, 16], "5": 8, "The": 20, "about": [0, 5], "analys": 8, "analysi": 22, "annot": [11, 22], "avail": 17, "base": 25, "bidirect": 9, "bidirectional_blast": 22, "blast": 9, "bug": 4, "can": 4, "carvem": 25, "cite": 17, "class": 19, "clean": 12, "cleanup": 22, "cmd_access": 20, "cmpb": [0, 1, 2, 21, 25], "collect": [2, 7], "configur": [1, 6], "content": [17, 27], "core": 22, "current": 3, "data": [2, 7], "develop": 3, "document": 3, "draft": [10, 26], "extend": 13, "extens": 22, "faq": 4, "file": [1, 6], "from": 26, "further": [11, 15, 25], "gener": [10, 20], "generate_draft_model": 22, "genom": 26, "github": 18, "help": 4, "high": 25, "how": 17, "hqtb": [5, 6, 7, 22, 23, 25], "htqb": 7, "i": 4, "idea": 25, "inform": [3, 25], "instal": 18, "issu": 4, "known": 4, "model": [8, 10, 11, 12, 13, 15, 16, 26], "modelpolish": 25, "modul": 24, "more": 25, "namespac": 4, "note": 3, "option": 20, "organ": 4, "overview": [0, 5, 25], "packag": [19, 21, 22, 23, 24], "part": [11, 12, 13, 14], "pgab": 26, "pipelin": [0, 2, 5, 7, 17, 25], "pydant": 4, "qualiti": 25, "quickstart": [2, 7], "refin": [15, 20, 22], "report": 19, "run": [2, 7, 20], "sequenc": 26, "set_up": 24, "setup": 20, "smooth": [14, 22], "specimen": [4, 17, 19, 20, 21, 22, 23, 24, 27], "statu": 3, "step": [8, 9, 10, 11, 12, 13, 14, 15, 16], "submodul": [19, 20, 21, 22, 23, 24, 27], "subpackag": [22, 23, 27], "templat": 25, "us": 4, "util": 24, "valid": [16, 22], "via": 18, "welcom": 17, "which": 4, "work": 4, "workflow": [21, 23]}})
\ No newline at end of file
diff --git a/docs/build/html/specimen.html b/docs/build/html/specimen.html
index c724403..8d8a481 100644
--- a/docs/build/html/specimen.html
+++ b/docs/build/html/specimen.html
@@ -19,7 +19,7 @@
-
+
diff --git a/docs/source/images/genome2draft.png b/docs/source/images/genome2draft.png
new file mode 100644
index 0000000..5239b6b
Binary files /dev/null and b/docs/source/images/genome2draft.png differ
diff --git a/docs/source/images/genome2draft.svg b/docs/source/images/genome2draft.svg
deleted file mode 100644
index 8c07bb3..0000000
--- a/docs/source/images/genome2draft.svg
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-
-
\ No newline at end of file
diff --git a/docs/source/pipeline_idea.rst b/docs/source/pipeline_idea.rst
index d93a94e..772be29 100644
--- a/docs/source/pipeline_idea.rst
+++ b/docs/source/pipeline_idea.rst
@@ -32,7 +32,7 @@ workflow in Figure :numref:`pgab_workflow` can be used.
.. _pgab_workflow:
-.. figure:: images/genome2draft.svg
+.. figure:: images/genome2draft.png
:alt: Workflow from genome sequence to a draft model
Workflow from genome sequence to a draft model