https://github.com/bertcarnell/pysigfig
A package for creating and manipulating floating point numbers accounting for significant figures
https://github.com/bertcarnell/pysigfig
Last synced: 17 days ago
JSON representation
A package for creating and manipulating floating point numbers accounting for significant figures
- Host: GitHub
- URL: https://github.com/bertcarnell/pysigfig
- Owner: bertcarnell
- License: mit
- Created: 2020-09-06T01:20:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-30T18:18:22.000Z (over 4 years ago)
- Last Synced: 2024-10-10T09:37:24.553Z (8 months ago)
- Language: Python
- Size: 55.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pysigfig
A package for creating and manipulating floating point numbers accounting for significant figures
[](https://pypi.org/project/pysigfig/)
## Quickstart
```{python}
import math
import pysigfig as pysf
# a number with 4 singificant digits
x = pysf.Float("1.234")
# a number with 3 significant digits
y = pysf.Float("31.1")
z1 = x + y
z2 = x * y
# z1 should have tenths digit as the least significant
print(z1)
# z2 should have 3 significant digits
print(z2)
area = pysf.Const(math.pi) * pysf.Float("2.0")**2
# area should have 2 significant digits
print(area)
```
### References
For a simple overview of arithmetic with significant figures, see the [Wikipedia Page](https://en.wikipedia.org/wiki/Significance_arithmetic).
## Methods of Entry
```{python}
# Enter a floating point number and specify the number of significant digits
pysf.Float(1.2345, 2)
pysf.Float(1.2, 8)
# Enter the string representation
pysf.Float("1.23") # 3 sig figs
pysf.Float("1.230000") # 7 sig figs
pysf.Float("0.0045") # 2 sig figs
pysf.Float("100000") # 6 sig figs
pysf.Float("1.0E+06") # 2 sig figs
# Enter a constant
pysf.Const(2)
pysf.Const(math.pi)
```
### Limitations
`pysigfig` cannot accept a string like "100000" and assign only one significant digit to it. However, this can be entered in scientific notation or as a float.
```{python}
# Enter 100000 with 1 significant figure
pysf.Float("1E+05")
pysf.Float(100000, 1)
```