Peacock.jl
Peacock.jl: Photonic crystals in Julia - Published in JOSS (2020)
Science Score: 98.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 4 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Repository
Photonic crystals in Julia 🦚
Basic Info
Statistics
- Stars: 37
- Watchers: 2
- Forks: 9
- Open Issues: 13
- Releases: 2
Topics
Metadata Files
README.md
Introduction
Peacock.jl - or the Plane-wave Expansion Approach to Characterising Optical Crystals in k-space - is a Julia package for studying photonic crystals using the Plane Wave Expansion Method.
Photonic crystals are materials whose optical properties arise from the structuring of the material when the size of the structures are comparable to the wavelengths of light. Peacock.jl is named for the irridescent colours of peacock feathers which arise not from pigmentation but from their photonic crystal structure, as shown below.
Peacock by allanlau2000 from pixabay. Feather by suju from pixabay. Electron microscope image of photonic crystal structure from Zi, Jian, et al. "Coloration strategies in peacock feathers.", Proceedings of the National Academy of Sciences 100.22 (2003): 12576-12578. Copyright (2003) National Academy of Sciences.
As well as occuring naturally as in animals such as peacocks, advances in nanofabrication mean that 'designer' photonic crystals can now be manufactured for unprecedented control over the flow of light, with applications ranging from optical fibers to photonic circuitry. Photonic crystals are also a promising platform for more exotic materials like topological insulators.
Installation
julia
julia> ]
pkg> add Peacock
For more info on the package and usage instructions, see the documentation.
Features
Solve for... * Transverse electric (TE) and transverse magnetic (TM) modes of 2D photonic crystals: * Non-orthogonal unit cells * Inhomogeneous permittivity and/or permeability * Chern numbers of topological photonic crystals using built-in Wilson loop methods.
Focused on ease of use
* Install with one line in Julia's package manager.
* Simple visualisation of geometry, fields, and fully labelled band diagrams.
* Reproduce and extend existing photonic crystals in the Peacock.Zoo submodule.
* Easily accelerate calculations on CUDA-compatible GPUs.
Limitations
- Currently only implemented for 2D photonic crystals.
- Like all methods that solve Maxwell's equations in Fourier space, the Plane Wave Expansion Method converges slowly for high contrast materials such as metals (ϵ < 0).
Contributors
- @sp94 (core)
- @kabume (GPU support)
Referencing
If you use Peacock.jl in your work, please consider citing us as
bib
@article{palmer2020peacock,
title={Peacock.jl: Photonic crystals in {Julia}},
author={Palmer, Samuel J and Giannini, Vincenzo},
journal={Journal of Open Source Software},
volume={5},
number={54},
pages={2678},
year={2020}
}
Owner
- Name: Samuel J Palmer
- Login: sp94
- Kind: user
- Location: London
- Repositories: 4
- Profile: https://github.com/sp94
Software Developer at Quaisr
JOSS Publication
Peacock.jl: Photonic crystals in Julia
Authors
The Blackett Laboratory, Imperial College London, London, SW7 2AZ, UK
Instituto de Estructura de la Materia (IEM), Consejo Superior de Investigaciones Científicas (CSIC), Serrano 121, 28006, Madrid, Spain
Editor
David P. Sanders
Tags
physics optics photonics photonic crystals photonic topological insulators Maxwell's equations metamaterials plane wave expansionCitation (CITATION.bib)
@article{palmer2020peacock,
title={Peacock.jl: Photonic crystals in {Julia}},
author={Palmer, Samuel J and Giannini, Vincenzo},
journal={Journal of Open Source Software},
volume={5},
number={54},
pages={2678},
year={2020}
}
GitHub Events
Total
- Push event: 1
- Pull request review event: 1
- Pull request event: 2
- Fork event: 1
Last Year
- Push event: 1
- Pull request review event: 1
- Pull request event: 2
- Fork event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| S J Palmer | s****4@g****m | 255 |
| Ashish Panigrahi | a****i@p****m | 2 |
| Sven | g****3@p****t | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 21
- Total pull requests: 7
- Average time to close issues: 9 days
- Average time to close pull requests: 27 days
- Total issue authors: 7
- Total pull request authors: 3
- Average comments per issue: 1.9
- Average comments per pull request: 0.57
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: 6 months
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- sp94 (13)
- kabume (2)
- mlxd (2)
- dpsanders (1)
- nmoran (1)
- qzhu2017 (1)
- JuliaTagBot (1)
Pull Request Authors
- paniash (3)
- sp94 (3)
- mainrs (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 3
juliahub.com: Peacock
Photonic crystals in Julia 🦚
- Documentation: https://docs.juliahub.com/General/Peacock/stable/
- License: MIT
-
Latest release: 0.1.2
published almost 5 years ago
Rankings
Dependencies
- actions/cache v1 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- codecov/codecov-action 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
- JuliaRegistries/TagBot v1 composite