Python Hardware Wrappers

This repository contains python wrappers that can be used to access hardware commonly used inside of the Digonnet lab at Stanford. For more documentation, visit http://github.jamwheeler.com/hardware

This changelog follows the recommendations put forth at keepachangelong.com

[0.3.0] - [2018-07-12]

Added

• Travis integration
• Code coverage integration through codecov.io
• A test suite has been added. These tests are run via pytest. A few of these test cases haven't been properly implemented for the various instruments, and Travis really can't handle any of the test cases yet.
• A windows makefile has been created, that can be run via make help, make test, make upload, etc...
• Units, provided via pint, are now widely implemented in the repository. There are still a few places that they haven't reached, but these will require some overhauling in the future.
• Most classes now provide automatic logging when parameters are changed.

[0.2.0] - [2018-01-23]

Added

• Gyro objects now can have their properties accessed as if they were a dictionary. For example: fog['name'], fog['pitch'].
• Gyro objects can be autoloaded from the __init__.py script by setting an environment variable DEFAULT_GYRO, which contains the absolute path to the desired gyros JSON file.
• Gyros objects can now be returned via the __repr__ function in print(fog). This will be handy when showing them in a Tombstone object.

Changed

• Gyro scale factor code now uses sensitivity and pitch from either parameter arguments or JSON file values.

FAQ

• When passing values to setter functions, the units must be specified. Units must come from the same pint.UnitRegistry() as that used by hardware

[0.1.0] - [2017-12-10]

This version merely contains all of the code developed up until this point.