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

Introduce Unit Literals #285

Open
6 tasks
ryanmrichard opened this issue Feb 16, 2022 · 4 comments
Open
6 tasks

Introduce Unit Literals #285

ryanmrichard opened this issue Feb 16, 2022 · 4 comments

Comments

@ryanmrichard
Copy link
Member

ryanmrichard commented Feb 16, 2022

The resolution of #113 was that we should:

  • specify units at user-facing APIs to avoid ambiguity, and
  • internally store quantities in atomic units

This is going to be API breaking and should be done before a 1.0 release.

I foresee the following tasks:

  • Unit Literal Design #286
  • Decide on unit conventions #287
  • ensure that the design decisions make it into the documentation for future generations
  • add units to classes in Chemist
    • my vote is to do this by operator overloading (i.e., next to the options which don't take units) to avoid breaking downstream repos
  • update downstream repos to use units where necessary (this is probably a number of tasks in and of itself)
  • remove overloads which don't take units
@twindus
Copy link

twindus commented Feb 16, 2022

Since it will be API breaking, we should plan the timing of the check in carefully.

@twindus
Copy link

twindus commented Feb 17, 2022

On the Python side, I know people have been using Pint for unit conversion. We probably don't want to go this way, but thought I would throw it out there.

@ryanmrichard
Copy link
Member Author

@wadejong and @twindus I started a design issue, #286, and copied these links there.

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

3 participants