Skip to content

Commit b4f5d6a

Browse files
Instructions to install from pip and github (#451)
* instructions to install from pip and github * improve guidance for difference installation types
1 parent b961264 commit b4f5d6a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,17 +201,17 @@ conda create -y -n waveorder python=3.12
201201
conda activate waveorder
202202
```
203203

204-
Install `waveorder` from PyPI:
204+
(Option 1) If you are familiar with `waveorder`'s API and want to use it as a library, install a stable version of `waveorder` from PyPI:
205205

206206
```sh
207207
pip install waveorder
208208
```
209209

210-
(Optional) Install all visualization dependencies (napari, jupyter), clone the repository, and run an example script:
210+
(Option 2) If you are new to `waveorder` and want to run demos to become familiar with its features, install the latest version of `waveorder` from GitHub with all visualization dependencies (napari, jupyter), clone the repository, and run an example script:
211211
```sh
212-
pip install "waveorder[all]"
212+
pip install "git+https://github.com/mehta-lab/waveorder.git@main#egg=waveorder[all]"
213213
git clone https://github.com/mehta-lab/waveorder.git
214-
python waveorder/examples/models/phase_thick_3d.py
214+
python waveorder/docs/examples/models/phase_thick_3d.py
215215
```
216216

217217
(M1 users) `pytorch` has [incomplete GPU support](https://github.com/pytorch/pytorch/issues/77764),

0 commit comments

Comments
 (0)