WaveOpticsPropagation

Propagate waves efficiently, optically, physically, differentiably with Julia Lang.

https://github.com/juliaphysics/waveopticspropagation.jl

Science Score: 57.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
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Propagate waves efficiently, optically, physically, differentiably with Julia Lang.

Basic Info
  • Host: GitHub
  • Owner: JuliaPhysics
  • License: mit
  • Language: Julia
  • Default Branch: main
  • Homepage:
  • Size: 1.71 MB
Statistics
  • Stars: 31
  • Watchers: 4
  • Forks: 3
  • Open Issues: 5
  • Releases: 3
Created almost 3 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

WaveOpticsPropagation.jl

| Build Status | Code Coverage | Docs stable | Docs main | |:-----------------------------------------:|:-------------------------------:|:-----------------------:|:--------------------:| | | | Documentation for stable version | Documentation for development version

Propagate waves efficiently, optically, physically, differentiably with Julia Lang. Those functions are fast and memory efficient implemented and hence are suited to be used in inverse problems.

⚠️ Under development. Expect things to break. But feel free to try the examples, they should always work!

Installation

Officially registered, so install with: julia julia> using Pkg; Pkg.add("WaveOpticsPropagation")

Examples

Look into the examples folder.

Features

Implemented

  • Propagate (electrical) fields based on wave propagation
  • Propagations
    • [x] Angular Spectrum Method of Plane Waves (AS)
    • [x] Fraunhofer Diffraction
    • [x] Scalable Angular Spectrum propagation
    • [x] Shifted Angular Spectrum propagation
    • [ ] Fresnel Propagation with Scaling Behaviour (no priority yet, PR are welcome for that. In principle very similar to the other methods.)
  • [x] CUDA support
  • [x] Differentiable (mainly based on Zygote.jl and ChainRulesCore.jl)

Planned

Vectorial propagation in free space is just a propagation of each of the components. Right now, this is not a priority and is not implemented yet. But of course, each vectorial component can be propagated separately.

Citation

This package was created as part of scientific work. Please consider citing it :) bibtex @article{Wechsler:24, author = {Felix Wechsler and Carlo Gigli and Jorge Madrid-Wolff and Christophe Moser}, journal = {Opt. Express}, keywords = {3D printing; Computed tomography; Liquid crystal displays; Material properties; Ray tracing; Refractive index}, number = {8}, pages = {14705--14712}, publisher = {Optica Publishing Group}, title = {Wave optical model for tomographic volumetric additive manufacturing}, volume = {32}, month = {Apr}, year = {2024}, url = {https://opg.optica.org/oe/abstract.cfm?URI=oe-32-8-14705}, doi = {10.1364/OE.521322}, }

Development

Contributions are very welcome! File an issue on GitHub if you encounter any problems. Also file an issue if you want to discuss or propose features.

Related packages

There is the outdated PhysicalOptics.jl which provided similar methods. For geometrical ray tracing use OpticSim.jl.

Owner

  • Name: JuliaPhysics
  • Login: JuliaPhysics
  • Kind: organization

Physics in Julia

Citation (CITATION.bib)

@article{Wechsler:24,
author = {Felix Wechsler and Carlo Gigli and Jorge Madrid-Wolff and Christophe Moser},
journal = {Opt. Express},
keywords = {3D printing; Computed tomography; Liquid crystal displays; Material properties; Ray tracing; Refractive index},
number = {8},
pages = {14705--14712},
publisher = {Optica Publishing Group},
title = {Wave optical model for tomographic volumetric additive manufacturing},
volume = {32},
month = {Apr},
year = {2024},
url = {https://opg.optica.org/oe/abstract.cfm?URI=oe-32-8-14705},
doi = {10.1364/OE.521322},
}

GitHub Events

Total
  • Watch event: 15
  • Delete event: 17
  • Issue comment event: 8
  • Push event: 24
  • Pull request event: 18
  • Fork event: 2
  • Create event: 8
Last Year
  • Watch event: 15
  • Delete event: 17
  • Issue comment event: 8
  • Push event: 24
  • Pull request event: 18
  • Fork event: 2
  • Create event: 8

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 5
  • Total pull requests: 34
  • Average time to close issues: 3 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 2
  • Total pull request authors: 5
  • Average comments per issue: 0.2
  • Average comments per pull request: 0.41
  • Merged pull requests: 17
  • Bot issues: 0
  • Bot pull requests: 23
Past Year
  • Issues: 0
  • Pull requests: 18
  • Average time to close issues: N/A
  • Average time to close pull requests: 19 minutes
  • Issue authors: 0
  • Pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.44
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 13
Top Authors
Issue Authors
  • roflmaostc (3)
  • apkille (1)
  • JuliaTagBot (1)
Pull Request Authors
  • github-actions[bot] (16)
  • dependabot[bot] (9)
  • roflmaostc (6)
  • abhro (4)
  • ederag (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (9) github_actions (9)

Packages

  • Total packages: 1
  • Total downloads:
    • julia 3 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
juliahub.com: WaveOpticsPropagation

Propagate waves efficiently, optically, physically, differentiably with Julia Lang.

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 3 Total
Rankings
Dependent repos count: 9.8%
Average: 24.7%
Dependent packages count: 39.5%
Last synced: 6 months ago

Dependencies

.github/workflows/CI.yml actions
  • actions/checkout v2 composite
  • codecov/codecov-action v2 composite
  • julia-actions/cache v1 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/CompatHelper.yml actions
.github/workflows/ExportPluto.yaml actions
  • JamesIves/github-pages-deploy-action releases/v4 composite
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • julia-actions/cache v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite