Skip to content

Commit

Permalink
Clean installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
talonchandler committed Dec 19, 2024
1 parent bf168fc commit 146cfca
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@ Please cite this repository, along with the relevant preprint or paper, if you u

## Installation

(Optional but recommended) install [anaconda](https://www.anaconda.com/products/distribution) and create a virtual environment:
Create a virtual environment:

```sh
conda create -y -n waveorder python=3.11
conda create -y -n waveorder python=3.10
conda activate waveorder
```

Expand All @@ -94,6 +94,13 @@ python
>>> import waveorder
```

(Optional) Install napari, clone the repository, and run an example script:
```sh
pip install napari[all]
git clone https://github.com/mehta-lab/waveorder.git
python waveorder/examples/models/phase_thick_3d.py
```

(Optional) Download the repository, install `jupyter`, and experiment with the example notebooks

```sh
Expand Down

0 comments on commit 146cfca

Please sign in to comment.