Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Naming conventions #17

Closed
alexforencich opened this issue Jul 23, 2015 · 4 comments
Closed

Naming conventions #17

alexforencich opened this issue Jul 23, 2015 · 4 comments

Comments

@alexforencich
Copy link
Member

I think we need to figure out some conventions on how to organize and name files for the drivers. I am presuming that we will organize drivers by manufacturer, as this seems to be the most sensible method.

For common base classes that are used by multiple drivers, I suggest storing these in a folder called 'common'. I think the driver dev branch has 'standards' right now, but that to me indicates something along the lines of calibration standards or something along those lines and not driver components. Thoughts?

For individual drivers, there is a strong possibility that model numbers will start with numbers, which is not allowed for a file name. So, what is the sensible solution in this case? In python-ivi, I duplicated the manufacturer name. I suppose this makes things a little verbose, but I think it makes the most sense and it's unambiguous. Another option might be adding a standard prefix, perhaps model_.

For manufacturers that have changed names multiple times (i.e. HP/Agilent/Keysight/???) what makes the most sense? Put everything under the most recent name (i.e. keysight)? Put instrments under the faceplate name (hp for the really old stuff, agilent for most things, keysight for new stuff)? Something else?

@MatthieuDartiailh
Copy link

We already have an issue in lantz_driver about this. I think we agreed about the vendor stuff and aliasing instrument as necessary for hp/agilent/keysight.

@alexforencich
Copy link
Member Author

Sigh, this is the problem with not having a single unified discussion board....issue is here: LabPy/lantz_drivers#1

@MatthieuDartiailh
Copy link

Sorry for that.

@alexforencich
Copy link
Member Author

That's alright, I completely forgot about that. I do remember discussing it, I just didn't check the right issue page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants