amira_blender_rendering

• About
• Citing ABR
• Maintainers
• Contributors and How to Contribute
• Documentation
• Installation, How to use it and How to test/troubleshoot
• License
• Used 3rd party Licenses

About

AMIRA Blender Rendering: a tool for photorealistic rendering with Blender.

The project is intended to provide a lean programmatic framework for physics-based photorealistic rendering and make it available to both expert and beginner user.

The project builds upon Blender rendering capabilities and its Python API (bpy).

Citing AMIRA Blender Rendering

@misc{AMIRA-Blender-Rendering,
  author={Waniek, Nicolai and Todescato, Marco},
  title={{AMIRA} {B}lender {R}endering: a tool for photorealistic rendering with {B}lender},
  howpublished={\url{https://github.com/boschresearch/amira_blender_rendering}},
  month={November},
  year={2020}
}

Original Authors

• Nicolai Waniek
• Marco Todescato

Contributors and How to Contribute

See NOTICE file for an update list of the current holders and contributors to AMIRA Blender Rendering.

Also, in case you want to get involve and contribute yourself, please refer to the CONTRIBUTING.md file and to the documentation for a more in depth description of the workflow.

Note: We usually develop against the (default) develop branch while master is used for "stable" releases. Hence consider doing the same when opening PRs.

Documentation

All the documentation is available online hosted as GitHub page.

If you want to access it offline, you can also build it yourself. Assuming mkdocs is available, simply issue, from a_blender_rendering root directory,

mkdocs build

This will build the documentation under site and can be conveniently browsed by opening site/index.html into you preferred browsers.

In case you encounter any issue, make sure that all necessary dependencies (see requirements.txt) are correctly installed.

Notes: as explained in the documentation, running ABR might require to create and work with a custom python3.7 environemnt. Hence, it is suggested to create one before starting. Also, according to requirements.txt, compiling the documentation requires sphinx-rtd-theme to be installed in your current python3 environment. If you don't know how to create an environment, make sure your python3 system distro has sphinx-rtd-theme install in order to build the documentation.

Installation, How to use it and How to test/troubleshoot

Please refer to the documentation

License

AMIRA Blender Rendering is opened-source under the Apache-2.0 license. as per the LICENSE notice

Used 3rd party Licenses

The package dependencies include Blender, using the Cycles rendering engine. See 3rd party licenses for a comprehesinve list.