Synodic-Software / Soul-Engine

Physically based renderer and simulation engine for real-time applications.

Soul Engine

Soul Engine is a real-time visualization engine built on the back of CUDA and Vulkan. With a focus on lightweight parallelism that can be leveraged for expensive techniques, Soul Engine provides a platform for path tracing, finite element physics, and general simulation.

For more information, visit our Wiki

---

Warning

Soul Engine is undergoing a large user-facing refactor and is not stable. Incomplete public features will be removed in preparation for the first use of Semantic Versioning.

In the meantime expect to see the following features make their way in as we approach stability:

• Subsystem modularity
• Testing framework
• Continuous integration
• Simplified manual installation
• Automated C++/Python dependency installation
• Dynamic and static plugins
• Directory tree cleanup

Once Soul Engine hits 1.0, codebase stability will become a priority. Thank you for your patience.

---

Getting Started

1. Install the required manual dependencies

   • Python 3.8
   • Poetry
     • Install within the global pip environement - pip install poetry
     • Install for your user - curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python

2. Clone Soul Engine

   • git clone https://github.com/Synodic-Software/Soul-Engine.git

3. Install the dependencies and setup the tooling

   • poetry install

4. Build the engine

   • poetry build

5. Run the Soul Engine command line program

   • soul info

For a detailed installation process visit our Wiki's Getting Started