Skip to content

Commit 97ef4a8

Browse files
committed
update readme
1 parent 687b6d5 commit 97ef4a8

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,37 @@ Clone the repo locally:
4646
git clone https://{YOUR_GITHUB_TOKEN}@github.com/IBM/mimicri.git
4747
```
4848

49+
Navigate to your local cloned mimicri folder and install dependencies:
50+
51+
```
52+
pip install -r requirements.txt
53+
54+
pip install mimicri
55+
```
56+
57+
The package should show up when you run:
58+
59+
```
60+
jupyter labextension list
61+
```
62+
63+
### Developer Installation
64+
65+
Use this installation *only* if you are making changes to the MiMICRI widget. If you are using MiMICRI as-is, the regular install (above) will be sufficient.
66+
67+
Create a clean conda environment with the exact versions of the following packages:
68+
69+
```
70+
conda create -n mimicri python=3.8 jupyterlab=3.4 ipywidgets=7.6 ipykernel=5.3
71+
72+
conda activate mimicri
73+
```
74+
75+
Clone the repo locally:
76+
```
77+
git clone https://{YOUR_GITHUB_TOKEN}@github.com/IBM/mimicri.git
78+
```
79+
4980
Navigate to your local cloned mimicri folder and install other dependencies: `pip install -r requirements.txt`.
5081

5182
Ensure that the [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable) package manager has been installed.
@@ -59,6 +90,8 @@ The package should show up when you run:
5990
jupyter labextension list
6091
```
6192

93+
After making updates to the widget, your changes will be reflected by running `sh ./update.sh`
94+
6295
### Data Files and Running Demo Notebooks
6396

6497
We provide the notebook (`notebooks/mimicri_demo.ipynb`) to demonstrate usage of the MiMICRI modules end-to-end.

0 commit comments

Comments
 (0)