# 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`
A shortcut to this can be put on your desktop, etc.
Raw data
{
"_id": null,
"home_page": "https://sandiapsl.github.io",
"name": "suncal",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "uncertainty,metrology,measurement,GUM",
"author": "Collin J. Delker",
"author_email": "uncertainty@sandia.gov",
"download_url": "https://files.pythonhosted.org/packages/46/aa/95eff89b30b402c6ab4bd75f20c984802c9fabfb2252ec98335b98b919d6/suncal-1.6.3.tar.gz",
"platform": null,
"description": "# Uncertainty Calculator\r\n\r\nSandia UNcertainty CALculator (SUNCAL)\r\n\r\nCopyright 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.\r\nThis software is distributed under the GNU General Public License.\r\n\r\n---\r\n\r\nThis tool was developed by the Primary Standards Lab at Sandia National Laboratories to calculate the combined uncertainty of a\r\nmulti-variable system. Contact uncertainty@sandia.gov.\r\n\r\n\r\n## Installation\r\n\r\nInstallation of the Python package and command line interface requires Python 3.9+ with the following packages:\r\n\r\n- numpy\r\n- scipy\r\n- sympy\r\n- matplotlib\r\n- pyqt5\r\n- pyyaml\r\n- markdown\r\n- pint\r\n\r\nTo install (on Windows, Mac, or Linux), from a command prompt, run:\r\n\r\n```\r\npip install suncal\r\n```\r\n\r\n## Example Usage\r\n\r\nFrom a python terminal, script, or notebook:\r\n\r\n```\r\nimport suncal\r\nu = suncal.Model('A*B')\r\nu.var('A').measure(100).typeb(unc=0.1)\r\nu.var('B').measure(2).typeb(unc=0.01)\r\nu.calculate()\r\n```\r\n\r\nSee the PDF user's manual and the example notebook files in the docs folder for a complete reference guide.\r\n\r\n\r\n## Command-line script\r\n\r\nA script named suncal will be installed to your system path. From a command line, run:\r\n\r\n`suncal file`\r\n\r\nwhere file is the filename of a setup file. See doc/examples folder for\r\nexample setup files. Refer to the PDF user's manual for other commands.\r\n\r\n\r\n## User interface\r\nA graphical user interface is installed with the Python package. Pre-built executables are available from https://sandiapsl.github.io.\r\n\r\nTo launch the user interface from a command line, run:\r\n\r\n`suncalui`\r\n\r\nA shortcut to this can be put on your desktop, etc.\r\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "Sandia PSL Uncertainty Calculator",
"version": "1.6.3",
"project_urls": {
"Documentation": "https://sandiapsl.github.io",
"Homepage": "https://sandiapsl.github.io",
"Source Code": "https://github.com/SandiaPSL/UncertaintyCalc"
},
"split_keywords": [
"uncertainty",
"metrology",
"measurement",
"gum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6181936c308aeafd256023ef917fa5774037830bca1a189640063a6514f8a1da",
"md5": "c100cfd606eadb80fb4b581a0384fd77",
"sha256": "b1cecabedd05b7ba0e1c59c3a5537a14e75c989ffe56f490bd34049a4ef152b6"
},
"downloads": -1,
"filename": "suncal-1.6.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c100cfd606eadb80fb4b581a0384fd77",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 423046,
"upload_time": "2023-05-26T20:18:59",
"upload_time_iso_8601": "2023-05-26T20:18:59.885771Z",
"url": "https://files.pythonhosted.org/packages/61/81/936c308aeafd256023ef917fa5774037830bca1a189640063a6514f8a1da/suncal-1.6.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46aa95eff89b30b402c6ab4bd75f20c984802c9fabfb2252ec98335b98b919d6",
"md5": "6cab5c64abe221b36eaf584998fbbe9e",
"sha256": "e99f9733499263d5c2f96c7f08ab5a2ee4681cad56a9546c44235e678fc3b4d8"
},
"downloads": -1,
"filename": "suncal-1.6.3.tar.gz",
"has_sig": false,
"md5_digest": "6cab5c64abe221b36eaf584998fbbe9e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12016522,
"upload_time": "2023-05-26T20:19:58",
"upload_time_iso_8601": "2023-05-26T20:19:58.247711Z",
"url": "https://files.pythonhosted.org/packages/46/aa/95eff89b30b402c6ab4bd75f20c984802c9fabfb2252ec98335b98b919d6/suncal-1.6.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-26 20:19:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SandiaPSL",
"github_project": "UncertaintyCalc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "sympy",
"specs": [
[
"==",
"1.11.1"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"1.24.1"
]
]
},
{
"name": "matplotlib",
"specs": [
[
"==",
"3.6.2"
]
]
},
{
"name": "pyyaml",
"specs": [
[
"==",
"6.0"
]
]
},
{
"name": "markdown",
"specs": [
[
"==",
"3.4.1"
]
]
},
{
"name": "pint",
"specs": [
[
"==",
"0.20.1"
]
]
},
{
"name": "pyqt5",
"specs": [
[
"==",
"5.15.7"
]
]
},
{
"name": "scipy",
"specs": [
[
"==",
"1.10.0"
]
]
},
{
"name": "PyInstaller",
"specs": [
[
"==",
"5.7"
]
]
},
{
"name": "pip-licenses",
"specs": []
},
{
"name": "pytest",
"specs": []
}
],
"lcname": "suncal"
}
JSON
