Add notes on matplotlib backend on OSX. Also update gitignore.

nextstrain · Oct 11, 2017 · e8b2a21 · e8b2a21
1 parent 4c68a5d
commit e8b2a21
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -14,6 +14,13 @@ test_input/
 test_output/
 scratch/
 
+# For Python #
+##############
+*.pyc
+.tox/
+.cache/
+augur.egg-info/
+
 # Compiled source #
 ###################
 *.com
@@ -22,7 +29,6 @@ scratch/
 *.exe
 *.o
 *.so
-*.pyc
 
 # OS generated files #
 ######################

diff --git a/docs/README.md b/docs/README.md
@@ -41,3 +41,18 @@ the `-r` flag to force it to rebuild its environment.
 ```bash
 tox -r
 ```
+
+Note that on OS X, matplotlib may throw errors during testing stating
+
+```bash
+from matplotlib.backends import _macosx
+E   RuntimeError: Python is not installed as a framework.
+```
+
+This can be resolved by switching matplotlib backends. Create a file in the home directory `~/.matplotlib/matplotlibrc` and include the following:
+
+```python
+backend: TkAgg
+```
+
+This should fix the error.