-
Notifications
You must be signed in to change notification settings - Fork 471
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
Updated definition of US survey units to reflect the 2022 revision by NIST/NGS #1920
base: master
Are you sure you want to change the base?
Updated definition of US survey units to reflect the 2022 revision by NIST/NGS #1920
Conversation
pint/default_en.txt
Outdated
@@ -538,23 +538,31 @@ neper = 1 ; logbase: 2.71828182845904523536028747135266249775724709369995; logfa | |||
cubic_yard = yd ** 3 = cu_yd | |||
@end | |||
|
|||
# Note: historically, many of the units in this group were derived from each other (e.g. 1 chain = 10 fathoms = 4 rods = 100 links) | |||
# but we've followed the NIST's lead here and defined all of the units directly based on "common" units (feet and miles) | |||
# Source: U.S. Survey Foot: Revised Unit Conversion Factors <https://www.nist.gov/pml/us-surveyfoot/revised-unit-conversion-factors> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The blog-like post may disappear. The real citation that you could add as proposed at the bottom of #1912 (comment) is:
Warfield, L. , Konijnenburg, J. , Lippa, K. , Lee, G. , Minnich, L. and Williams, J. (2023), Specifications, Tolerances, and Other Technical Requirements for Weighing and Measuring Devices as adopted by the 108th National Conference on Weights and Measures, Handbook (NIST HB), National Institute of Standards and Technology, Gaithersburg, MD, [online], https://doi.org/10.6028/NIST.HB.44-2024, https://tsapps.nist.gov/publication/get_pdf.cfm?pub_id=956954 (Accessed January 11, 2024)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In principle the DOI would be enough. Minimal form of reference:
Handbook (NIST HB) - 44-2024, http://dx.doi.org/https://doi.org/10.6028/NIST.HB.44-2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you. I updated both sources accordingly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks fine. Data and source are correct.
Many will look at the diff of this unit definitions file. So you could make it a bit easier to review the changes (see comments).
league = 3 * mile | ||
link = 0.66 * foot = li = survey_link | ||
rod = 16.5 * foot = rd = pole = perch | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please keep the order from small to big length unit to make diffs simpler to follow
acre_foot = acre * survey_foot = _ = acre_feet | ||
# The adoption of the international foot in 1959 temporarily permitted the continued use of the 1893 definition of the foot for survey purposes. | ||
# That established the Survey Foot. After 2022, that exception was no longer permitted and all feet are feet (survey or otherwise). | ||
# Source: Barton, J. , Blackwell, B. , Butcher, T. , Harshman, R., Lee, G. , Olson, D. (2019), Specifications, Tolerances, and Other Technical Requirements for Weighing and Measuring Devices as adopted by the 108th National Conference on Weights and Measures 2019, Handbook (NIST HB), National Institute of Standards and Technology, Gaithersburg, MD, [online], h: https://doi.org/10.6028/NIST.HB.44-2020 (Accessed January 12, 2024) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here is an extra h:
before the doi-link.
rod = 16.5 * foot = rd = pole = perch | ||
|
||
square_rod = rod ** 2 = sq_rd = sq_rod = sq_pole = sq_perch | ||
acre = 43560 * square_foot |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You could leave it as is was to minimize diffs. acre = 10 * chain ** 2
According to NIST HB 44-2024, the original citation is Federal Register (85 FR 62698, Oct. 5, 2020) pp. 62698-62708. Despite the deprecation, the old units are still available for working with historical data, prefixed by the letter "s" - i.e., sft and smi (which are already in pint), but also sli, srd, sch, sfur, and sac for link, rod, chain, furlong and acre, respectively. So, it might be appropriate to still have those definitions in USCSLengthSurvey, and put the new survey measures into USCSLengthInternational? Then the deprecation notice can go into USCSLengthSurvey? https://www.govinfo.gov/content/pkg/FR-2020-10-05/pdf/2020-21902.pdf |
@jacob-indigo what do you think about @dbhart proposal? |
Addresses issue #1912.
This is my first time contributing to Pint so I wasn't sure what your deprecation and versioning practices are. I added a placeholder in
CHANGES
for now but let me know what version you'd include this in (given that it's technically a breaking change) and how/if some notice should be given ahead of time (e.g.warn("The definition of acre will change in version 0.x to conform the 2022 revision by NIST")
or whatever).pre-commit run --all-files
with no errors