Skip to content

STORM-IRIT/Radium-Engine

Repository files navigation

Radium-Engine libraries

banner

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:

[Click here to download Precompiled binaries]
[Click here for API documentation]

The Radium ecosystem is composed of

Which repository should I use ?

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.

Reference

If you use Radium-Engine for your research and publication, or simply want to refer/cite Radium Engine, please use the following

DOI

@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}
}

Badges

pre-commit Codacy Badge codecov

CI  windows release float  badge CI  windows debug float  badge CI  windows release double  badge CI  windows debug double  badge

CI  macos release float  badge CI  macos debug float  badge CI  macos release double  badge CI  macos debug double  badge

CI  linux release float  badge CI  linux debug float  badge CI  linux release double  badge CI  linux debug double  badge