Skip to content

Commit 89c8872

Browse files
committed
update docs
1 parent 649d546 commit 89c8872

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

docs/contents.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,16 @@ Alternatively, you can also use pip:
2929
pip install rdkit mols2grid
3030
```
3131

32-
To use it in **Jupyter Lab**, you must also install the extension:
33-
```shell
34-
jupyter labextension install mols2grid
35-
```
32+
If you notice that the selections, callbacks and interactive filtering aren't working as intended, you may have to manually activate the extension:
33+
- for Jupyter Lab: `jupyter labextension install mols2grid`
34+
- for Jupyter Notebook: `jupyter nbextension install mols2grid`
3635

3736
**Compatibility**
3837

3938
mols2grid is mainly meant to be used in notebooks (Jupyter notebooks, Jupyter Lab, and Google Colab) but it can also be used as a standalone HTML page opened with your favorite web browser, or embedded in a Streamlit app.
4039

4140
Since Streamlit doesn't seem to support ipywidgets yet, some features aren't functional: retrieving the selection from Python (you can still export it from the GUI) and using Python callbacks.
4241

43-
Note that running notebooks in VSCode lacks support for filtering based on other widgets (see the `filtering` example notebook).
44-
4542
<img alt="knime logo" align="left" style="padding:6px" src="https://www.knime.com/sites/default/files/favicons/favicon-32x32.png"/>
4643
<p>You can also use mols2grid directly in <a href="https://www.knime.com/">KNIME</a>, by looking for the `Interactive Grid of Molecules` component on the Knime HUB.<br/>
4744
Make sure you have setup <a href="https://docs.knime.com/latest/python_installation_guide">Knime's Python integration</a> for the node to work.</p>

docs/notebooks/filtering.ipynb

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@
88
"\n",
99
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/cbouy/mols2grid/blob/master/docs/notebooks/filtering.ipynb)\n",
1010
"\n",
11-
"It's possible to integrate the grid with other widgets to complement the searchbar.\n",
12-
"\n",
13-
"**Note that this will not work when running the notebook in VSCode!**"
11+
"It's possible to integrate the grid with other widgets to complement the searchbar."
1412
]
1513
},
1614
{
@@ -90,14 +88,18 @@
9088
"\n",
9189
"view"
9290
]
91+
},
92+
{
93+
"cell_type": "code",
94+
"execution_count": null,
95+
"metadata": {},
96+
"outputs": [],
97+
"source": []
9398
}
9499
],
95100
"metadata": {
96-
"interpreter": {
97-
"hash": "634da3a3bbf8fbf1ddb65b0056d578c92f3c569db0da492ea274ae9d304e5b24"
98-
},
99101
"kernelspec": {
100-
"display_name": "Python 3.8.6 ('molgrid')",
102+
"display_name": "Python 3.8.12 ('molgrid')",
101103
"language": "python",
102104
"name": "python3"
103105
},
@@ -113,7 +115,12 @@
113115
"pygments_lexer": "ipython3",
114116
"version": "3.8.12"
115117
},
116-
"orig_nbformat": 4
118+
"orig_nbformat": 4,
119+
"vscode": {
120+
"interpreter": {
121+
"hash": "634da3a3bbf8fbf1ddb65b0056d578c92f3c569db0da492ea274ae9d304e5b24"
122+
}
123+
}
117124
},
118125
"nbformat": 4,
119126
"nbformat_minor": 2

0 commit comments

Comments
 (0)