Skip to content

Revisit units in API #456

@yaelbh

Description

@yaelbh

Based on previous discussions, we currently have the following situation in our T1/T2Ramsey API:

  • Input:
    • The user can provide delay times in different units.
    • Frequency in T2Ramsey is only in Hz.
    • Initial guess units are identical to the units of the rest of the input: always Hz for frequency, and for T1/T2* the guess unit is the same as the one of the delays.
  • Output is always in SI.

I remember that we considered doing everything in SI, including input, and decided not to. But I don't remember what were the arguments.

@nkanazawa1989, working on #427, has now new arguments for allowing initial guesses to be only in SI. I don't like having one rule for delay times and another rule for the initial guess, I find it an inconsistent and confusing API.

Therefore I'd like to revisit the decision to allow delay times not in SI. If we decide that it's really important, then we should keep it also for the initial guess, in spite of @nkanazawa1989's reservations. However we may also decide that removing units from the API and working in SI all over is cleaner.

I'll be happy to hear opinions of users.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions