README.rst

Overview

Docs
Tests
Package
Citable
Example notebooks

A Python package to load Distributed Temperature Sensing files, perform a calibration, and plot the result. A detailed description of the calibration procedure can be found at https://doi.org/10.3390/s20082235 .

Do you have questions, ideas or just want to say hi? Please leave a message on the ` discussions page <https://github.com/dtscalibration/python-dts-calibration/discussions>`_!

Installation

pip install dtscalibration

Or the development version directly from GitHub

pip install https://github.com/dtscalibration/python-dts-calibration/zipball/main --upgrade

Package features

DTS measures temperature by calibrating backscatter measurements to sections with a known temperature. DTS devices provide a simple interface to perform a limited calibration. Re-calibrating your measurements with this Python package gives you better temperature estimates and additional options.

• Advanced calibration routine

  • Supports single- and double-ended setups
  • Compute uncertainty of the calibrated temperature
  • All measurements are used to estimate parameter values that are constant over time.
  • Weighted least-squares calibration
  • Fixing parameters to a previously determined value
  • (Asymmetric) step loss correction so that fiber connectors can be used instead of welds/splices.
  • Matching temperature sections to support J-configurations

• Dynamic reference section definition
• Tools for merging and aligning double-ended setups
• Data formats of most manufacturers are supported

Devices currently supported

• Silixa Ltd.: Ultima & XT-DTS .xml files (up to version 8.1)
• Sensornet Ltd.: Oryx, Halo & Sentinel .ddf files
• AP Sensing: N4386B .xml files (single ended only)
• SensorTran: SensorTran 5100 .dat binary files (single ended only)

Documentation

• A full calibration procedure for single-ended setups is presented in notebook 07Calibrate_single_ended.ipynb and for double-ended setups in 08Calibrate_double_ended.ipynb.
• Documentation at readthedocs.
• Example notebooks (./docs/notebooks) that work within the browser can be viewed here.

How to cite

The following article explains and discusses the calibration procedure:

des Tombe, B., Schilperoort, B., & Bakker, M. (2020). Estimation of Temperature and Associated Uncertainty from Fiber-Optic Raman-Spectrum Distributed Temperature Sensing. Sensors, 20(8), 2235. https://doi.org/10.3390/s20082235

Cite the specific implementation / repository via Zenodo:

1. Check the version of dtscalibration that is used in your Python console with:

   >>> # The following line introduces the .dts accessor for xarray datasets
   >>> import dtscalibration  # noqa: E401
   >>> dtscalibration.__version__
   '3.0.1'

2. Go to Zenodo and follow the link to the version of interest.

3. The citation is found on the bottom right of the page.