rayflare


Namerayflare JSON
Version 2.0.1 PyPI version JSON
download
home_pageNone
SummaryPython-based integrated optical modelling
upload_time2024-09-26 11:38:01
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseRayFlare 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
keywords ray optics diffraction ellipsometry lens lens design lens simulation light scattering light trapping optics photovoltaics physics ray tracing rcwa rigorous coupled wave analysis scattering thin film thin film optics tmm transfer matrix wave optics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![License: LGPL v3](https://img.shields.io/badge/License-LGPLv3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
[![codecov](https://codecov.io/gh/qpv-research-group/rayflare/branch/devel/graph/badge.svg)](https://codecov.io/gh/qpv-research-group/rayflare)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/7ff9180e5f7a460192440895d823ff15)](https://www.codacy.com/gh/qpv-research-group/rayflare?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=qpv-research-group/rayflare&amp;utm_campaign=Badge_Grade)
[![Documentation Status](https://readthedocs.org/projects/rayflare/badge/?version=latest)](https://rayflare.readthedocs.io/en/latest/?badge=latest)
[![status](https://joss.theoj.org/papers/15647ef7b3dd688b47c1b802a4f50a67/status.svg)](https://joss.theoj.org/papers/15647ef7b3dd688b47c1b802a4f50a67)

**Important**: Please check out the [news & updates](https://rayflare.readthedocs.io/en/latest/news.html) 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](https://github.com/qpv-research-group/rayflare/issues) first,
or open a new issue using the relevant template.

# 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](https://rayflare.readthedocs.io/en/latest/).
The contributing guidelines are [here](CONTRIBUTING.md) and the Code of Conduct is [here](CODE_OF_CONDUCT.md). This package
is distributed under a [GNU LGPL (version 3) license](GNU_LGPL_v3.txt). If you have questions, issues, etc., please check the
documentation first or open an [issue](https://github.com/qpv-research-group/rayflare/issues) using the relevant template.

If you use RayFlare in your work, please cite the [JOSS paper](https://doi.org/10.21105/joss.03460):

*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](poster.png "RayFlare poster")

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "rayflare",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "ray optics, diffraction, ellipsometry, lens, lens design, lens simulation, light scattering, light trapping, optics, photovoltaics, physics, ray tracing, rcwa, rigorous coupled wave analysis, scattering, thin film, thin film optics, tmm, transfer matrix, wave optics",
    "author": null,
    "author_email": "Phoebe Pearce <p.m.pearce@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/ff/9d/5dc5cd48649b855c40aef7ef6b9bdfc75f85baa47a7b22c58669f5459c62/rayflare-2.0.1.tar.gz",
    "platform": null,
    "description": "[![License: LGPL v3](https://img.shields.io/badge/License-LGPLv3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)\n[![codecov](https://codecov.io/gh/qpv-research-group/rayflare/branch/devel/graph/badge.svg)](https://codecov.io/gh/qpv-research-group/rayflare)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/7ff9180e5f7a460192440895d823ff15)](https://www.codacy.com/gh/qpv-research-group/rayflare?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=qpv-research-group/rayflare&amp;utm_campaign=Badge_Grade)\n[![Documentation Status](https://readthedocs.org/projects/rayflare/badge/?version=latest)](https://rayflare.readthedocs.io/en/latest/?badge=latest)\n[![status](https://joss.theoj.org/papers/15647ef7b3dd688b47c1b802a4f50a67/status.svg)](https://joss.theoj.org/papers/15647ef7b3dd688b47c1b802a4f50a67)\n\n**Important**: Please check out the [news & updates](https://rayflare.readthedocs.io/en/latest/news.html) page for the most recent updates\nand changes, including any possible backwards compatibility issues.  If you have questions, issues, etc., please check the\ndocumentation and (open and closed) [issues](https://github.com/qpv-research-group/rayflare/issues) first,\nor open a new issue using the relevant template.\n\n# rayflare\nOpen-source, integrated optical modelling of complex stacks. RayFlare incorporates the transfer-matrix method (TMM), \nray-tracing and rigorous coupled-wave analysis (RCWA/FMM), in addition to an angular redistribution matrix method which allows multiple \nmethods to be coupled across a single structure to calculate total absorption/reflection/transmission, absorption per \nlayer, and absorption profiles. \n\nYou can view RayFlare's documentation, including installation instructions [here](https://rayflare.readthedocs.io/en/latest/).\nThe contributing guidelines are [here](CONTRIBUTING.md) and the Code of Conduct is [here](CODE_OF_CONDUCT.md). This package\nis distributed under a [GNU LGPL (version 3) license](GNU_LGPL_v3.txt). If you have questions, issues, etc., please check the\ndocumentation first or open an [issue](https://github.com/qpv-research-group/rayflare/issues) using the relevant template.\n\nIf you use RayFlare in your work, please cite the [JOSS paper](https://doi.org/10.21105/joss.03460):\n\n*Pearce, P. M., (2021). RayFlare: flexible optical modelling of solar cells. Journal of Open Source Software, 6(65), 3460. \nhttps://doi.org/10.21105/joss.03460*\n\n![poster](poster.png \"RayFlare poster\")\n",
    "bugtrack_url": null,
    "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",
    "summary": "Python-based integrated optical modelling",
    "version": "2.0.1",
    "project_urls": {
        "Changelog": "https://rayflare.readthedocs.io/en/latest/news.html",
        "Documentation": "https://rayflare.readthedocs.io",
        "Homepage": "https://github.com/qpv-research-group/rayflare"
    },
    "split_keywords": [
        "ray optics",
        " diffraction",
        " ellipsometry",
        " lens",
        " lens design",
        " lens simulation",
        " light scattering",
        " light trapping",
        " optics",
        " photovoltaics",
        " physics",
        " ray tracing",
        " rcwa",
        " rigorous coupled wave analysis",
        " scattering",
        " thin film",
        " thin film optics",
        " tmm",
        " transfer matrix",
        " wave optics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "68d0c9a359aec144f1bb7b7fed6c398c95db648cb5e932bdad2c098e683aa343",
                "md5": "ccc951d48ce11dd23a2d4250e37ccd53",
                "sha256": "ced1a0b383edf1f9070b249a3f92cb0abe63994d8858828e4eb5c751fe6c3fae"
            },
            "downloads": -1,
            "filename": "rayflare-2.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ccc951d48ce11dd23a2d4250e37ccd53",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 90384,
            "upload_time": "2024-09-26T11:37:59",
            "upload_time_iso_8601": "2024-09-26T11:37:59.460120Z",
            "url": "https://files.pythonhosted.org/packages/68/d0/c9a359aec144f1bb7b7fed6c398c95db648cb5e932bdad2c098e683aa343/rayflare-2.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ff9d5dc5cd48649b855c40aef7ef6b9bdfc75f85baa47a7b22c58669f5459c62",
                "md5": "ef46aa3943cdd0227c117d946c6300a1",
                "sha256": "d6788de39f9981dc2415618e1df62f3dfea2209be9ca8271a3f422f7536a0eca"
            },
            "downloads": -1,
            "filename": "rayflare-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ef46aa3943cdd0227c117d946c6300a1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 77319,
            "upload_time": "2024-09-26T11:38:01",
            "upload_time_iso_8601": "2024-09-26T11:38:01.540462Z",
            "url": "https://files.pythonhosted.org/packages/ff/9d/5dc5cd48649b855c40aef7ef6b9bdfc75f85baa47a7b22c58669f5459c62/rayflare-2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-26 11:38:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "qpv-research-group",
    "github_project": "rayflare",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "rayflare"
}
        
Elapsed time: 0.32253s