Add KNOWN_ISSUES.md

- Reference KNOWN_ISSUES.md in README.md
- Minor formatting changes

KNOWN_ISSUES.md

@@ -0,0 +1,23 @@
+# Known Issues
+
+## [Matplotlib issue on Mac when using (Ana)conda](issue26)
+#### Platform:
+(Ana)conda/macOS
+
+#### Steps to reproduce:
+1. `python virtualscanner/coms/coms_ui/coms_server_flask.py`
+
+#### Expected behaviour:
+The Virtual Scanner browser app is functional on the browser at the localhost
+address.
+
+#### Observed behaviour:
+> ImportError: Python is not installed as a framework. The Mac OS X backend will not be able to function correctly if Python is not installed as a framework. See the Python documentation for more information on installing Python as a framework on Mac OS X. Please either reinstall Python as a framework, or try one of the other backends. If you are using (Ana)Conda please install python.app and replace the use of 'python' with 'pythonw'. See 'Working with Matplotlib on OSX' in the Matplotlib FAQ for more information.
+
+#### Fix:
+1. `echo "backend: TkAgg" >> ~/.matplotlib/matplotlibrc`
+
+#### Notes:
+https://github.com/scikit-optimize/scikit-optimize/issues/637#issuecomment-369730420
+
+[issue26]: https://github.com/imr-framework/virtual-scanner/issues/26

README.md

@@ -1,6 +1,6 @@
 <p align="center"> <a>
-    <img title="Virtual Scanner Logo" src="https://github.com/imr-framework/imr-framework.github.io/blob/master/img/portfolio/virtual-scanner.png" width="225">
-  </a></p>
+<img title="Virtual Scanner Logo" src="https://github.com/imr-framework/imr-framework.github.io/blob/master/img/portfolio/virtual-scanner.png" width="225">
+</a></p>
 <h1 align="center"> Virtual Scanner </h1> <br>
 
 Virtual Scanner is an end-to-end hybrid Magnetic Resonance Imaging (MRI) simulator/console designed to be zero-footprint, modular, and supported by open-source standards.
@@ -38,10 +38,11 @@ Alternatively, you can read the API documentation [here](https://imr-framework.g
 * The **Analyze** page allows the user to load a series of data acquired in ISMRM/NIST phantom for T1 or T2 mapping and conduct curve fitting to obtain T1 and T2 maps. In addition, it can detect spheres in the phantom, a feature useful for comparing generated parameter values to literature values.
 
 ## Advanced Mode
-* The **Tx** (RF transmit) page allows one to calculate and plot SAR from pulseq .seq files.
-*This feature is under development.*
+* The **Tx** (RF transmit) page allows one to calculate and plot SAR from pulseq .seq files. *This feature is under development.*
 
-* The **Rx** (RF receive) page allows one to visualize time-domain MR signal, generated from an arbitrary grayscale image, and see the effects of using different demodulation frequencies and ADC sampling rate.
-*This feature is under development.*
+* The **Rx** (RF receive) page allows one to visualize time-domain MR signal, generated from an arbitrary grayscale image, and see the effects of using different demodulation frequencies and ADC sampling rate. *This feature is under development.*
 
 * Other features, including phantom and sequence viewers and reconstruction methods, are in active development.
+
+## Known Issues
+Please refer to the [Known Issues]() document.