Technical University of Munich logo
Max Planck Institute for Biological Cybernetics logo

About luox

A user-friendly, open-access platform for calculating quantities related to light and lighting

    • The purpose of the luox platform is to faciliate the calculation of quantities related to light and lighting in a user-friendly, open-access and free fashion. Users can upload spectra (which are only stored in the browser) and the platform will calculate relevant quantites (including (il)luminance, chromaticity, and α-opic (ir)radiance and α-opic daylight (il)luminances) from the spectra, generate a visualisation of the spectrum, and enable the export of calculations in tabular form. All default quantities reported here are supported by the International Commission on Illumination (CIE).

      The platform is primarily geared towards researchers and research users interested in the effects of light exposure on human physiology and behaviour, but it may be interesting to students, academics and professionals in other disciplines and areas.

      luox is deployed on Netlify.

    • This platform was developed by Prof. Dr. Manuel Spitschan (Technical University of Munich and Max Planck Institute for Biological Cybernetics) and Go Free Range. Code to calculate colour indices was developed by Dr. Somang Nam and Dr. Jennifer A. Veitch at the National Research Council of Canada – Construction Research Centre, in collaboration with Dr. Spitschan.

    • If you use luox for calculations, please cite the following (APA format):

      Software:

      Spitschan, M., Nam, S., & Veitch, J. A. (2022). luox: Platform for calculating quantities related to light and lighting [Software]. Available from https://luox.app/.

      Companion paper:

      Spitschan, M., Mead, J., Roos, C., Lowis, C., Griffiths, B., Mucur, P., Herf, M., Nam, S., & Veitch, J. A. (2022). luox: novel validated open-access and open-source web platform for calculating and sharing physiologically relevant quantities for light and lighting. Wellcome Open Res, 6, 69. doi:10.12688/wellcomeopenres.16595.3

      For citing the source code:

      Spitschan, M., Nam, S., & Veitch, J. A. (2022). luox: Platform for calculating quantities related to light and lighting [Source code]. Available from https://github.com/luox-app/luox.

      When reporting quantities related to CIE S 026, we also recommend citing the standard:

      CIE (2018). CIE S 026/E:2018: CIE System for Metrology of Optical Radiation for ipRGC-Influenced Responses to Light. Vienna: CIE Central Bureau. DOI: 10.25039/S026.2018.

      When citing other outputs from this software, we recommend citing the appropriate documents, listed below.

    • For any support-related questions, please email luox-support@tuebingen.mpg.de. Please be as specific as possible in your request.

    • To report bugs and suggest new features, please raise an issue on the project's GitHub page. When reporting a bug or any other issue, you need to be as specific as possible:

      • Include concrete and specific steps to reproduce your problem, including any files that pose an issue
      • If the problem only occurs occasionally but is reproducible, please include any additional contextual information
      • If the problem is not reproducible, it may not be useful to submit a bug report

    • Funding to develop luox was provided by:

      The development of the module for loading SPDX files was supported by the Illumating Engineering Society (IES).

      During development of the platform, Dr Manuel Spitschan was supported by a Sir Henry Wellcome Postdoctoral Fellowship (Wellcome Trust, 204686/Z/16/Z) and Linacre College, University of Oxford (Biomedical Sciences Junior Research Fellowship).

      The module for calculating CIE colour indices (Duv, Tcp, Ra, and Rf ), the power user mode, and the optional IES TM-30-20 indices and graphics was developed at the National Research Council of Canada, Construction Research Centre, as a strategic research activity.

      Deployment on Netlify is supported by the Netlify Open Source Plan.

    • We welcome contributions. To contribute code, please create a fork and issue a pull request on GitHub.

      Contributor Covenant Code of Conduct

      Our Pledge

      We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

      We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

      Our Standards

      Examples of behavior that contributes to a positive environment for our community include:

      • Demonstrating empathy and kindness toward other people
      • Being respectful of differing opinions, viewpoints, and experiences
      • Giving and gracefully accepting constructive feedback
      • Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
      • Focusing on what is best not just for us as individuals, but for the overall community

      Examples of unacceptable behavior include:

      • The use of sexualized language or imagery, and sexual attention or advances of any kind
      • Trolling, insulting or derogatory comments, and personal or political attacks
      • Public or private harassment
      • Publishing others' private information, such as a physical or email address, without their explicit permission
      • Other conduct which could reasonably be considered inappropriate in a professional setting

      Enforcement Responsibilities

      Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

      Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

      Scope

      This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

      Enforcement

      Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement via email at manuel.spitschan@tum.de. All complaints will be reviewed and investigated promptly and fairly.

      All community leaders are obligated to respect the privacy and security of the reporter of any incident.

      Enforcement Guidelines

      Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

      1. Correction

      Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

      Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

      2. Warning

      Community Impact: A violation through a single incident or series of actions.

      Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

      3. Temporary Ban

      Community Impact: A serious violation of community standards, including sustained inappropriate behavior.

      Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

      4. Permanent Ban

      Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

      Consequence: A permanent ban from any sort of public interaction withi the community.

      Attribution

      This Code of Conduct is adapted from the Contributor Covenant version 2.0.

      Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.

      For answers to common questions about this code of conduct, see the FAQ. Translations are available.

    • We provide a documented wizard for uploading your files to the platform.

    • Spectra and calculations within the luox platform can be shared using an URL that directly encodes the uploaded spectrum/spectra using Michael Herf's spdurl package. The sharing URL will open a view-only version of the platform. To copy the sharing URL, scroll down to the bottom of the page. Before sharing the URL, please double-check that it opens spectrum/spectra as expected.

    • We offer the option to request a digital object identifier (DOI) linked to the sharing URL. This DOI has to be requested manually and the request will be vetted manually. To request a DOI, please complete this form. The DOI will be generated by generating an entry for the sharing URL in the MPG.PuRE and author information will be included in the record. All luox sharing URLs added to ORA will receive a unique luox number of the format (YYYY-####; Y=year). A running list of luox sharing URLs with associated DOIs is on this page, under Depositions. Please note that deposition of the sharing URL into MPG.PuRE is permanent.

    • The following is a list of depositions with assigned DOIs, up-to-date as of 1 February 2022.

      Deposition IDDateDOIDepositor
      luox-2021-000123 January 2021TBDManuel Spitschan, University of Oxford
      luox-2021-000218 February 202110.5287/bodleian:AeZAXN1kmJan-Frieder Harmsen, Maastricht University
      luox-2021-000318 February 202110.5287/bodleian:dp7QEqYAmJan-Frieder Harmsen, Maastricht University
      luox-2021-000418 February 202110.5287/bodleian:0ogQP5bb5Jamie Zeitzer, Renske Lok & Daniel Joyce, Stanford University
      luox-2022-000101 February 202210.17617/2.3364820Boris Hanák, Spectrasol
      luox-2022-000201 February 202210.17617/2.3364831Jamie Zeitzer, Stanford University
  • The following individuals tested and provided feedback on an early version of the platform: Paul O'Mahoney, Tos Berendschot, Isabel Schöllhorn, Christine Blume, Katharina Wulff, Kinjiro Amano, Tony Esposito, Minchen Tommy Wei, Suzanne Ftouni, Paula M. Esquivias, Gayline Manalang Jr., Daniel Garside, Joachim Stormly Hansen, and Hao Xie.

  • What's in these terms?

    These terms tell you the rules for using our website https://luox.app/ (our site).

    Who we are and how to contact us

    Our site operated by the joint research group Chronobiology & Health at the Technical University of Munich and Translational Sensory and Circadian Neuroscience at the Max Planck Institute for Biological Cybernetics (Prof. Dr. Manuel Spitschan). To contact us, please email manuel.spitschan@tum.de.

    By using our site you accept these terms

    By using our site, you confirm that you accept these terms of use and that you agree to comply with them.

    If you do not agree to these terms, you must not use our site.

    We recommend that you print a copy of these terms for future reference.

    We may make changes to these terms

    We amend these terms from time to time. Every time you wish to use our site, please check these terms to ensure you understand the terms that apply at that time.

    We may make changes to our site

    We may update and change our site from time to time to ensure it is up to date.

    We may suspend or withdraw our site

    Our site is made available free of charge.

    We do not guarantee that our site, or any content on it, will always be available or be uninterrupted. We may suspend or withdraw or restrict the availability of all or any part of our site for business and operational reasons. We will try to give you reasonable notice of any suspension or withdrawal.

    You are also responsible for ensuring that all persons who access our site through your internet connection are aware of these terms of use and other applicable terms and conditions, and that they comply with them.

    How you may use material on our site

    The contents of our site are owned by us or, where content has been provided by third parties, by those third parties. The copyright in the material contained on our site belongs to us or our licensors. It is your responsibility to seek appropriate consent to re-use any contents of our site.

    Do not rely on information on this site

    The content on our site is provided for general information only and is not intended to amount to advice on which you should rely. You must obtain professional or specialist advice before taking, or refraining from, any action on the basis of the content on our site.

    Although we make reasonable efforts to update the information on our site, we make no representations, warranties or guarantees, whether express or implied, that the content on our site is accurate, complete or up to date.

    We are not responsible for websites we link to or third party information

    Where our site contains links to other sites and resources provided by third parties, these links and resources are provided for your information only. Such links should not be interpreted as approval by us of those linked websites or information you may obtain from them.

    We have no control over the contents of those sites or resources.

    User-generated content is not approved by us

    This website may include information and materials uploaded by other users of the site. This information and these materials have not been verified or approved by us. The views expressed by other users on our site do not represent our views or values.

    Our responsibility for loss or damage suffered by you

    To the extent permitted in law, we accept no liability for any loss or damage which may be suffered by you or by other parties as a direct or indirect result of using our site (including loss of profit, loss of opportunity, loss of business, and consequential loss).

    We are not responsible for viruses and you must not introduce them.

    We do not guarantee that our site will be secure or free from bugs or viruses.

    You are responsible for configuring your information technology, computer programmes and platform to access our site. You should use your own virus protection software.

    You must not misuse our site by knowingly introducing viruses, trojans, worms, logic bombs or other material that is malicious or technologically harmful. You must not attempt to gain unauthorised access to our site, the server on which our site is stored or any server, computer or database connected to our site. You must not attack our site via a denial-of-service attack or a distributed denial-of service attack. By breaching this provision, you would commit a criminal offence under the Computer Misuse Act 1990. We will report any such breach to the relevant law enforcement authorities and we will co-operate with those authorities by disclosing your identity to them. In the event of such a breach, your right to use our site will cease immediately.

    Rules about linking to our site

    You may link to our home page, provided you do so in a way that is fair and legal and does not damage our reputation or take advantage of it.

    You must not establish a link in such a way as to suggest any form of association, approval or endorsement on our part where none exists.

    You must not establish a link to our site in any website that is not owned by you.

    Our site must not be framed on any other site, nor may you create a link to any part of our site other than the home page.

    We reserve the right to withdraw linking permission without notice.

    If you wish to link to or make any use of content on our site other than that set out above, please contact manuel.spitschan@tum.de.

    Which country's laws apply to any disputes?

    These terms of use, their subject matter and their formation (and any non-contractual disputes or claims) are governed by German law.

    • Latest tag: wellcome-open-research
    • Latest commit SHA: fe38483db011a577d645853be9f8ae371f952297