Skip to content

Commit 385aced

Browse files
authored
Update README.md (#532)
1 parent a8bc4ee commit 385aced

File tree

1 file changed

+13
-26
lines changed

1 file changed

+13
-26
lines changed

README.md

Lines changed: 13 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
[**Examples**](https://github.com/kushalkolar/fastplotlib#examples) |
1515
[**Contributing**](https://github.com/kushalkolar/fastplotlib#heart-contributing)
1616

17-
Next-gen plotting library built using the [`pygfx`](https://github.com/pygfx/pygfx) rendering engine that can utilize [Vulkan](https://en.wikipedia.org/wiki/Vulkan), [DX12](https://en.wikipedia.org/wiki/DirectX#DirectX_12), or [Metal](https://developer.apple.com/metal/) via WGPU, so it is very fast! `fastplotlib` also aims to be an expressive plotting library that enables rapid prototyping for large scale explorative scientific visualization.
17+
Next-gen plotting library built using the [`pygfx`](https://github.com/pygfx/pygfx) rendering engine that can utilize [Vulkan](https://en.wikipedia.org/wiki/Vulkan), [DX12](https://en.wikipedia.org/wiki/DirectX#DirectX_12), or [Metal](https://developer.apple.com/metal/) via WGPU, so it is very fast! `fastplotlib` is an expressive plotting library that enables rapid prototyping for large scale explorative scientific visualization.
1818

1919
![scipy-fpl](https://github.com/fastplotlib/fastplotlib/assets/9403332/b981a54c-05f9-443f-a8e4-52cd01cd802a)
2020

@@ -41,17 +41,15 @@ concepts are similar to those from the API shown in the video.
4141

4242
> **Note**
4343
>
44-
> `fastplotlib` is currently in the **alpha stage with breaking changes every ~month**, but you're welcome to try it out or contribute! See our [Roadmap](https://github.com/kushalkolar/fastplotlib/issues/55). See this for a discussion on API stability: https://github.com/fastplotlib/fastplotlib/issues/121
44+
> `fastplotlib` is currently in the **late alpha stage**, but you're welcome to try it out or contribute! See our [Roadmap](https://github.com/kushalkolar/fastplotlib/issues/55). See this for a discussion on API stability: https://github.com/fastplotlib/fastplotlib/issues/121
4545
4646
# Documentation
4747

4848
http://fastplotlib.readthedocs.io/
4949

50-
The Quickstart guide is not interactive. We recommend cloning/downloading the repo and trying out the `desktop` or `notebook` examples: https://github.com/kushalkolar/fastplotlib/tree/main/examples
50+
The examples are interactive if you run them locally on your computer. If someone wants to integrate `pyodide` with `pygfx` we would be able to have live interactive examples on the website!
5151

52-
If someone wants to integrate `pyodide` with `pygfx` we would be able to have live interactive examples! :smiley:
53-
54-
Questions, issues, ideas? Post an [issue](https://github.com/fastplotlib/fastplotlib/issues) or post on the [discussion forum](https://github.com/fastplotlib/fastplotlib/discussions)!
52+
Questions, issues, ideas? You are welcome to post an [issue](https://github.com/fastplotlib/fastplotlib/issues) or post on the [discussion forum](https://github.com/fastplotlib/fastplotlib/discussions)! :smiley:
5553

5654
# Installation
5755

@@ -87,51 +85,40 @@ cd fastplotlib
8785

8886
# install all extras in place
8987
pip install -e ".[notebook,docs,tests]"
88+
89+
# install latest pygfx
90+
pip install git+https://github.com/pygfx/pygfx.git@main
9091
```
9192

9293
Se [Contributing](https://github.com/fastplotlib/fastplotlib?tab=readme-ov-file#heart-contributing) for more details on development
9394

9495
# Examples
9596

97+
Examples gallery: https://fastplotlib.readthedocs.io/en/latest/_gallery/index.html
98+
9699
> **Note:** `fastplotlib` and `pygfx` are fast evolving, you will probably require the latest `pygfx` and `fastplotlib` from github to use the examples in the main branch.
97100
98101
`fastplotlib` code is identical across notebook (`jupyter`), and desktop use with `Qt`/`PySide` or `glfw`.
99102

100-
Even if you do not intend to use notebooks with `fastplotlib`, the `quickstart.ipynb` notebook is currently the best way to get familiar with the API: https://github.com/fastplotlib/fastplotlib/tree/main/examples/notebooks/quickstart.ipynb
103+
Even if you do not intend to use notebooks with `fastplotlib`, the `quickstart.ipynb` tutorial notebook is the best way to get familiar with the API: https://github.com/fastplotlib/fastplotlib/tree/main/examples/notebooks/quickstart.ipynb
101104

102105
The specifics for running `fastplotlib` in different GUI frameworks are:
103106
- Running in `glfw` requires a `fastplotlib.run()` call (which is really just a `wgpu` `run()` call)
104107
- With `Qt` you can encapsulate it within a `QApplication`, see `examples/qt`
105108
- Notebooks plots have ipywidget-based toolbars and widgets. There are plans to move toward an identical in-canvas toolbar with UI elements across all supported frameworks 😄
106109

107-
### Desktop examples using `glfw` or `Qt`
110+
### Embedding in a `Qt` app
108111

109-
GLFW examples are here. GLFW is a "minimal" desktop framework.
110-
111-
https://github.com/fastplotlib/fastplotlib/tree/main/examples/desktop
112-
113-
Qt examples are here:
112+
See these for examples on embedding within a Qt app. Note that you can also use `fastplotlib` with qt interactively using `%gui qt` in jupyter or ipython.
114113

115114
https://github.com/fastplotlib/fastplotlib/tree/main/examples/qt
116115

117-
Some of the examples require imageio:
118-
```
119-
pip install imageio
120-
```
121-
122116
### Notebook examples
123117

124-
Notebook examples are here:
118+
Notebook examples are here, these include examples on selector tools.
125119

126120
https://github.com/fastplotlib/fastplotlib/tree/main/examples/notebooks
127121

128-
**Start with `quickstart.ipynb`.**
129-
130-
Some of the examples require imageio:
131-
```
132-
pip install imageio
133-
```
134-
135122
### Video
136123

137124
Our SciPy 2023 talk walks through numerous demos: https://github.com/fastplotlib/fastplotlib#scipy-talk

0 commit comments

Comments
 (0)