Git Product home page Git Product logo

elements's Introduction

Welcome to project Elements!

Documentation Project's GitHub Page arXiv License

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: arXiv LINK, Eurographics LINK.

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

Getting Started - Installation Instructions

Begin by following the installation instructions, found HERE. For Computer Graphics Course students, the instructions are HERE.

Note

We strongly recommend using:

The main steps summarize as follows:

  • Install Anaconda, VSCode, Git and a optionally a version control app
  • Clone (or download) this repo (or your forked repo)
  • Create a python 3.8 environment, by running conda create -n elements python=3.8, and activate it via conda activate elements
  • Install the Elements in editable mode by running pip install -e .
  • Start exploring the examples in the Elements/examples folder.

Folder Structure

  • docs: Files used to generate the documentation
  • Elements: Contains all the source code of Elements
    • examples: Example files related to pyECSS
    • features: Features extending basic functionality of Elements
      • BasicShapes: Quickly add basic shapes (cubes, spheres, cones) to the scene with helper functions
      • GA: Files related to Geometric Algebra(GA) and GA-based components-systems
      • Gizmos: Introducing Unity-like Gizmos to the Elements, for object manipulation
      • SkinnedMesh: Visualize skinned meshes by applying the animation equation
      • Slicing: Visualize sliced version of a 3D object
      • Voronoi2D: Visualize the Voronoi diagram of 2D points
      • bezier: Visualize a 3D bezier curve
      • plane_fitting: Visualize the plane that best fits on a set of points
      • plotting: Plot a 2D or 3D function
      • rigid_body_animation: Animate a skinned mesh (preliminary version)
      • usd: Enable loading/saving using Pixar's Universal Scene Descriptor (USD) format
    • files: Static files required
      • atlas_files: Required for the Classification and Generative AI examples/notebooks
      • models: Various 3D models, static or rigged
      • scenes: Scenes in USD format
      • scv: Various SCV files
      • shaders: Various shader files
      • textures: Various texture files
    • pyECSS: Contains all the source code for pyECSS - Entity, Component, System, Scenegraph functionality
      • tests: Test files for pyECSS
    • pyGLV: Contains all the source code for pyGLV - graphics, shading, imgui functionality
      • tests: Test files for pyGLV
      • GL: The basic Graphics Library files (Scene, Shader, Texture, VertexArray)
      • GUI: Files related to the window and GUI instantiation.
    • pyEEL: The pyEEL learning hub
      • notebooks: 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
    • utils: Utility files and functions for Elements

Contribute to Elements

If you want to contribute to Elements, kindly check its WIKI for a list of potential projects and a contribution guide. A list of contributors can be found here.

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:

@inproceedings {Elements2023,
booktitle = {Eurographics 2023 - Education Papers},
editor = {Magana, Alejandra and Zara, Jiri},
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},
year = {2023},
publisher = {The Eurographics Association},
ISSN = {1017-4656},
ISBN = {978-3-03868-210-3},
DOI = {10.2312/eged.20231015}
}

elements's People

Contributors

kamarianakis avatar chibinemesis avatar papagiannakis avatar baeckerbraten avatar michalistamiolakis avatar greglit avatar nickiliak avatar aprotopsaltis avatar paulzik avatar lydatakis avatar oliver93mk avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.