https://github.com/sandialabs/suncal
Suncal - Sandia PSL Uncertainty Calculator
https://github.com/sandialabs/suncal
calibration measurement python scr-2282 snl-applications uncertainty
Last synced: 5 months ago
JSON representation
Suncal - Sandia PSL Uncertainty Calculator
- Host: GitHub
- URL: https://github.com/sandialabs/suncal
- Owner: sandialabs
- License: gpl-3.0
- Created: 2019-01-15T19:45:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-13T02:43:46.000Z (6 months ago)
- Last Synced: 2025-04-29T18:08:44.963Z (5 months ago)
- Topics: calibration, measurement, python, scr-2282, snl-applications, uncertainty
- Language: Python
- Homepage:
- Size: 118 MB
- Stars: 17
- Watchers: 6
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: changes.md
- License: LICENSE
Awesome Lists containing this project
README
# Uncertainty Calculator
Sandia UNcertainty CALculator (SUNCAL)
Copyright 2019-2023 National Technology & Engineering Solutions of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software.
This software is distributed under the GNU General Public License.
---
This tool was developed by the Primary Standards Lab at Sandia National Laboratories to calculate the combined uncertainty of a
multi-variable system. Contact uncertainty@sandia.gov.
## Installation
Installation of the Python package and command line interface requires Python 3.9+ with the following packages:
- numpy
- scipy
- sympy
- matplotlib
- pyqt5
- pyyaml
- markdown
- pint
To install (on Windows, Mac, or Linux), from a command prompt, run:
```
pip install suncal
```
## Example Usage
From a python terminal, script, or notebook:
```
import suncal
u = suncal.Model('A*B')
u.var('A').measure(100).typeb(unc=0.1)
u.var('B').measure(2).typeb(unc=0.01)
u.calculate()
```
See the PDF user's manual and the example notebook files in the docs folder for a complete reference guide.
## Command-line script
A script named suncal will be installed to your system path. From a command line, run:
`suncal file`
where file is the filename of a setup file. See doc/examples folder for
example setup files. Refer to the PDF user's manual for other commands.
## User interface
A graphical user interface is installed with the Python package. Pre-built executables are available from https://sandiapsl.github.io.
To launch the user interface from a command line, run:
`suncalui`
or
`python -m suncal.gui`