Skip to content

bpy_jupyter

A Blender extension fusing the flexibility of notebook-based data-viz, with the visual appeal of modern computer graphics software.

Documentation: https://sorose-bpy-jupyter.pgs.sh/

  • NOTE: The documentation link may change in the future. Stay tuned!

Source Code: https://github.com/Octoframes/bpy_jupyter

Warning

bpy_jupyter has reached a state of tentative usability, and should be considered beta software aka. still unstable.

  • The UI/UX may have unsolved frustrations and confusions.
  • The documentation may be incomplete or unwritten.
  • Tests, if they exist, have no guarantees of coverage or passing.

We already personally find the main branch of bpy_jupyter quite useful, and we invite you to give it a try. Above all else, please be patient with us at this early stage.

Highlights

  • Blender 💗 Jupyter: Jupyter is fantastic at reproducibly mangling data. Blender is fantastic at visualization. It's a perfect match!
  • Minimalistic: This extension does one thing well: Manages a Jupyter kernel embedded in Blender. No bundled client, no opionionated servers, just a kernel!
  • Ready to Use: Confused what exactly to do? We've written extensive user guides to help you achieve compelling results.
  • 🌐 Respects your Freedoms: bpy_jupyter preserves your freedom to use, modify, fork, redistribute, or even sell bpy_jupyter, so long as you extend the same freedoms as you were granted under the AGPL software license. For more details, see our License Policy.

Ready to give it a try? See Installation, then Getting Started.

Warning

The documentation of bpy_jupyter is still a work in progress.

Showcases

  • BCon24 Demonstration: This popular talk provides a glimpse of what's possible with this workflow.
  • bpy Gallery: A gallery of examples of how to leverage this workflow, including code.

Info

Doing something cool with bpy_jupyter?

Tell us about it, and might add it to this list!

Acknowledgements

The authors hope that you find this software useful.

This project would not be possible without the entire Blender community, across forums, DevTalk, Matrix chats, and so much more.

Credit to Jan Hendrik Müller for inspiring and making this project happen. Please go watch his BCon24 talk!

Thanks to the Jupyter server team, who let us present an early demo of bpy_jupyter at their meeting, and provided some great feedback.

Finally, please peruse our uv tree of dependencies. We stand on the shoulders of giants, and could not hope to see so far without.