memory-graph 0.3.5__tar.gz → 0.3.7__tar.gz

{memory_graph-0.3.5/memory_graph.egg-info → memory_graph-0.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: memory_graph
-Version: 0.3.5
+Version: 0.3.7
 Summary: Draws a graph of your data to analyze its structure.
 Home-page: https://github.com/bterwijn/memory_graph
 Author: Bas Terwijn
@@ -31,7 +31,7 @@ In Python, assigning the list from variable `a` to variable `b` causes both vari
 <table><tr><td> 
 
 ```python
-import memory_graph
+import memory_graph as mg
 
 # create the lists 'a' and 'b'
 a = [4, 3, 2]
@@ -47,7 +47,7 @@ print('ids:', id(a), id(b))
 print('identical?:', a is b)
 
 # show all local variables in a graph
-memory_graph.show( locals() )
+mg.show( locals() )
 ```
 
 </td><td>
@@ -71,7 +71,7 @@ A better way to understand what data is shared is to draw a graph of the data us
 The [memory_graph](https://pypi.org/project/memory-graph/) package can graph many different data types.
 
 ```python
-import memory_graph
+import memory_graph as mg
 
 class MyClass:
 
@@ -80,35 +80,35 @@ class MyClass:
         self.y = y
 
 data = [ range(1, 2), (3, 4), {5, 6}, {7:'seven', 8:'eight'},  MyClass(9, 10) ]
-memory_graph.show(data, block=True)
+mg.show(data)
 ```
 ![many_types.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/many_types.png)
 
-By using `block=True` the program blocks until the ENTER key is pressed so you can view the graph before continuing program execution (and possibly viewing later graphs). Instead of showing the graph you can also render it to an output file of your choosing (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
+Instead of showing the graph you can also render it to an output file of your choosing (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
 
 ```python
-memory_graph.render(data, "my_graph.pdf")
-memory_graph.render(data, "my_graph.png")
-memory_graph.render(data, "my_graph.gv") # Graphviz DOT file
+mg.render(data, "my_graph.pdf")
+mg.render(data, "my_graph.png")
+mg.render(data, "my_graph.gv") # Graphviz DOT file
 ```
 
 # Chapters #
 
-[1. Python Data Model](#1-python-data-model)
+[Python Data Model](#python-data-model)
 
-[2. Debugging](#2-debugging)
+[Call Stack](#call-stack)
 
-[3. Call Stack](#3-call-stack)
+[Debugging](#Debugging)
 
-[4. Datastructure Examples](#4-datastructure-examples)
+[Datastructure Examples](#datastructure-examples)
 
-[5. Configuration](#5-configuration)
+[Configuration](#configuration)
 
-[6. Extensions](#6-extensions)
+[Extensions](#extensions)
 
-[7. Jupyter Notebook](#7-jupyter-notebook)
+[Jupyter Notebook](#jupyter-notebook)
 
-[8. Troubleshooting](#8-troubleshooting)
+[Troubleshooting](#troubleshooting)
 
 
 ## Author ##
@@ -117,27 +117,30 @@ Bas Terwijn
 ## Inspiration ##
 Inspired by [Python Tutor](https://pythontutor.com/).
 
+## Supported by ##
+<img src="https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/uva.png" alt="University of Amsterdam" width="600">
+
 ___
 ___
 
-## 1. Python Data Model ##
+## Python Data Model ##
 The [Python Data Model](https://docs.python.org/3/reference/datamodel.html) makes a distiction between immutable and mutable types:
 
 * **immutable**: bool, int, float, complex, str, tuple, bytes, frozenset
-* **mutable**: list, dict, set, class, ... (most other types)
+* **mutable**: list, set, dict, classes, ... (most other types)
 
 
 ### Immutable Type ###
-In the code below variable `a` and `b` both reference the same tuple value (4, 3, 2). A tuple is an immutable type and therefore when we change variable `a` its value can not be mutated in place, and thus a copy is made and `a` and `b` reference a different value afterwards.
+In the code below variable `a` and `b` both reference the same tuple value (4, 3, 2). A tuple is an immutable type and therefore when we change variable `a` its value **cannot** be mutated in place, and thus a copy is made and `a` and `b` reference a different value afterwards.
 
 ```python
-import memory_graph
+import memory_graph as mg
 
 a = (4, 3, 2)
 b = a
-memory_graph.render(locals(), 'immutable1.png')
+mg.render(locals(), 'immutable1.png')
 a += (1,)
-memory_graph.render(locals(), 'immutable2.png')
+mg.render(locals(), 'immutable2.png')
 ```
 | ![mutable1.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/immutable1.png) | ![mutable2.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/immutable2.png) |
 |:-----------------------------------------------------------:|:-------------------------------------------------------------:|
@@ -148,27 +151,25 @@ memory_graph.render(locals(), 'immutable2.png')
 With mutable types the result is different. In the code below variable `a` and `b` both reference the same `list` value [4, 3, 2]. A `list` is a mutable type and therefore when we change variable `a` its value **can** be mutated in place and thus `a` and `b` both reference the same new value afterwards. Thus changing `a` also changes `b` and vice versa. Sometimes we want this but other times we don't and then we will have to make a copy so that `b` is independent from `a`.
 
 ```python
-import memory_graph
+import memory_graph as mg
 
 a = [4, 3, 2]
 b = a
-memory_graph.render(locals(), 'mutable1.png')
+mg.render(locals(), 'mutable1.png')
 a += [1] # equivalent to:  a.append(1)
-memory_graph.render(locals(), 'mutable2.png')
+mg.render(locals(), 'mutable2.png')
 ```
 | ![mutable1.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/mutable1.png) | ![mutable2.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/mutable2.png) |
 |:-----------------------------------------------------------:|:-------------------------------------------------------------:|
 | mutable1.png | mutable2.png |
 
-
-Python makes this distiction between mutable and immutable types because a value of a mutable type could be large and therefore it would be slow to make a copy each time we change it. On the other hand, a value of a immutable type generally is small and therefore fast to copy.
-
+One practical reason why Python makes the distinction between mutable and immutable types is that a value of a mutable type could be large, making it inefficient to copy each time we change it. Immutable values generally don't need to change as much or are smaller, which makes copying less of a concern.
 
 ### Copying ###
 Python offers three different "copy" options that we will demonstrate using a nested list:
 
 ```python
-import memory_graph
+import memory_graph as mg
 import copy
 
 a = [ [1, 2], ['x', 'y'] ] # a nested list (a list containing lists)
@@ -178,21 +179,21 @@ c1 = a
 c2 = copy.copy(a) # equivalent to:  a.copy() a[:] list(a)
 c3 = copy.deepcopy(a)
 
-memory_graph.show(locals())
+mg.show(locals())
 ```
 
-* `c1` is an **assignment**, all the data is shared, nothing is copied
-* `c2` is a **shallow copy**, only the data referenced by the first reference is copied and the underlying data is shared
-* `c3` is a **deep copy**, all the data is copied, nothing is shared
+* `c1` is an **assignment**, nothing is copied, all the values are shared
+* `c2` is a **shallow copy**, only the value referenced by the first reference is copied, all the underlying values are shared
+* `c3` is a **deep copy**, all the values are copied, nothing is shared
 
 ![copies.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/copies.png)
 
 
 ### Custom Copy Method ###
-We can write our own custom copy function or method in case the three "copy" options don't do what we want. For example the copy() method of My_Class in the code below copies the `digits` but shares the `letters` between the two objects.
+We can write our own custom copy function or method in case the three "copy" options don't do what we want. For example, in the code below the copy() method of My_Class copies the `digits` but shares the `letters` between two objects.
 
 ```python
-import memory_graph
+import memory_graph as mg
 import copy
 
 class My_Class:
@@ -209,70 +210,22 @@ class My_Class:
 a = My_Class()
 b = a.copy()
 
-memory_graph.show(locals())
+mg.show(locals())
 ```
 ![copy_method.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/copy_method.png)
 
 
-## 2. Debugging ##
-Often it is useful to graph all the local variables using:
-```python
-memory_graph.show(locals(), block=True)
-```
+## Call Stack ##
+The `mg.get_call_stack()` function retrieves the entire call stack, including the local variables for each function on the stack. This enables us to visualize the local variables across all active functions simultaneously. Then by examining the graph, we can determine whether any local variables from different functions on the call stack share data. For instance, consider the function `add_one()` which adds the value `1` to each of its parameters, `a`, `b`, and `c`.
 
-So much so that function `d()` is available as alias for this for easier debugging. Additionally it can optionally log the data by printing them. For example:
 ```python
-import memory_graph
-
-squares = []
-squares_collector = []
-for i in range(1,6):
-    squares.append(i**2)
-    squares_collector.append(squares.copy())
-    memory_graph.d(log=True)
-```
-which after pressing ENTER a number of times results in:
-
-![debugging.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/debugging.gif)
-```
-squares: [1, 4, 9, 16, 25]
-squares_collector: [[1], [1, 4], [1, 4, 9], [1, 4, 9, 16], [1, 4, 9, 16, 25]]
-i: 5
-```
-
-Function `d()` has these default arguments:
-```python
-def d(data=None, graph=True, log=False, block=True):
-```
-- data: the data that is handled, defaults to `locals()` when not specified
-- graph: if True the data is visualized as a graph
-- log: if True the data is printed
-- block: if True the function blocks until the ENTER key is pressed
-
-To print to a log file instead of standard output use:
-```python
-memory_graph.log_file = open("my_log_file.txt", "w")
-```
-
-### Watchpoint in Debugger ###
-Alternatively you get an even better debugging experience when you set expression:
-```
-memory_graph.render(locals(), "my_debug_graph.pdf")
-```
-as a *watchpoint* in a debugger tool and open the "my_debug_graph.pdf" output file. This continuouly shows the graph of all the local variables while debugging and avoids having to add any memory_graph `show()`, `render()`, or `d()` calls to your code.
-
-
-## 3. Call Stack ##
-The function `memory_graph.get_call_stack()` returns the complete call stack, including all local variables for each function in the stack. This allows us to simultaneously visualize the local variables of all the called functions. By doing so, we can identify whether any local variables from different functions in the call stack share data with one another. Here for example we call function ```add_one()``` with arguments ```a, b, c``` that adds 1 to each of its arguments.
-
-```python
-import memory_graph
+import memory_graph as mg
 
 def add_one(a, b, c):
     a += [1]
     b += (1,)
     c += [1]
-    memory_graph.show(memory_graph.get_call_stack())
+    mg.show(mg.get_call_stack())
 
 a = [4, 3, 2]
 b = (4, 3, 2)
@@ -288,55 +241,127 @@ In the printed output only `a` is changed as a result of the function call:
 a:[4, 3, 2, 1] b:(4, 3, 2) c:[4, 3, 2]
 ```
 
-This is because `b` is of immutable type 'tuple' so its value gets copied automatically when it is changed. And because the function is called with a copy of `c`, its original value is not changed by the function. The value of variable `a` is the only value of mutable type that is shared between the root stack frame **0: \<module>** and the **1: add_one** stack frame of the function so only that variable is affected as a result of the function call. The other changes remain confined to the local variables of the ```add_one()``` function.
+This is because `b` is of immutable type 'tuple' so its value gets copied automatically when it is changed. And because the function is called with a copy of `c`, its original value is not changed by the function. The value of variable `a` is the only value of mutable type that is shared between the root stack frame **'0: \<module>'** and the **'1: add_one'** stack frame of the function so only that variable is affected as a result of the function call. The other changes remain confined to the local variables of the ```add_one()``` function.
+
+### Block ###
+It is often helpful to temporarily block program execution to inspect the graph. For this, you can use the `mg.block()` function:
+
+```python
+mg.block(fun, arg1, arg2, ..., loc=True) 
+```
 
+This function first executes `fun(arg1, arg2, ...)`, then prints the current source location in the program, and blocks execution until the &lt;Enter&gt; key is pressed. To skip printing the source location, set `loc=False`.
 
 ### Recursion ###
-The call stack can be used to visualize how recursion works. Here we show each step of how recursively ```factorial(3)``` is computed:
+The call stack is also helpful to visualize how recursion works. Here we use `mg.block()` to show each step of how recursively ```factorial(3)``` is computed:
 
 ```python
-import memory_graph
+import memory_graph as mg
 
 def factorial(n):
     if n==0:
         return 1
-    memory_graph.show( memory_graph.get_call_stack(), block=True )
+    mg.block(mg.show, mg.get_call_stack())
     result = n * factorial(n-1)
-    memory_graph.show( memory_graph.get_call_stack(), block=True )
+    mg.block(mg.show, mg.get_call_stack())
     return result
 
 print(factorial(3))
 ```
+
 ![factorial.gif](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/factorial.gif)
 
-and the final result is: 1 x 2 x 3 = 6
+and the result is: 1 x 2 x 3 = 6
+
+### Power Set ###
+A more interesting recursive example that shows sharing of data is power_set(). A power set is the set of all subsets of a collection of values.
+
+```python
+import memory_graph as mg
+
+def get_subsets(subsets, data, i, subset):
+    mg.block(mg.show, mg.get_call_stack())
+    if i == len(data):
+        subsets.append(subset.copy())
+        return
+    subset.append(data[i])
+    get_subsets(subsets, data, i+1, subset) #    do include data[i]
+    subset.pop()
+    get_subsets(subsets, data, i+1, subset) # don't include data[i]
+    mg.block(mg.show, mg.get_call_stack())
+
+def power_set(data):
+    subsets = []
+    get_subsets(subsets, data, 0, [])
+    return subsets
+
+print( power_set(['a', 'b', 'c']) )
+```
+
+![power_set.gif](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/power_set.gif)
+```
+[['a', 'b', 'c'], ['a', 'b'], ['a', 'c'], ['a'], ['b', 'c'], ['b'], ['c'], []]
+```
 
-### Call Stack in Watchpoint Context ###
-The ```memory_graph.get_call_stack()``` doesn't work well in a watchpoint context in most debuggers because debuggers introduce additional stack frames that cause problems. Use these alternative functions for various debuggers to filter out these problematic stack frames:
+
+## Debugging ##
+
+For the best debugging experience with memory_graph set for example expression:
+```
+mg.render(locals(), "my_graph.pdf")
+```
+as a *watch* in a debugger tool such as the integrated debugger in Visual Studio Code. Then open the "my_graph.pdf" output file to continuously see all the local variables while debugging. This avoids having to add any memory_graph `show()`, `render()` calls to your code.
+
+### Call Stack in Watch Context ###
+The ```mg.get_call_stack()``` doesn't work well in *watch* context in most debuggers because debuggers introduce additional stack frames that cause problems. Use these alternative functions for various debuggers to filter out these problematic stack frames:
 
 | debugger | function to get the call stack |
 |:---|:---|
-| **pdb, pudb** | `memory_graph.get_call_stack_pdb()` |
-| **Visual Studio Code** | `memory_graph.get_call_stack_vscode()` |
-| **Pycharm** | `memory_graph.get_call_stack_pycharm()` |
+| **pdb, pudb** | `mg.get_call_stack_pdb()` |
+| **Visual Studio Code** | `mg.get_call_stack_vscode()` |
+| **Pycharm** | `mg.get_call_stack_pycharm()` |
 
 #### Other Debuggers ####
-For other debuggers, invoke this function within the watchpoint context. Then, in the "call_stack.txt" file, identify the slice of functions you wish to include in the call stack, more specifically choise 'after' and 'up_to' what function you want to slice.
+For other debuggers, invoke this function within the *watch* context. Then, in the "call_stack.txt" file, identify the slice of functions you wish to include in the call stack.
 ```
-memory_graph.save_call_stack("call_stack.txt")
+mg.save_call_stack("call_stack.txt")
 ```
-and then call this function to get the desired call stack to show in the graph:
+Choose 'after' and 'up_to' what function you want to slice and then call this function to get the desired call stack:
 ```
-memory_graph.get_call_stack_after_up_to(after_function, up_to_function="<module>")
+mg.get_call_stack_after_up_to(after_function, up_to_function="<module>")
 ```
 
+### Debugging without Debugger Tool ###
+
+To simplify debugging without a debugger tool, we offer these blocking alias functions that you can insert into your code at a specific point to visualize a graph:
+
+| alias | purpose | function call |
+|:---|:---|:---|
+| `mg.l()` | graph **l**ocal variables | `mg.block(mg.show, locals())` |
+| `mg.s()` | graph the call **s**tack | `mg.block(mg.show, mg.get_call_stack())` |
+
+For example, executing this program:
 
-## 4. Datastructure Examples ##
+```python
+from memory_graph as mg
+
+squares = []
+squares_collector = []
+for i in range(1, 6):
+    squares.append(i**2)
+    squares_collector.append(squares.copy())
+    mg.l() # graph local variables
+```
+and pressing &lt;Enter&gt; a number of times, results in:
+
+![debugging.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/debugging.gif)
+
+## Datastructure Examples ##
 Module memory_graph can be very useful in a course about datastructures, some examples:
 
 ### Doubly Linked List ###
 ```python
-import memory_graph
+import memory_graph as mg
 import random
 random.seed(0) # use same random numbers each run
 
@@ -362,7 +387,7 @@ class LinkedList:
             new_node.next = self.head
             self.head.prev = new_node
             self.head = new_node
-        memory_graph.d() # <--- draw graph
+        mg.block(mg.show, locals()) # <--- draw graph
 
 linked_list = LinkedList()
 n = 100
@@ -374,7 +399,7 @@ for i in range(n):
 
 ### Binary Tree ###
 ```python
-import memory_graph
+import memory_graph as mg
 import random
 random.seed(0) # use same random numbers each run
 
@@ -401,7 +426,7 @@ class BinTree:
                 node.larger = Node(new_value)
             else:
                 self.add_recursive(new_value, node.larger)
-        memory_graph.d() # <--- draw graph
+        mg.block(mg.show, locals()) # <--- draw graph
 
     def add(self, value):
         if self.root is None:
@@ -419,7 +444,7 @@ for i in range(n):
 
 ### Hash Set ###
 ```python
-import memory_graph
+import memory_graph as mg
 import random
 random.seed(0) # use same random numbers each run
 
@@ -434,7 +459,7 @@ class HashSet:
             self.buckets[index] = []
         bucket = self.buckets[index]
         bucket.append(value)
-        memory_graph.d() # <--- draw graph
+        mg.block(mg.show, locals()) # <--- draw graph
 
     def contains(self, value):
         index = hash(value) % len(self.buckets)
@@ -456,44 +481,44 @@ for i in range(n):
 ![hash_set.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/hash_set.png)
 
 
-## 5. Configuration ##
+## Configuration ##
 Different aspects of memory_graph can be configured. The default configuration is reset by importing 'memory_graph.config_default'.
 
-- ***memory_graph.config.max_number_nodes*** : int
-  - The maxium number of Nodes shown in the graph. When the graph gets too big set this to a smaller number. A `★` symbol indictes where the graph is cut short.
+- ***mg.config.max_tree_depth*** : int
+  - The maxium depth of the graph. A `★` symbol indictes where the graph is cut short.
 
-- ***memory_graph.config.max_string_length*** : int
+- ***mg.config.max_string_length*** : int
   - The maximum length of strings shown in the graph. Longer strings will be truncated.
 
-- ***memory_graph.config.not_node_types*** : set
+- ***mg.config.not_node_types*** : set
   - Holds all types for which no seperate node is drawn but that instead are shown as elements in their parent Node.
 
-- ***memory_graph.config.no_child_references_types*** : set
+- ***mg.config.no_child_references_types*** : set
   - The set of key_value types that don't draw references to their direct childeren but have their children shown as elements of their node.
 
-- ***memory_graph.config.type_to_node*** : dict
+- ***mg.config.type_to_node*** : dict
   - Determines how a data types is converted to a Node (sub)class for visualization in the graph.
 
-- ***memory_graph.config.type_to_color*** : dict
+- ***mg.config.type_to_color*** : dict
   - Maps each type to the [graphviz color](https://graphviz.org/doc/info/colors.html) it gets in the graph. 
 
-- ***memory_graph.config.type_to_vertical_orientation*** : dict
+- ***mg.config.type_to_vertical_orientation*** : dict
   - Maps each type to its orientation. Use 'True' for vertical and 'False' for horizontal. If not specified Node_Linear and Node_Key_Value are vertical unless they have references to children.
 
-- ***memory_graph.config.type_to_slicer*** : dict
+- ***mg.config.type_to_slicer*** : dict
   - Maps each type to a Slicer. A slicer determines how many elements of a data type are shown in the graph to prevent the graph from getting too big. 'Slicer()' does no slicing, 'Slicer(1,2,3)' shows just 1 element at the beginning, 2 in the middle, and 3 at the end.
 
 ### Temporary Configuration ###
-In addition to the global configuration, a temporary configuration can be set for a single `show()`, `render()`, or `d()` call to change the colors, orientation, and slicer. This example highlights a particular list element in red, gives it a horizontal orientation, and overwrites the default slicer for lists:
+In addition to the global configuration, a temporary configuration can be set for a single `show()`, `render()`, `d()`, `ds()` call to change the colors, orientation, and slicer. This example highlights a particular list element in red, gives it a horizontal orientation, and overwrites the default slicer for lists:
 
 ```python
-import memory_graph
-from memory_graph.Slicer import Slicer
+import memory_graph as mg
+from memory_graph.slicer import Slicer
 
 data = [ list(range(20)) for i in range(1,5)]
 highlight = data[2]
 
-memory_graph.show( locals(),
+mg.show( locals(),
     colors                = {id(highlight): "red"   }, # set color to "red"
     vertical_orientations = {id(highlight): False   }, # set horizontal orientation
     slicers               = {id(highlight): Slicer()}  # set no slicing 
@@ -501,14 +526,14 @@ memory_graph.show( locals(),
 ```
 ![highlight.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/highlight.png)
 
-## 6. Extensions ##
+## Extensions ##
 Different extensions are available for types from other Python packages. 
 
 ### Numpy ###
-Numpy types `arrray` and `matrix` and `ndarray` can be graphed with the "memory_graph.extension_numpy" extension:
+Numpy types `arrray` and `matrix` and `ndarray` can be graphed with "memory_graph.extension_numpy":
 
 ```python
-import memory_graph
+import memory_graph as mg
 import numpy as np
 import memory_graph.extension_numpy
 np.random.seed(0) # use same random numbers each run
@@ -516,15 +541,15 @@ np.random.seed(0) # use same random numbers each run
 array = np.array([1.1, 2, 3, 4, 5])
 matrix = np.matrix([[i*20+j for j in range(20)] for i in range(20)])
 ndarray = np.random.rand(20,20)
-memory_graph.d()
+mg.show(locals())
 ```
 ![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/extension_numpy.png)
 
 ### Pandas ###
-Pandas types `Series` and `DataFrame` can be graphed with the "memory_graph.extension_pandas" extension:
+Pandas types `Series` and `DataFrame` can be graphed with "memory_graph.extension_pandas":
 
 ```python
-import memory_graph
+import memory_graph as mg
 import pandas as pd
 import memory_graph.extension_pandas
 
@@ -535,21 +560,20 @@ dataframe2 = pd.DataFrame({  'Name'   : [ 'Tom', 'Anna', 'Steve', 'Lisa'],
                              'Age'    : [    28,     34,      29,     42],
                              'Length' : [  1.70,   1.66,    1.82,   1.73] },
                             index=['one', 'two', 'three', 'four']) # with row names
-memory_graph.d()
+mg.show(locals())
 ```
 ![extension_pandas.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/extension_pandas.png)
 
-## 7. Jupyter Notebook ##
+## Jupyter Notebook ##
 
-In Jupyter Notebook `locals()` has additional variables that cause problems in the graph, use `memory_graph.locals_jupyter()` to get the local variables with these problematic variables filtered out. Use `memory_graph.get_call_stack_jupyter()` to get the whole call stack with these variables filtered out. 
+In Jupyter Notebook `locals()` has additional variables that cause problems in the graph, use `mg.locals_jupyter()` to get the local variables with these problematic variables filtered out. Use `mg.get_call_stack_jupyter()` to get the whole call stack with these variables filtered out. 
 
 See for example [jupyter_example.ipynb](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/jupyter_example.ipynb).
 ![jupyter_example.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/jupyter_example.png)
 
 
-## 8. Troubleshooting ##
+## Troubleshooting ##
 
-- Adobe Acrobat Reader [doesn't refresh a PDF file](https://superuser.com/questions/337011/windows-pdf-viewer-that-auto-refreshes-pdf-when-compiling-with-pdflatex) when it changes on disk and blocks updates which results in an `Could not open 'somefile.pdf' for writing : Permission denied` error. One solution is to install a PDF reader that does refresh ([Evince](https://www.fosshub.com/Evince.html) for example) and set it as the default PDF reader. Another solution is to `render()` the graph to a different output format and open it manually.
+- Adobe Acrobat Reader [doesn't refresh a PDF file](https://superuser.com/questions/337011/windows-pdf-viewer-that-auto-refreshes-pdf-when-compiling-with-pdflatex) when it changes on disk and blocks updates which results in an `Could not open 'somefile.pdf' for writing : Permission denied` error. One solution is to install a PDF reader that does refresh ([Evince](https://www.fosshub.com/Evince.html), [Okular](https://okular.kde.org/), [SumatraPDF](https://www.sumatrapdfreader.org/), ...) and set it as the default PDF reader. Another solution is to `render()` the graph to a different output format and to open it manually.
 
 - When graph edges overlap it can be hard to distinguish them. Using an interactive graphviz viewer, such as [xdot](https://github.com/jrfonseca/xdot.py), on a '*.gv' DOT output file will help.
-