updated usage_guide and added python version

eltrompetero · Nov 28, 2019 · 976bd1c · 976bd1c
1 parent 97504ab
commit 976bd1c
Show file tree

Hide file tree

Showing 4 changed files with 499 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -61,7 +61,7 @@ $ python enumerate.py [N] 1
 specifies that the system should be written for the {-1,1} basis.  For more details, see
 the `__main__` block at the end of the file enumerate.py.
 
-## Quick guide
+## Quick guide (with Jupyter notebook)
 
 A [Jupyter notebook](https://github.com/eltrompetero/coniii/blob/master/ipynb/usage_guide.ipynb) with a brief introduction and examples for how to use ConIII is
 available. An HTML version is [here](https://github.com/eltrompetero/coniii/blob/master/ipynb/usage_guide.html). The
@@ -84,6 +84,19 @@ $ jupyter notebook
 
 This should open the notebook in your default web browser.
 
+## Quick guide (console)
+
+First, install iPython for a console-based interpreter.
+```bash
+$ pip install ipython
+```
+or if you are using the Conda package manager
+```bash
+$ conda install ipython
+```
+
+
+
 ## Dependencies
 
 In order to open the usage guide Jupyter notebook, you must have both Jupyter installed.

diff --git a/ipynb/usage_guide.html b/ipynb/usage_guide.html
@@ -13018,33 +13018,7 @@
 .highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
     </style>
 <style type="text/css">
-    .container { width:90% !important; }
-.CodeMirror pre {
-    font-family: Menlo;
-    font-size: 8pt;
-}
-
-div.container pre{
-    font-family: Menlo;
-    font-size: 8pt;
-}
-
-<script>
-    MathJax.Hub.Config({
-        "HTML-CSS": {
-            /*preferredFont: "TeX",*/
-            /*availableFonts: ["TeX", "STIX"],*/
-            styles: {
-                scale: 100,
-                ".MathJax_Display": {
-                    "font-size": "100%",
-                }
-            }
-        }
-    });
-</script>
 
-
     </style>
 
 
@@ -13102,7 +13076,12 @@
 <body>
   <div tabindex="-1" id="notebook" class="border-box-sizing">
     <div class="container" id="notebook-container">
-MIT License
+
+<div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
+</div><div class="inner_cell">
+<div class="text_cell_render border-box-sizing rendered_html">
+
+<pre><code>MIT License
 
 Copyright (c) 2019 Edward D. Lee, Bryan C. Daniels
 
@@ -13122,7 +13101,11 @@
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.</code></pre>
+
+</div>
+</div>
+</div>
 <div class="cell border-box-sizing text_cell rendered"><div class="prompt input_prompt">
 </div><div class="inner_cell">
 <div class="text_cell_render border-box-sizing rendered_html">

diff --git a/ipynb/usage_guide.ipynb b/ipynb/usage_guide.ipynb
@@ -1,9 +1,10 @@
 {
  "cells": [
   {
-   "cell_type": "raw",
+   "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "```\n",
     "MIT License\n",
     "\n",
     "Copyright (c) 2019 Edward D. Lee, Bryan C. Daniels\n",
@@ -24,7 +25,8 @@
     "AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n",
     "LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n",
     "OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n",
-    "SOFTWARE."
+    "SOFTWARE.\n",
+    "```"
    ]
   },
   {