← 返回首页
add user guide by clewis7 · Pull Request #513 · fastplotlib/fastplotlib · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
Resetting focus

add user guide#513

Merged
kushalkolar merged 10 commits into
mainfrom
guide
Jun 22, 2024
Merged

add user guide#513
kushalkolar merged 10 commits into
mainfrom
guide

Conversation

clewis7 commented Jun 7, 2024

Copy link
Copy Markdown
Member

based on graphic features refactor

closes #510

Comment thread docs/source/user_guide/guide.rst Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

are these auto-generated?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

no, pygfx had them as static images stored in their docs so I did the same

Copy link
Copy Markdown
Member

A section on the spaces would be very useful. There exists world space, data space (which is basically world space + offset and rotation), and screen space. There's a help func to map from screen space to world space that's useful for interacting with graphics.

Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved

Copy link
Copy Markdown
Member

A section on using it interactively would be very useful, similar what's on wgpu docs: https://wgpu-py.readthedocs.io/en/stable/gui.html#using-wgpu-interactively

basically:

  • in jupyter
    • if nothing special is done, uses remote frame buffer, display in cell output or side
    • %gui qt before importing fastplotlib will use qt
    • Figure(canvas="glfw") should force glfw
    • Do not mix or switch between gui backends, ex. if you want to use qt use %gui qt at the start of the notebook, and then do not try to force another backend such as jupyter_rfb (remote frame buffeR)
  • in ipython
    • can use qt or glfw, same was as above

Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Show resolved Hide resolved
7 hidden conversations Load more…
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Comment thread docs/source/conf.py
"python": ("https://docs.python.org/3", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"pygfx": ("https://pygfx.com/latest", None),
"pygfx": ("https://pygfx.com/stable", None),

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

we should link to latest

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

before when I had it at latest it failed to build

Comment thread docs/source/user_guide/guide.rst Show resolved Hide resolved
Comment thread docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
clewis7 and others added 2 commits June 22, 2024 11:33
Co-authored-by: Kushal Kolar <kushalkolar@gmail.com>
kushalkolar marked this pull request as ready for review June 22, 2024 16:38

kushalkolar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

yay

Copy link
Copy Markdown
Member

I'm going to merge but those warnings and images have to be fixed.

kushalkolar merged commit d0b8bb1 into main Jun 22, 2024
kushalkolar deleted the guide branch July 1, 2024 20:55
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add "Guide" to docs

2 participants

Footer

© 2026 GitHub, Inc.