Data

Tools

Indexes

Applications

Experiments

Open Source Science

RayTracer

Differentiable RayTracing in Julia

https://github.com/avik-pal/raytracer.jl

Science Score: 51.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ✓
    DOI references
    Found 9 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary

Keywords

differentiable-programming gradient-descent inverse-rendering julia machine-learning mesh-rendering optimization ray-tracer raytracer

Keywords from Contributors

mixed-model julialang julia-package optimization-algorithms
Last synced: 4 months ago · JSON representation ·

Repository

Differentiable RayTracing in Julia

Basic Info
Statistics
  • Stars: 154
  • Watchers: 7
  • Forks: 12
  • Open Issues: 16
  • Releases: 0
Topics
differentiable-programming gradient-descent inverse-rendering julia machine-learning mesh-rendering optimization ray-tracer raytracer
Created almost 7 years ago · Last pushed almost 3 years ago
Metadata Files
Readme License Citation

README.md

RayTracer.jl

CI codecov Latest Docs DOI DOI

This package was written in the early days of Flux / Zygote. Both these packages have significantly improved over time. Unfortunately the current state of this package of has not been updated to reflect those improvements. It also seems that it might be better to gradually transition to defining the adjoints directly using ChainRules

A Ray Tracer written completely in Julia. This allows us to leverage the AD capablities provided by Zygote to differentiate through the Ray Tracer.

INSTALLATION

This package is registered. So open up a Julia 1.3+ repl and enter the pkg mode.

julia julia> ] (v1.3) pkg> add RayTracer

To use the master branch (not recommended) do.

julia julia> ] (v1.3) pkg> add RayTracer#master

TUTORIALS

Introductory Rendering Tutorial Inverse Lighting Tutorial Inverse Rendering with Optim.jl Tutorial

USAGE EXAMPLES

Follow the instructions below to run individual examples or use examples/script.sh to run all of them together.

First we need to get the versions of the packages used when these examples were written.

bash $ cd examples $ julia --color=yes -e "using Pkg; Pkg.instantiate()"

Now we can run any of the file we need by julia --project=. --color=yes "/path/to/file"

Running Individual Examples

wget https://raw.githubusercontent.com/McNopper/OpenGL/master/Binaries/teapot.obj

```bash $ mkdir meshes $ cd meshes $ wget https://raw.githubusercontent.com/avik-pal/RayTracer.jl/master/test/meshes/signyield.obj $ wget https://raw.githubusercontent.com/avik-pal/RayTracer.jl/master/test/meshes/signyield.mtl $ cd ..

$ mkdir textures $ cd textures $ wget https://raw.githubusercontent.com/avik-pal/RayTracer.jl/master/test/textures/woodosb.jpg $ wget https://raw.githubusercontent.com/avik-pal/RayTracer.jl/master/test/textures/signyield.png $ cd .. ```

This example requires a few arguments to be passes from command line. Chack them using

julia --project=. --color=yes "performance_benchmarks.jl" --help

$ wget https://raw.githubusercontent.com/tejank10/Duckietown.jl/master/src/meshes/tree.obj $ wget https://raw.githubusercontent.com/tejank10/Duckietown.jl/master/src/meshes/tree.mtl

Additional Examples

Duckietown.jl uses RayTracer.jl for generating renders of a self-driving car environment. For more complex examples of RayTracer, checkout that project.

SUPPORTING AND CITING:

This software was developed as part of academic research. If you would like to help support it, please star the repository. If you use this software as part of your research, teaching, or other activities, we would be grateful if you could cite the following:

@article{Pal2020, doi = {10.21105/jcon.00037}, url = {https://doi.org/10.21105/jcon.00037}, year = {2020}, publisher = {The Open Journal}, volume = {1}, number = {1}, pages = {37}, author = {Avik Pal}, title = {RayTracer.jl: A Differentiable Renderer that supports Parameter Optimization for Scene Reconstruction}, journal = {Proceedings of the JuliaCon Conferences} }

CURRENT ROADMAP

These are not listed in any particular order

  • [X] Add more types of common objects (use mesh rendering for this)
  • [X] Add support for rendering arbitrary mesh
  • [X] Inverse Rendering Examples
  • [X] Texture Rendering
  • [ ] Application in Machine Learning Models through Flux (work in progress)
  • [ ] Major Overhaul using Flux3D.jl
  • [ ] Exploit the latest improvements to Flux and Zygote

Owner

  • Name: Avik Pal
  • Login: avik-pal
  • Kind: user
  • Location: Cambridge, MA
  • Company: Massachusetts Institute of Technology

PhD Student @mit || Prev: BTech CSE IITK

Citation (CITATION.bib) 

@article{Pal2020,
  doi = {10.21105/jcon.00037},
  url = {https://doi.org/10.21105/jcon.00037},
  year = {2020},
  publisher = {The Open Journal},
  volume = {1},
  number = {1},
  pages = {37},
  author = {Avik Pal},
  title = {RayTracer.jl: A Differentiable Renderer that supports Parameter Optimization for Scene Reconstruction},
  journal = {Proceedings of the JuliaCon Conferences}
}

GitHub Events

Total
  • Watch event: 3
Last Year
  • Watch event: 3

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 169
  • Total Committers: 4
  • Avg Commits per committer: 42.25
  • Development Distribution Score (DDS): 0.077
Top Committers
Name Email Commits
Avik Pal a****l@i****n 156
github-actions[bot] 4****]@u****m 11
Mathieu Besançon m****n@g****m 1
Julia TagBot 5****t@u****m 1
Committer Domains (Top 20 + Academic)
iitk.ac.in: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 9
  • Total pull requests: 48
  • Average time to close issues: 20 days
  • Average time to close pull requests: 6 days
  • Total issue authors: 9
  • Total pull request authors: 6
  • Average comments per issue: 3.33
  • Average comments per pull request: 0.29
  • Merged pull requests: 26
  • Bot issues: 0
  • Bot pull requests: 31
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • umbriquse (1)
  • tejank10 (1)
  • leifdenby (1)
  • snoeyink (1)
  • manuelbb-upb (1)
  • philtomson (1)
  • joa-quim (1)
  • JuliaTagBot (1)
  • JeffBezanson (1)
Pull Request Authors
  • github-actions[bot] (31)
  • avik-pal (12)
  • dourouc05 (2)
  • JeffBezanson (1)
  • matbesancon (1)
  • JuliaTagBot (1)
Top Labels
Issue Labels
bug (1)
Pull Request Labels
no changelog (4)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
juliahub.com: RayTracer

Differentiable RayTracing in Julia

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Stargazers count: 5.0%
Dependent repos count: 9.9%
Forks count: 12.5%
Average: 16.6%
Dependent packages count: 38.9%
Last synced: 4 months ago

Dependencies

.github/workflows/CompatHelper.yml actions
  • julia-actions/setup-julia latest composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • julia-actions/julia-buildpkg latest composite
  • julia-actions/julia-runtest latest composite
  • julia-actions/julia-uploadcodecov latest composite
  • julia-actions/setup-julia v1 composite