Radium is a research 3D Engine for rendering, animation and processing. It is developed and maintained by the STORM research group.
Radium-Engine comes in two flavors:
- the stable https://github.com/STORM-IRIT/Radium-Engine/tree/master branch.
- the unstable bleeding edge https://github.com/STORM-IRIT/Radium-Engine/tree/release-candidate branch.
[Click here to download Precompiled binaries]
[Click here for API documentation]
The Radium ecosystem is composed of
- Radium Libraries: this project (see documentation here: https://storm-irit.github.io/Radium-Engine/). Contains the Radium libraries.
- Radium Apps (https://github.com/STORM-IRIT/Radium-Apps): contains several applications, including MainApp, which is for now the default software with GUI. This repository also demonstrates command-line applications.
- Radium Releases (https://github.com/STORM-IRIT/Radium-Releases): meta-repository generating precompiled binaries for Radium libraries and its applications.
- Radium Plugins Example (https://github.com/STORM-IRIT/Radium-PluginExample): contains plugins examples, demonstrating how to write, compile and use plugins with MainApp.
- Radium Official Plugins (https://gitlab.com/Storm-IRIT/radium-official-plugins): general purpose plugins.
Depending on you needs, you may want to:
- Use Radium as a viewer and processing software, with graphical user interface. That's the most simple case: simply download the latest release, and run. See https://github.com/STORM-IRIT/Radium-Releases/releases.
- Contribute to Radium, or develop your own application of plugin: Radium Libraries is the default and mandatory repository you need to fetch first. If you only want to use Radium, compile and install it (see documentation). Then, - If you want to contribute to the application or plugins developments, fetch and compile the Radium Apps and Radium Official Plugins respectively. - If you want to write your own application of plugin, checkout the HelloRadium and Radium Plugins Example projects.
If you use Radium-Engine for your research and publication, or simply want to refer/cite Radium Engine, please use the following
@software{RadiumEngine,
author = {Charly Mourglia and Valentin Roussellet and
Loïc Barthe and Nicolas Mellado and
Mathias Paulin and David Vanderhaeghe and others},
title = {Radium-Engine},
month = jul,
year = 2021,
note = {https://storm-irit.github.io/Radium-Engine/},
publisher = {Zenodo},
version = {doi-1.0.0},
doi = {10.5281/zenodo.5101334},
url = {https://doi.org/10.5281/zenodo.5101334}
}
