|
9 | 9 |  |
10 | 10 |  |
11 | 11 |
|
12 | | -➡️ A readable walkthrough of how to use the package together with some useful examples can be found in [this blog post](https://www.wmccorkindale.com/post/introducing-molplotly) while a runnable notebook can be found in `examples/example.ipynb` :) |
| 12 | +A readable walkthrough of how to use the package together with some useful examples can be found in [this blog post](https://www.wmccorkindale.com/post/introducing-molplotly) while a runnable notebook can be found in `examples/simple_usage_and_formatting.ipynb` :) |
13 | 13 |
|
14 | | -## ⬇️ Installation |
| 14 | +## Installation |
15 | 15 |
|
16 | 16 | ```sh |
17 | 17 | pip install molplotly |
18 | 18 | conda install rdkit |
19 | 19 | ``` |
20 | 20 |
|
21 | | -## 📜 Usage |
| 21 | +## Usage |
22 | 22 |
|
23 | 23 | ```python |
24 | 24 | import pandas as pd |
@@ -93,20 +93,20 @@ by default a JupyterDash `app` is returned which can be run inline in a jupyter |
93 | 93 | - The recommended `height` of the app is `50+(height of the plotly figure)`. |
94 | 94 | - For the `port` of the app, make sure you don't pick the same `port` as another `molplotly` plot otherwise the tooltips will clash with each other. Also, apparently on windows port numbers below `8700` are used by other processes so for safety processes keep to numbers above that. |
95 | 95 |
|
96 | | -## 💻 Can I run this in colab? |
| 96 | +## Can I run this in colab? |
97 | 97 |
|
98 | 98 | JupyterDash is supposed to have support for Google Colab but at some point that seems to have broken.. Keep an eye on the raised issue [here](https://github.com/plotly/jupyter-dash/issues/10)! |
99 | 99 | Update (1st March 2022): The plots seem to be running again but the hoverboxes are not showing so I don't think it has been fully fixed - I will keep an eye on it in the meantime. |
100 | 100 |
|
101 | | -## 💾 Can I save these plots? |
| 101 | +## Can I save these plots? |
102 | 102 |
|
103 | 103 | An issue/feature request for this has already been raised [here](https://github.com/wjm41/molplotly/issues/4). |
104 | 104 |
|
105 | 105 | `moltplotly` works using a Dash app which is non-trivial to export because server side javascript is needed in addition to HTML/CSS styling ([as detailed here](https://stackoverflow.com/questions/60097577/how-to-export-a-plotly-dashboard-app-into-a-html-standalone-file-to-share-with-t)) |
106 | 106 |
|
107 | 107 | Until I find a way to get around that, the best alternative is to either host the plot on an app/server, exporting the plotly figure without molecules showing :( as detailed in this [page](https://plotly.com/python/interactive-html-export/). If you want to use it in a presentation I'd suggest keeping the figure open in a browser and changing windows to it during your talk! |
108 | 108 |
|
109 | | -## 🛑 Warning about memory size |
| 109 | +## Warning about memory size |
110 | 110 |
|
111 | 111 | Just adding a warning here that memory usage in a notebook can increase significanly when using plotly (not `molplotly`'s fault!). If you notice your jupyter notebook slowing down, plotly itself is a likely culprit... In that case I'd consider either using plotly with [static image rendering](https://plotly.com/python/renderers/#static-image-renderers), or ... use [seaborn](https://seaborn.pydata.org/index.html) :P |
112 | 112 |
|
|
0 commit comments