Skip to content

Python tools to compute and display lighting flicker data.

License

Notifications You must be signed in to change notification settings

yeutterg/beautiful-flicker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Beautiful Flicker

A set of Python tools to compute and display lighting flicker data.

For example, it can plot a flicker waveform and display automatically-computed flicker metrics:

Flicker Waveform

It can plot the flicker frequency and percentage on an IEEE PAR 1789-2015 flicker graphic:

IEEE 1789 Flicker Graphic

This tool can be scripted for use in automated test scenarios. For custom versions of this software and testing services, please get in touch.

Disclaimer: This tool is an early alpha version! Things may not work, and breaking changes may occur between versions. Please open a new issue or submit a pull request if you encounter any problems. Please open a new issue for feature requests.

See also: Beautiful Photometry

Install and Use

Local Version

Make sure you have Python installed in your environment. This only works with Python 3.5+.

Clone this repository, cd to the downloaded directory, and install necessary dependencies:

pip install -r src/requirements.txt

To use Jupyter Notebooks, run from the root of this project:

jupyter notebook examples/

Docker Version

Alternatively, you can run this project in Docker. This is more likely to work across different systems.

Instructions for Docker are provided in DOCKER.md

Examples

Examples of how to use this project can be found in the examples folder:

Documentation

In addition to the heavily-documented codebase, an HTML version of the documentation is available. Access it by cloning the repository and opening this location in your browser:

/docs/build/html/index.html

Selected Flicker Resources

License

Distributed under the MIT license.

About

Python tools to compute and display lighting flicker data.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages