Skip to content

Commit 8432e62

Browse files
author
wjm41
committed
Updated README.md
1 parent e2744c0 commit 8432e62

1 file changed

Lines changed: 6 additions & 9 deletions

File tree

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ app = molplotly.add_molecules(fig=fig,
4646
app.run_server(mode='inline', port=8011, height=1000)
4747
```
4848

49-
#### Input parameters
49+
### Input parameters
5050

5151
- `fig` : plotly.graph_objects.Figure object\
5252
a plotly figure object containing datapoints plotted from `df`.
@@ -88,26 +88,23 @@ app.run_server(mode='inline', port=8011, height=1000)
8888

8989
#### Output parameters
9090

91-
<!-- TODO update about port numbers -->
92-
9391
by default a JupyterDash `app` is returned which can be run inline in a jupyter notebook or deployed on a server via `app.run_server()`
9492

9593
- The recommended `height` of the app is `50+(height of the plotly figure)`.
96-
- 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!
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.
9795

9896
## 💻 &nbsp; Can I run this in colab?
9997

100-
<!-- TODO Update with fix -->
101-
102-
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)!
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+
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.
103100

104101
## 💾 &nbsp; Can I save these plots?
105102

106-
<!-- TODO Update & link to issue -->
103+
An issue/feature request for this has already been raised [here](https://github.com/wjm41/molplotly/issues/4).
107104

108105
`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))
109106

110-
Until I find a way to get around that, the best alternative is 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!
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!
111108

112109
## 🛑 &nbsp;Warning about memory size
113110

0 commit comments

Comments
 (0)