Welcome to project Elements!

elements_video_540_high.mp4

Overview

Elements introduces for the first time the power of the Entity-Component-System (ECS) with the versatility of Scenegraphs, in the context of Computer Graphics (CG), Deep Learning (DL) for Scientific Visualization (SciViz). It also aims to provide the basic tools to anyone that wants to be involved with basic Computer Graphics as well as advanced topics such as Geometric Deep Learning, Geometric Algebra and many many more.

Following a modern educational approach, all related packages are in the Python programming language.

To dive in the details of the project check its detailed developer documentation and the research paper behind this project.

Packages Involved in Elements

pyECSS: A package for applying ECS to any Scenegraph
pyGLV : A package applying ECSS to CG, DL and SciViz problems
pyEEL : A learning hub for various topics where ECSS can be applied

Quick Start

Download (or clone) this repo (or your fork) and, in a python 3.8 environment, run pip install -e .

Go to the Elements/pyGLV/examples folder and quickstart by using/modifying one of the existing examples.

Folder Structure

docs: Files used to generate the documentation
Elements: Contains all the source code of Elements
- pyECSS: Contains all the source code for pyECSS - Entity, Component, System, Scenegraph functionality
  - examples: Example files related to pyECSS
  - GA: Files related to Geometric Algebra(GA) and GA-based components-systems
  - tests: Test files for pyECSS
- pyGLV: Contains all the source code for pyGLV - graphics, shading, imgui functionality
  - examples: Example files related to pyGLV
  - tests: Test files for pyGLV
  - GL: The basic Graphics Library files (Scene, Shader, Texture, VertexArray)
  - GUI: Files related to the window and GUI instantiation.
  - utils: Utility files and functions for pyGLV.
- pyEEL: The pyEEL learning hub
  - examples: Contains all the jupyter notebooks of pyEEL
    - SciCom: Scientific Computation related notebooks
    - neuralCG: Neural networks in CG related notebooks
    - DL: Deep Learning related notebooks
    - CG: Computer Graphics (CG) related notebooks
    - GATE: Geometric Algebra Transformation Engine related notebooks

Contribute to Elements

If you want to contribute to Elements, kindly check its WIKI for a list of potential projects and a contribution guide.

Contact Us

If you have any questions or would like to learn more about our project, please don't hesitate to contact us.

Citation

If you are using the Elements project, please cite:

@misc{projectElements,
  title = {Project Elements: A computational entity-component-system in a scene-graph pythonic framework, for a neural, geometric computer graphics curriculum},
  author = {Papagiannakis, George and Kamarianakis, Manos and Protopsaltis, Antonis and Angelis, Dimitris and Zikas, Paul},
  doi = {10.48550/ARXIV.2302.07691},
  url = {https://arxiv.org/abs/2302.07691},
  publisher = {arXiv},
  year = {2023}
}

Baeckerbraten / Elements