RayFlare

RayFlare: flexible optical modelling of solar cells - Published in JOSS (2021)

https://github.com/qpv-research-group/rayflare

Science Score: 95.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    1 of 5 committers (20.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

multiscale-simulation optics physics ray-tracing raytracing rigorous-coupled-wave solar-cells transfer-matrix-method
Last synced: 4 months ago · JSON representation

Repository

Open-source, integrated optical modelling of complex stacks

Basic Info
  • Host: GitHub
  • Owner: qpv-research-group
  • License: other
  • Language: Python
  • Default Branch: devel
  • Homepage:
  • Size: 105 MB
Statistics
  • Stars: 42
  • Watchers: 2
  • Forks: 14
  • Open Issues: 12
  • Releases: 7
Topics
multiscale-simulation optics physics ray-tracing raytracing rigorous-coupled-wave solar-cells transfer-matrix-method
Created over 6 years ago · Last pushed 7 months ago
Metadata Files
Readme Contributing License Code of conduct

README.md

License: LGPL v3 codecov Codacy Badge Documentation Status status

Important: Please check out the news & updates page for the most recent updates and changes, including any possible backwards compatibility issues. If you have questions, issues, etc., please check the documentation and (open and closed) issues first, or open a new issue using the relevant template.

If you would like to be kept up to date on (important) releases and new features, please join the Solcore/RayFlare mailing list here.

rayflare

Open-source, integrated optical modelling of complex stacks. RayFlare incorporates the transfer-matrix method (TMM), ray-tracing and rigorous coupled-wave analysis (RCWA/FMM), in addition to an angular redistribution matrix method which allows multiple methods to be coupled across a single structure to calculate total absorption/reflection/transmission, absorption per layer, and absorption profiles.

You can view RayFlare's documentation, including installation instructions here. The contributing guidelines are here and the Code of Conduct is here. This package is distributed under a GNU LGPL (version 3) license. If you have questions, issues, etc., please check the documentation first or open an issue using the relevant template.

If you use RayFlare in your work, please cite the JOSS paper:

Pearce, P. M., (2021). RayFlare: flexible optical modelling of solar cells. Journal of Open Source Software, 6(65), 3460. https://doi.org/10.21105/joss.03460

poster

Owner

  • Name: Quantum Photovoltaics Research Group
  • Login: qpv-research-group
  • Kind: organization
  • Location: UNSW (Sydney, Australia) and Imperial College London (UK) until 2017

We are a research group led by Dr. Nicholas Ekins-Daukes and specialized in the application of nanotechnology to achieve high efficiency solar cells

JOSS Publication

RayFlare: flexible optical modelling of solar cells
Published
September 27, 2021
Volume 6, Issue 65, Page 3460
Authors
Phoebe M. Pearce ORCID
Department of Physics, University of Cambridge, 19 JJ Thomson Avenue, Cambridge CB3 0HE
Editor
Arfon Smith ORCID
Tags
physics optics solar cells ray-tracing rigorous coupled-wave analysis transfer matrix method multi-scale modelling

GitHub Events

Total
  • Issues event: 1
  • Watch event: 12
  • Issue comment event: 1
  • Push event: 6
  • Pull request event: 1
  • Fork event: 2
  • Create event: 1
Last Year
  • Issues event: 1
  • Watch event: 12
  • Issue comment event: 1
  • Push event: 6
  • Pull request event: 1
  • Fork event: 2
  • Create event: 1

Committers

Last synced: 4 months ago

All Time
  • Total Commits: 415
  • Total Committers: 5
  • Avg Commits per committer: 83.0
  • Development Distribution Score (DDS): 0.116
Past Year
  • Commits: 11
  • Committers: 1
  • Avg Commits per committer: 11.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
phoebe-p p****5@i****k 367
Phoebe Pearce p****e@P****l 43
phoebe-p p****5@i****k 3
Benjamin Vial b****4@g****m 1
Phoebe Pearce p****e@L****l 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 31
  • Total pull requests: 44
  • Average time to close issues: 3 months
  • Average time to close pull requests: 21 days
  • Total issue authors: 11
  • Total pull request authors: 4
  • Average comments per issue: 1.74
  • Average comments per pull request: 0.95
  • Merged pull requests: 38
  • Bot issues: 0
  • Bot pull requests: 4
Past Year
  • Issues: 1
  • Pull requests: 4
  • Average time to close issues: N/A
  • Average time to close pull requests: about 21 hours
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.75
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • phoebe-p (17)
  • kandersolar (4)
  • loongmxbt (2)
  • michelgaglioni (1)
  • EricaEgg (1)
  • yangfan256 (1)
  • suchi-bot (1)
  • 99rbbt (1)
  • mariongoncalves (1)
  • zainawhen (1)
  • etoni044 (1)
Pull Request Authors
  • phoebe-p (44)
  • dependabot[bot] (4)
  • codacy-badger (1)
  • benvial (1)
Top Labels
Issue Labels
enhancement (5) bug (3) question (1)
Pull Request Labels
dependencies (4)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 90 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 14
  • Total maintainers: 1
proxy.golang.org: github.com/qpv-research-group/rayflare
  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 4 months ago
pypi.org: rayflare

Python-based integrated optical modelling

  • Homepage: https://github.com/qpv-research-group/rayflare
  • Documentation: https://rayflare.readthedocs.io
  • License: RayFlare is a programme for flexible modelling of complicated optical structures. Copyright (C) 2021-2024 Phoebe Pearce This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. The full license text can be found in GNU_LGPL_v3.txt Contact: p.pearce@unsw.edu.au or p.m.pearce@gmail.com
  • Latest release: 2.0.1
    published over 1 year ago
  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 90 Last month
Rankings
Dependent packages count: 7.3%
Stargazers count: 12.9%
Forks count: 13.3%
Average: 17.1%
Dependent repos count: 22.1%
Downloads: 30.0%
Maintainers (1)
Last synced: 4 months ago

Dependencies

docs/requirements.txt pypi
  • insegel ==1.3.0
  • joblib ==1.1.0
  • matplotlib ==3.5.1
  • nbsphinx ==0.8.8
  • numpy ==1.21.5
  • scipy ==1.7.3
  • seaborn ==0.11.2
  • solcore ==5.7.5
  • sparse ==0.13.0
  • xarray ==0.20.2
setup.py pypi
  • joblib *
  • matplotlib *
  • numpy *
  • scipy *
  • seaborn *
  • solcore *
  • sparse *
  • xarray *
.github/workflows/testing.yml actions
  • actions/checkout v1 composite
  • actions/setup-python v1 composite