Skip to content

Commit 7301e67

Browse files
authored
Merge pull request #304 from ianhi/install-instructions
update dev install instructions for jlab3
2 parents 3ac75f2 + 2cc8d55 commit 7301e67

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -78,27 +78,43 @@ Versions lookup table:
7878

7979
### For a development installation (requires nodejs):
8080

81+
Create a dev environment that has nodejs installed. The instructions here use
82+
[mamba](https://github.com/mamba-org/mamba#the-fast-cross-platform-package-manager) but you
83+
can also use conda.
84+
85+
```bash
86+
mamba env create --file dev-environment.yml
87+
conda activate ipympl-dev
88+
```
89+
90+
Install the Python Packge
8191
```bash
82-
git clone https://github.com/matplotlib/ipympl.git
83-
cd ipympl
8492
pip install -e .
93+
```
94+
95+
When developing your extensions, you need to manually enable your extensions with the
96+
notebook / lab frontend. For lab, this is done by the command:
8597

86-
# If using classic Jupyter Notebook
98+
```bash
99+
jupyter labextension develop --overwrite .
100+
npm run build
101+
```
102+
103+
For classic notebook, you need to run:
104+
```bash
87105
jupyter nbextension install --py --symlink --sys-prefix ipympl
88106
jupyter nbextension enable --py --sys-prefix ipympl
89-
90-
# If using JupyterLab
91-
jupyter labextension install @jupyter-widgets/jupyterlab-manager --no-build
92-
jupyter labextension install ./js
93107
```
94108

95109
#### How to see your changes
110+
96111
**Javascript**:
97112

98-
To continuously monitor the project for changes and automatically trigger a rebuild, start Jupyter in watch mode:
113+
You need to rebuild the JS when you make a code change:
99114

100115
```bash
101-
jupyter lab --watch
116+
cd js
117+
yarn run watch
102118
```
103119

104120
After a change wait for the build to finish and then refresh your browser and the changes should take effect.

0 commit comments

Comments
 (0)