pub_soft/openfe
3
0
Fork 0
mirror of https://github.com/OpenFreeEnergy/openfe.git synced 2026-06-04 14:14:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add docstring to explain the rounding in gather (#1687)

Browse Source 
* Add docstring to explain the rounding in gather

* Update openfecli/commands/gather.py

Co-authored-by: David W.H. Swenson <david.swenson@omsf.io>

* formatting: one sentence per line

* Apply suggestions from code review

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>

---------

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Alyssa Travitz <alyssa.travitz@omsf.io>
This commit is contained in:
David W.H. Swenson
2025-11-24 09:16:26 -06:00
committed by GitHub
parent f710d3c1e9
commit 20ae9f88a0
1 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
openfecli/commands/gather.py
View File

@@ -49,7 +49,24 @@ def format_estimate_uncertainty(
unc: float,
unc_prec: int = 1,
) -> tuple[str, str]:
"""Truncate raw estimate and uncertainty values to the appropriate uncertainty.
"""
Round raw estimate and uncertainty values to the appropriate precision.
The premise here is that, if you're reporting your uncertainty to a certain number of significant figures, your estimate should be reported to the same precision.
As an example, assume your raw estimate is 12.34567 and your raw uncertainty is 0.0123.
Say you want to report your uncertainty to 2 significant figures.
So your rounded uncertainty is 0.012.
You should report your estimate to the same precision, so your rounded estimate should be 12.346.
On the other hand, if you wanted to report your uncertainty to the first significant figure (0.01), then you should report your estimate as 12.35.
You need to report these to the same precision (not the same number of significant figures) because the two numbers need to be added together.
If you report both to 2 significant figures, you'd have 12.0 +/- 0.0012, and your actual estimate falls way outside your error bars!
It has to be the uncertainty that determines the precision of the estimate, because if you said you had 3 significant figures in the estimate and used that to set the precision of the uncertainty, you'd have 12.3 +/- 0.0 -- no error at all!
We implement this by thinking of the decimal representation as "columns" centered on the decimal point.
We get the column index of the first non-zero number in the decimal representation of the uncertainty, and use the fact that ``np.round`` rounds to the number of decimal places you give it to report the estimate.
The uncertainty is rounded to the desired number of significant figures.
Parameters
----------