Skip to content

Commit acb8df4

Browse files
authored
Update README.md
1 parent 93e7614 commit acb8df4

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,28 @@ plot.add_animations([update_data])
4646
plot.show()
4747
```
4848

49-
5049
# Installation
5150

52-
Install directly from GitHub.
51+
`fastplotlib` is available as a `pip` package
52+
53+
```bash
54+
pip install fastplotlib
55+
```
56+
57+
Clone or download the repo to try the examples
58+
59+
```bash
60+
# clone the repo
61+
git clone https://github.com/kushalkolar/fastplotlib.git
62+
63+
# cd into examples and launch jupyter lab
64+
cd fastplotlib/examples
65+
jupyter lab
66+
```
67+
68+
You will need a GPU that supports Vulkan (iGPUs in CPUs should be fine). Generally if your GPU is from 2017 or later it should support Vulkan. See the section on "Install Vulkan drivers" below for more information.
69+
70+
### For Development
5371

5472
```bash
5573
git clone https://github.com/kushalkolar/fastplotlib.git
@@ -62,12 +80,7 @@ cd examples
6280
jupyter lab
6381
```
6482

65-
Don't install from PYPI, `fastplotlib` is in the alpha stage, the pip package is not regularly updated yet.
66-
67-
You will need a GPU that supports Vulkan (iGPUs in CPUs should be fine).
68-
Generally if your GPU is from 2017 or later it should support Vulkan.
69-
70-
## Install Vulkan drivers and other stuff
83+
## Install Vulkan drivers
7184

7285
For more information see: https://github.com/pygfx/wgpu-py#platform-requirements
7386

@@ -88,6 +101,8 @@ For other distros install the appropriate vulkan driver package.
88101
### Mac OSX:
89102
You will need at least MacOSX v10.13, not sure how to install Vulkan drivers on Mac. If anyone knows you can add instructions here!
90103

104+
# Gallery
105+
91106
### Extremely fast image updates, 5 x 5 gridplot
92107

93108
https://www.youtube.com/embed/-_0Gp_EqepI

0 commit comments

Comments
 (0)