How papagiannakis/elements works
Main components
• Python Environment
– Conda/Pip + runtime dependencies (e.g., PyOpenGL, imgui-binding, USD)
• Core Libraries
– pyECSS: Entity-Component-System + Scenegraph manager (entities, components, systems, events)
– pyGLV: Graphics and GUI layer on top of pyECSS (Scene, Shader, Texture, VertexArray, ImGui Viewer)
– pyEEL: Educational Jupyter-notebook hub (CG, DL, SciCom, GATE, neuralCG modules)
• Extensions / Features (“plugins”)
– BasicShapes, GA, Gizmos, SkinnedMesh, Slicing, Voronoi2D, bezier, plane_fitting, plotting, rigid_body_animation, usd importer
• Utilities
– Utility modules (Converter, ShapeClassifierInterface, atlas generation, obj importer, terrain, ChatGPT wrapper, etc.)
• Static Assets (Files)
– Models (.obj, .fbx), pickles, shaders (.vert/.frag), textures, scenes (.usd), SCV data
• Clients / Examples / Notebooks
– Python scripts in Elements/examples
– Jupyter notebooks in pyEEL/notebooks
• Documentation (Sphinx / ReadTheDocs)
Relationships & data‐flow
• The “User” (student, researcher, or application code)
↳ imports Elements packages (pyECSS, pyGLV, pyEEL, utils)
↳ writes examples or notebooks that compose Entities, attach Components, register Systems
• pyECSS
↳ manages the Scenegraph and event dispatch
↳ instantiates Entities ←→ attaches Components ←→ schedules Systems
• pyGLV
↳ provides rendering and GUI Systems (RenderSystem, CameraSystem, ImGUI system) that plug into pyECSS
↳ issues OpenGL calls via Shader, Texture, VertexArray abstractions
• Extensions
↳ register extra Components & Systems with the ECSSManager
↳ consume static Assets via Files module (models, shaders, textures)
↳ expose helper functions to user code
• pyEEL
↳ loads core libraries in notebook context for teaching/demo
↳ may leverage utilities and static Assets for Deep Learning or CG demos
Architectural patterns & principles
• Modular plugin architecture: Core (pyECSS) ← extensions ← user code
• Separation of concerns:
– ECS (data & logic) vs. Graphics (GLV) vs. Education (EEL) vs. Utils vs. Assets
• Inversion-of-control: Systems are registered with ECSSManager and invoked each frame/tick
• Dependency injection: Graphics & utility modules import only what they need from core
Relevant technologies, frameworks & libraries
• Python 3.8+
• Conda/Pip for environment management
• PyOpenGL / SDL2 / ImGui (via pyGLV)
• Pixar USD for scene import/export
• Sphinx, ReadTheDocs for docs
• Jupyter notebooks