docs: add guide on how to interpret the reports

* docs: add draft guide on how to read and interpret the reports * docs: include paragraph on history plots * docs: update readme on memote report app * chore: bundle report app * chore: update changelog. * fix: correct minor typos and expressions as per suggestions * chore: rebundle reports
opencobra · Mar 18, 2019 · b9788bb · b9788bb
1 parent c857af4
commit b9788bb
Show file tree

Hide file tree

Showing 10 changed files with 633 additions and 75 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -4,6 +4,8 @@ History
 Next Release
 ------------
 * Update docstring of test_find_duplicate_reactions.
+* Add a guide explaining the structure of and how to interpret the memote
+  reports.
 * Add guidelines on writing custom tests to the documentation.
 
 0.9.6 (2019-03-06)

diff --git a/docs/ReportDiff.png b/docs/ReportDiff.png
diff --git a/docs/ReportHistory.png b/docs/ReportHistory.png
diff --git a/docs/ReportSnapshot.png b/docs/ReportSnapshot.png
diff --git a/docs/_static/my-styles.css b/docs/_static/my-styles.css
@@ -22,6 +22,18 @@ input.form-control{
     text-color: #FFF;
 }
 
+.red{
+    color: rgb(161, 18, 18);
+}
+
+.green{
+    color: rgb(18, 161, 46);
+}
+
+.blue{
+    color: rgb(42, 123, 184);
+}
+
 .form-control::-webkit-input-placeholder {
     color: #ACD7E6;
 }  /* WebKit, Blink, Edge */

diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -21,6 +21,11 @@ Users that have already followed these steps once may want to refer to the
 comprehensive insight into all optional parameters of the CLI please refer to
 the :doc:`corresponding API reference <_autogen/memote.suite.cli>`.
 
+If you only want to benchmark a model, using the `memote
+webservice hosted at memote.io`_ instead may be more convenient.
+
+.. _memote webservice hosted at memote.io: https://memote.io/
+
 Benchmark
 =========
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -24,6 +24,7 @@ Contents
    installation
    getting_started
    flowchart
+   understanding_reports
    experimental_data
    custom_tests
    test_suite

diff --git a/docs/understanding_reports.rst b/docs/understanding_reports.rst
diff --git a/memote-report-app/src/app/help-dialog/help-dialog-text.component.html b/memote-report-app/src/app/help-dialog/help-dialog-text.component.html
diff --git a/memote/suite/templates/index.html b/memote/suite/templates/index.html