nrbgt / ir-primer

A visual explanation of the infrared spectrum

IR Primer

A visual explanation of the infrared spectrum

Development

Install NodeJS. Install bower.

npm install .
bower install

Source files are written in whitespace-picky preprocessed languages, and are configured to run continuously, watching for changes in src/ and output to dist/:

• npm run jade for HTML from Jade
• npm run stylus for CSS from Stylus
• npm run coffee for Javascript from Coffeescript

For your hacking convenience, all of these are wrapped together with a live-updating server:

npm run live

This will generate an .html file for each of the explanations, which has all self-contained dependencies.

IPython/Jupyter Notebook integration

A small python wrapper around the built javascript/css allows all the explanations to be embedded inside an IPython Notebook, generally one per cell.

from irprimer import Temperatures, Planck
Temperatures()
Planck()

Additionally provided is a function for generating a self-contained Reveal.js slideshow. Put this in a skip slide at the end.

from irprimer import slides
slides()

Contributing

Issues and pull requests welcome, especially for improvement of the science and teach-ability of the content!

License

IR Primer is published under the BSD 3-clause license. Bower dependencies are licensed respectively.