Naming conventions to increase usability and lower entrance hurdle to QCoDes
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 459
- Forks
- 359
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 73
Description
As a newcomer to QCodes I had some difficulties to get started with some simple instruments. One difficulty was owed to non-stringent naming of quantities. As an example consider the line
```
loop = qc.Loop(dac.ch03.v.sweep(0, 5, 0.1), delay=0.001).each(dmm.volt)
```
Here we loop over a channel of the QDac and read values with the Keysight34465A. I find it quite confusing that we are once using "volt" and once "v" and in other places "voltage".
I suggest we make a naming convention for commonly used properties, so that the drivers form a more integral code base.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the driver APIs represented by `dac.ch03.v.sweep(0, 5, 0.1)` and `dmm.volt`, then compare their use of `v`, `volt`, and `voltage`. Define the scope of a consistent naming convention across commonly used properties before identifying the affected drivers. Done means the convention is agreed and applied consistently across the relevant driver interfaces.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100