Skip to content

Commit a34ee09

Browse files
committed
docs: slight tweaks for accuracy and cross-reference
1 parent 6c8f84a commit a34ee09

2 files changed

Lines changed: 14 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ characteristics.
1414

1515
Beyond basic conversion, the library supports configurable Callendar–Van Dusen
1616
models for traceable coefficient sets; generic polynomial, piecewise-polynomial, and
17-
table-backed custom characteristics; dependency-free IEC R0, custom CVD, and polynomial calibration fitting with auditable parameter covariance
17+
table-backed custom characteristics; dependency-free IEC R0, custom CVD, and polynomial
18+
calibration fitting with auditable parameter covariance
1819
and batch conversion; versioned portable model definitions; IEC 60751 platinum
1920
tolerance calculations; measurement uncertainty; simulation; built-in model
2021
discovery; hardware-neutral measurement composition; and stable language-neutral
@@ -25,6 +26,9 @@ applications that already have an RTD resistance measurement and need conversion
2526
modeling, calibration, tolerance, uncertainty, simulation, or cross-language
2627
validation tools.
2728

29+
For the hardware-to-software acquisition layer that supplies resistance measurements to
30+
`rtd-sensor`, we recommend the companion project [`rtd-acquire`](https://github.com/GregRR/rtd-acquire).
31+
2832
## Scope
2933

3034
`rtd-sensor` currently provides these verified built-in characteristics:

‎learn/index.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Learn rtd-sensor
3-
description: Learn and use rtd-sensor, from quick Python setup and complete documentation through beginner-friendly RTD experiments, calibration, uncertainty, and embedded interoperability.
2+
title: rtd-sensor documentation — RTD conversion and modeling
3+
description: Learn rtd-sensor for Python RTD conversion and modeling, with Pt100/Pt1000 guides, calibration, uncertainty, and embedded interoperability.
44
---
55

66
# Learn rtd-sensor
@@ -19,6 +19,13 @@ acquisition software must pass that resistance to `rtd-sensor`. `rtd-sensor` han
1919
RTD science and calculations; it does not handle wiring, SPI/I²C communication, ADCs, or
2020
other sensor-interface hardware.
2121

22+
That separation is a benefit: acquisition software such as
23+
[`rtd-acquire`](https://gregrr.github.io/rtd-acquire/) can handle the hardware and
24+
produce a reliable resistance measurement, while `rtd-sensor` focuses only on
25+
interpreting that resistance. Keeping those jobs separate makes it easier to change
26+
hardware, reuse the same RTD calculations in different systems, test each layer
27+
independently, and keep hardware faults distinct from RTD model or calculation errors.
28+
2229
## Let's Go!
2330

2431
Ready to dive in and use `rtd-sensor` in research, engineering, or in a

0 commit comments

Comments
 (0)