Make scripted visualizations in blender

Overview

Scripted visualizations in blender

The goal of this project is to script 3D scientific visualizations using blender.

To achieve this, we aim to bring together blender's powerful visualization toolkit with Anaconda's scientific computing and package management capabilities. For example, the code in ./apps/concepts/fourier_signal_composition.py was used to generate the following visualization.

Frequency sweep illustration

Getting Started

See the detailed setup instructions at the end of the file.

Contributing

This project is still a work in progress. Contributions and feedback are welcome!

Authors

License

Files in the directories apps and illustrations are copyright praneethnamburi.

The general purpose blender scripting code (bpn, pntools) is under the MIT license.

Acknowledgments

  • All the wonderful people that make open source software
  • Inspiration - 3blue1brown's videos and pedagogical clarity

Setup instructions

These are detailed instructions that worked for me on a windows 10 laptop.

blender+Anaconda+VSCode

  1. Download blender (get the zip file, NOT a binary installer), or just follow this link: https://builder.blender.org/download/
  2. Unzip to C:\blender\2.93.0 (which has a folder called 2.93)
  3. Open the python console within blender, and check the python version
    • e.g. 3.9.2
  4. Delete the python folder and all its contents (C:\blender\2.93.0\2.93\python)
  5. Install Anaconda (NOT miniconda), and open anaconda prompt with admin privileges
    • Make sure you have "C:\Users\Praneeth\anaconda3\condabin" in the system path
    • On windows, check the Path variable in the 'System Variables' box when editing environment variables
  6. Clone this repository, and the dependency to your workspace (make sure git is installed and added to your system path)
  7. Create an anaconda environment using the following commands:
    • Recommended method:
      • conda create -n blender293 python=3.9.2 numpy scipy pandas jupyter ipython matplotlib blinker scikit-learn
      • conda activate blender293
      • conda install -c conda-forge pybullet multiprocess pysimplegui
      • pip install decord imageio imageio-ffmpeg ffmpeg-python pytube ahrs urdfpy pint soundfile celluloid
    • Alternate method: Create an anaconda environment using the _requirements.yml file (simpler, but doesn't always work)
      • conda env update -f requirements.yml
      • Make sure to wait until it finishes running. It might appear stuck when installing pip packages. You might see a temporary text file created by conda in your current directory, for example "condaenv.p5qt3m3s.requirements.txt". Conda has finished doing its job when this file is deleted.
      • conda activate blender293
  8. Install VSCode and activate the environment from within VSCode's command line
  9. Call blender from the command line. The idea is to pass an extra argument while launching blender to set the path the python we want to use.
    • C:\blender\2.93.0\2.93\blender.exe --env-system-python "C:\Users\Praneeth\.conda\envs\blender293"
    • C:\blender\2.93.0\2.93\blender.exe --env-system-python "C:\Users\Praneeth\anaconda3\envs\blender293"
    • Remember to use double quotes if there is a space in the path!
    • If this works, you're good to go! Rest of the steps make are meant to make your life easier in the long run.
    • You should be able to install additional packages using conda and import them in the blender console.
  10. Recommended: Add the path to this repository to your python path. For example, create a 'paths.pth' file, open it in notepad, and type the following lines into it:
    • C:\dev\blender-ScritpViz
    • C:\dev\pn-utilities
    • Save this as C:\Users\Praneeth\anaconda3\envs\blender293\Lib\site-packages\paths.pth

Troubleshooting:

temp.yml, and check which packages failed to install. If it is pybullet, then it is probably because it needs Visual C++ 14. You can install Visual Studio Community edition (if you have the space, or perhaps the redistributable VC++ also works, I haven't tested it.)">
- A useful tip is to check if you're able to find the correct python, pip, conda and blender commands from your command prompt. Most of the issues I encountered had something to do with the correct paths.
- Use 'where blender' in the windows command prompt inside VSCode
- Result: C:\\blender\\2.93.0\\blender.exe
- where python
- C:\\Users\\Praneeth\\.conda\\envs\\blender293\\python.exe
- where conda
- C:\\ProgramData\\Anaconda3\\condabin\\conda.bat
- Check VSCode settings - 
  Add these settings in VSCode (to your workspace) - Modify this example
     -  "settings": {
           "terminal.integrated.env.windows": {
              "PATH": "C:\\blender\\2.83.0;C:\\Users\\Praneeth\\.conda\\envs\\blender2830;C:\\Users\\Praneeth\\.conda\\envs\\blender2830\\Library\\mingw-w64\\bin;C:\\Users\\Praneeth\\.conda\\envs\\blender2830\\Library\\usr\\bin;C:\\Users\\Praneeth\\.conda\\envs\\blender2830\\Library\\bin;C:\\Users\\Praneeth\\.conda\\envs\\blender2830\\Scripts;C:\\Users\\Praneeth\\.conda\\envs\\blender2830\\bin;C:\\ProgramData\\Anaconda3\\condabin;*OTHER THINGS IN YOUR PATH*,
           },
           "python.pythonPath": "C:\\Users\\Praneeth\\.conda\\envs\\blender2830\\python.exe",
        },
- If conda env create -f _requirements.yml fails, activate the environment, and use conda env export > temp.yml, and check which packages failed to install. If it is pybullet, then it is probably because it needs Visual C++ 14. You can install Visual Studio Community edition (if you have the space, or perhaps the redistributable VC++ also works, I haven't tested it.)

Current workflow

  1. Start VSCode
  2. Activatec conda environment from the terminal
    • conda activate blender293
  3. Start blender
    • C:\blender\2.93.0\2.93\blender.exe --env-system-python "C:\Users\Praneeth\.conda\envs\blender293"

Folder structure

_auth: Authentication

This folder contains authentication keys for interfacing with applications. Don't commit this when working with multiple people.

_dev: Developer notes

Notes for development and learning during the course of the project. _requirements_topLevel.txt is meant to help with python's package management. It is a good idea to add this to source control when developing with multiple people, but this will eventually disappear from distribution.

_temp: Temporary folder

Local cache for storing intermediate data generated by the software.

apps

Applications that use the main package bpn, and supporting package pntools. See License.

bpn

This folder contains the core scripts for using core module has wrappers around blender objects, divided into three types:

  1. Thing - class that initializes all wrappers
  2. Object, Mesh, Collection, GreasePencil - wrappers around bpy.data.(*)
  3. MeshObject, GreasePencilObject - Initialize object + data
    • Each of these classes have analogs in the new module (mesh, pencil)
    • The user should only need to interact with core classes through functions in the new module utils.get is the dispatcher that automatically creates objects from the appropriate classes in the core module.

names are very important in bpn. We use names to insulate bpn from bpy. That means, bpn tries very hard not to keep a copy of things from bpy. Instead, it tries to get the appropriate information from bpy when needed. names determine the interaction between bpy and bpn.

*args are for the 'new' function to create a new blender data instance *kwargs are for initializing that instance inside bpy.data.(type).(instance)

Objects and lights need to pass one argument through *args. I did not set it to have the flexibility of initializing empty objects with Nonetype. Classes inherited from Object also send *args up to Thing class (e.g. MeshObject, and GreasePencilObject) Rest of them ONLY send kwargs for initialization.

Modules vef, trf and env currently do not depend on any other files within bpn. env requires blender and therefore, will stay within bpn, but the other two can become their own packages that bpn uses. Perhaps move them to pntools?

pntools

General python tools that were developed with this proejct, but can generalize beyond this project.

bpn_init.py

The purpose is to bring bpn's functionality into blender's python console with one command. At the blender console, type from bpn_init import *

Owner
Praneeth Namburi
Movement Research and Education
Praneeth Namburi
An automatic prover for tautologies in Metamath

completeness An automatic prover for tautologies in Metamath This program implements the constructive proof of the Completeness Theorem for propositio

Scott Fenton 2 Dec 15, 2021
DrawBot lets you draw images taken from the internet on Skribbl.io, Gartic Phone and Paint

DrawBot You don't speak french? No worries, english translation is over here. C'est quoi ? DrawBot est un logiciel codé par V2F qui va prendre possess

V2F 205 Jan 01, 2023
HW_02 Data visualisation task

HW_02 Data visualisation and Matplotlib practice Instructions for HW_02 Idea for data analysis As I was brainstorming ideas and running through databa

9 Dec 13, 2022
Rick and Morty Data Visualization with python

Rick and Morty Data Visualization For this project I looked at data for the TV show Rick and Morty Number of Episodes at a Certain Location Here is th

7 Aug 29, 2022
Extract and visualize information from Gurobi log files

GRBlogtools Extract information from Gurobi log files and generate pandas DataFrames or Excel worksheets for further processing. Also includes a wrapp

Gurobi Optimization 56 Nov 17, 2022
NorthPitch is a python soccer plotting library that sits on top of Matplotlib

NorthPitch is a python soccer plotting library that sits on top of Matplotlib.

Devin Pleuler 30 Feb 22, 2022
Library for exploring and validating machine learning data

TensorFlow Data Validation TensorFlow Data Validation (TFDV) is a library for exploring and validating machine learning data. It is designed to be hig

688 Jan 03, 2023
A filler visualizer built using python

filler-visualizer 42 filler のログをビジュアライズしてスポーツさながら楽しむことができます! Usage (標準入力でvisualizer.pyに渡せばALL OK) 1. 既にあるログをビジュアライズする $ ./filler_vm -t 3 -p1 john_fill

Takumi Hara 1 Nov 04, 2021
Handout for the tutorial "Creating publication-quality figures with matplotlib"

Handout for the tutorial "Creating publication-quality figures with matplotlib"

JB Mouret 1.9k Jan 02, 2023
Smoking Simulation is an app to simulate the spreading of smokers and non-smokers, their interactions and population during certain amount of time.

Smoking Simulation is an app to simulate the spreading of smokers and non-smokers, their interactions and population during certain

Bohdan Ruban 5 Nov 08, 2022
A Bokeh project developed for learning and teaching Bokeh interactive plotting!

Bokeh-Python-Visualization A Bokeh project developed for learning and teaching Bokeh interactive plotting! See my medium blog posts about making bokeh

Will Koehrsen 350 Dec 05, 2022
nptsne is a numpy compatible python binary package that offers a number of APIs for fast tSNE calculation.

nptsne nptsne is a numpy compatible python binary package that offers a number of APIs for fast tSNE calculation and HSNE modelling. For more detail s

Biomedical Visual Analytics Unit LUMC - TU Delft 29 Jul 05, 2022
A Python library for plotting hockey rinks with Matplotlib.

Hockey Rink A Python library for plotting hockey rinks with Matplotlib. Installation pip install hockey_rink Current Rinks The following shows the cus

24 Jan 02, 2023
Implement the Perspective open source code in preparation for data visualization

Task Overview | Installation Instructions | Link to Module 2 Introduction Experience Technology at JP Morgan Chase Try out what real work is like in t

Abdulazeez Jimoh 1 Jan 23, 2022
Simple implementation of Self Organizing Maps (SOMs) with rectangular and hexagonal grid topologies

py-self-organizing-map Simple implementation of Self Organizing Maps (SOMs) with rectangular and hexagonal grid topologies. A SOM is a simple unsuperv

Jonas Grebe 1 Feb 10, 2022
A high-level plotting API for pandas, dask, xarray, and networkx built on HoloViews

hvPlot A high-level plotting API for the PyData ecosystem built on HoloViews. Build Status Coverage Latest dev release Latest release Docs What is it?

HoloViz 694 Jan 04, 2023
A simple agent-based model used to teach the basics of OOP in my lectures

Pydemic A simple agent-based model of a pandemic. This is used to teach basic principles of object-oriented programming to master students. It is not

Fabien Maussion 2 Jun 08, 2022
Type-safe YAML parser and validator.

StrictYAML StrictYAML is a type-safe YAML parser that parses and validates a restricted subset of the YAML specification. Priorities: Beautiful API Re

Colm O'Connor 1.2k Jan 04, 2023
Use Perspective to create the chart for the trader’s dashboard

Task Overview | Installation Instructions | Link to Module 3 Introduction Experience Technology at JP Morgan Chase Try out what real work is like in t

Abdulazeez Jimoh 1 Jan 22, 2022