luox-NRC-CIERf is a module to calculate parameters for light source colour appearance and colour rendering in the luox platform.
luox-NRC-CIERf is a fork of the luox project, which is an open-source web platform for calculating quantities that describe light exposures. Quantities for the intensity of light exposure in terms of the international standard CIE S026:2018 were calculated in the original release. The luox-NRC-CIERf module, developed at the NRC in collaboration with the site’s original creator, adds indices related to light source colour appearance and colour rendering, principally those from publication CIE 224:2017 CIE 2017 Colour Fidelity Index for accurate scientific use. Users may also choose to view indices and colour vector graphics following the Illuminating Engineering Society TM-30-20 IES method for evaluating light source color rendition. This module also adds a ‘power mode’ permitting the user to submit any number of spectra simultaneously for calculation.
This module 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. Manuel Spitschan (Translational Sensory & Circadian Neuroscience, Max Planck Institute for Biological Cybernetics and Technical University of Munich, Germany).
Nam, S., Veitch, J. A., & Spitschan, M. (2022). CIE Colour Fidelity Index module for luox (luox-NRC-CIERf) [Source code]. National Research Council of Canada. https://github.com/nrc-cnrc/luox-NRC-CIERf.
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 Research, 6, 69. https://doi.org/10.12688/wellcomeopenres.16595.3
luox-NRC-CIERf is distributed as free software under the terms of the GNU GPL-3.0 licence (https://www.gnu.org/licenses/gpl-3.0.en.html) Please review the LICENCE document for the licensing terms.
luox-NRC-CIERf is a fork of the luox project. File additions and modifications by the National Research Council of Canada (NRC) are Copyright (C) 2022 His Majesty the King in Right of Canada.
The app is made up of HTML, CSS and JavaScript. We're using ES2015 modules and we use webpack to bundle the application. The core of the application is pure JavaScript and the user interface uses React.
We use Prettier to ensure consistent code formatting and ESLint with Airbnb's JavaScript style guide to automatically find and fix problems as well as enforcing a particular code style in our JavaScript.
$ brew install nvm
$ # Follow instructions to configure your bash config
$ cd /path/to/lightbox
$ nvm install
$ nvm use
Found '/path/to/lightbox/.nvmrc' with version <v10.19.0>
Now using node v10.19.0 (npm v6.13.4)
$ npm install
The tests are written using Jest.
$ npm test
$ npm start