- About
- Maintainers
- Contributors and How to Contribute
- Documentation
- Installation, How to use it and How to test/troubleshoot
- License
- Used 3rd party Licenses
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 cababilities and its Python API (bpy).
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 more 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.
From within amira_blender_rendering/docs/ folder run
make htmlThis will build the documentation under docs/_build and can be conveniently
browsed by opening docs/_build/html/index.html into you preferred browers.
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 staring. 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.
Please refer to the documentation
AMIRA Blender Rendering is opened-source under the Apache-2.0 license. as per the LICENSE notice
The package dependencies include Blender, using the Cycles rendering engine. See 3rd party licenses for a comprehesinve list.