-
Notifications
You must be signed in to change notification settings - Fork 3
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
Function and documentation updates #64
Conversation
…nits. it'd be too much to change all the unit calls right now.
I started looking into what's being done with the eval statements and they are unique. |
@ChristensenCode - Thank you for your work! These look like great improvements. I have a few questions/comments:
|
@lymereJ I'll run black on the files and update the contribution docs to reference using black when making contributions. I don't work at PNNL, but I would like to. I figured jumping in on some open source work might be a good place to start. This probably won't happen until this evening and I'm on east coast time. |
the pull request for units and doc changes and replaced the print statements replace this request so I can close this one. Since I cherry-picked the logging changes for that pull request, there might be some conflicts with the units and docs changes. |
Part 1 - December 6, 2022
The logic for the existing units class looked a little convoluted and I thought it might nicer to have it as a class. This way we can store all the conversions and the method names clearly define how the unit is changing. In addition, we can store common conversions in here like F to C, which is used in a few places in the code.
I updated the units tests to cover the new methods, but replacing the existing Units class look like a big task, so that will be done later.
I also started making a constants file for storing constants. The constants can then be defined in one place and referenced where they originated from.
Part 2 - December 10, 2022
Started updating the documentation to capture what data should be in the instruction set json file.
Added the sample json file from the documentation to give new users a starting point.