Metadata-Version: 2.4
Name: rminstr_specs
Version: 0.4.1a0
Summary: A library of instrument data sheet accuracy specifications.
Author-email: Daniel Cole Gray <daniel.c.gray@nist.gov>, "Aaron M. Hagerstrom" <aaron.hagerstrom@nist.gov>, "Zenn C. Roberts" <zenn.roberts@nist.gov>
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: <3.14,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy>=2.0.0
Requires-Dist: pandas<3,>=2.2.3
Requires-Dist: scipy>=1.15.2
Dynamic: license-file

# Rocky Mountain Instrument Specifications

> [!NOTE]
> This software is in active and early development by the RF power calibrations service at NIST to support
> RF power calibrations and the development primary RF power standards. Expect breaking breaking changes as the software
> evolves. Instruments are added and tested as needed. Bugs may
> be present that we are unaware of. Please exercise caution and verify the output of this library yourself.

This package is a library of classes that provide manufacturer data sheet specifications for instruments
commonly used in the RF power calibration service at NIST. The manufacturer data sheet specifications - which we
verify with DC voltage standards traceable to the SI - can then be used as part of an uncertainty analysis when
performing our RF calibrations. This package facilitates this analysis by providing an easy interface into these
validated specification sheets via a python interface.

For example, to get the uncertainty associated with voltage measurements of an HP 3458A voltmeter
under typicaly operating conditions, you can do the following:

```python
from rminstr_specs import HP3458A
import numpy as np

# make a spec sheet
voltage_specs =  HP3458A.DatasheetDCV()
# create measurements
my_measurements = np.array([0.1, 1.0, 2.0])
# supply to spec sheet
my_accuracy = voltage_specs.all_manufacturer_errors(my_measurements)
```

Read the [pages](https://pages.nist.gov/rminstr-specs-ipages) for code API and examples.


## Authors

Contributors names and contact info

Daniel C. Gray, Zenn C. Roberts, Aaron M. Hagerstrom

