lantzproject / lantz-drivers

Other
6 stars 11 forks source link

Adding new drivers, creating naming conventions, fixing bugs, etc #6

Closed mtsolmn closed 4 years ago

mtsolmn commented 4 years ago

This commit adds internal drivers written by the Awschalom Group at UChicago (https://pme.uchicago.edu/group/awschalom-group).

In addition, the driver folders have been modified to institute a naming convention for the file structure (in-line with python PEP standards). This is to make it easier for both new and current users to find drivers and to make it easier for users to contribute new drivers. The driver files themselves should be renamed to follow a standard convention, but that has not been implemented here. The proposed sub-directory naming convention is as follows:

The codebase has been refactored to reflect these changes.

Import statements have been refactored to reflect the new file structure of lantz (separation into different repositories).

The setup.py has been completely rewritten to reflect the current state of the project and pyserial and pyusb have been added as dependencies. The version number has been bumped for release.

@hgrecco @jacobfeder

CHANGELOG: commit to update dependencies and set naming convention for namespace

  1. refactor drivers directory with standarized naming convention:
    • drivers should be in directories of corresponding companies
    • subdirectories should be company names
    • subdirectories should be all lowercase
    • underscores should be used for spaces
    • hyphens only allowed when they are part of the company name (e.g. mini-circuits)
    • separate acronyms from whole worlds in company names (e.g. aa_opto_electronic, bk_precision)
  2. complete rewrite of setup.py using new lantz-core setup.py and add pyserial and pyusb dependencies, update general settings