========
Overview
========
.. start-badges
.. list-table::
* - Docs
- |docs|
* - Tests
- |tests|
* - Package
- | |version| |supported-versions| |commits-since|
* - Citable
- |zenodo|
* - Example notebooks
- |example-notebooks|
.. |docs| image:: https://readthedocs.org/projects/python-dts-calibration/badge/?style=flat
:target: https://python-dts-calibration.readthedocs.io/en/latest/
:alt: Documentation Status
.. |tests| image:: https://github.com/dtscalibration/python-dts-calibration/actions/workflows/build.yml/badge.svg
:target: https://github.com/dtscalibration/python-dts-calibration/actions/workflows/build.yml
:alt: Test Status
.. |version| image:: https://img.shields.io/pypi/v/dtscalibration.svg
:alt: PyPI Package latest release
:target: https://pypi.python.org/pypi/dtscalibration
.. |commits-since| image:: https://img.shields.io/github/commits-since/dtscalibration/python-dts-calibration/v3.0.3.svg
:alt: Commits since latest release
:target: https://github.com/dtscalibration/python-dts-calibration/compare/v1.1.1...main
.. |wheel| image:: https://img.shields.io/pypi/wheel/dtscalibration.svg
:alt: PyPI Wheel
:target: https://pypi.python.org/pypi/dtscalibration
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/dtscalibration.svg
:alt: Supported versions
:target: https://pypi.python.org/pypi/dtscalibration
.. |zenodo| image:: https://zenodo.org/badge/143077491.svg
:alt: It would be greatly appreciated if you could cite this package in eg articles presentations
:target: https://zenodo.org/badge/latestdoi/143077491
.. |example-notebooks| image:: https://mybinder.org/badge.svg
:alt: Interactively run the example notebooks online
:target: https://mybinder.org/v2/gh/dtscalibration/python-dts-calibration/main?labpath=docs%2Fnotebooks
.. end-badges
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
============
.. code-block:: zsh
pip install dtscalibration
Or the development version directly from GitHub
.. code-block:: zsh
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 <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/07Calibrate_single_ended.ipynb>`_- and `double-ended <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/08Calibrate_double_ended.ipynb>`_ 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 <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/13Fixed_parameter_calibration.ipynb>`_
* `(Asymmetric) step loss correction <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/14Lossy_splices.ipynb>`_ so that fiber connectors can be used instead of welds/splices.
* `Matching temperature sections <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/15Matching_sections.ipynb>`_ 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: **CP320** .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 <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/07Calibrate_single_ended.ipynb>`_ and for double-ended setups in `08Calibrate_double_ended.ipynb <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/08Calibrate_double_ended.ipynb>`_.
* Documentation at `readthedocs <https://python-dts-calibration.readthedocs.io/en/latest/>`_.
* Example notebooks (`./docs/notebooks`) that work within the browser can be viewed `here <https://mybinder.org/v2/gh/dtscalibration/python-dts-calibration/main?labpath=docs%2Fnotebooks>`_.
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 <https://zenodo.org/search?q=conceptrecid:%221410097%22&sort=-version&all_versions=True>`_ and follow the link to the version of interest.
3. The citation is found on the bottom right of the page.
Raw data
{
"_id": null,
"home_page": null,
"name": "dtscalibration",
"maintainer": "Bas des Tombe, Bart Schilperoort",
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": "DTS, calibration, confidence intervals, distributed temperature sensing",
"author": "Bas des Tombe, Bart Schilperoort",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d1/7e/923fb8e49a80457d43fe61bbd4de2391d63c9c725267c4b00f450e0a342c/dtscalibration-3.0.3.tar.gz",
"platform": null,
"description": "========\nOverview\n========\n\n.. start-badges\n\n.. list-table::\n\n * - Docs\n - |docs|\n * - Tests\n - |tests|\n * - Package\n - | |version| |supported-versions| |commits-since|\n * - Citable\n - |zenodo|\n * - Example notebooks\n - |example-notebooks|\n\n.. |docs| image:: https://readthedocs.org/projects/python-dts-calibration/badge/?style=flat\n :target: https://python-dts-calibration.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. |tests| image:: https://github.com/dtscalibration/python-dts-calibration/actions/workflows/build.yml/badge.svg\n :target: https://github.com/dtscalibration/python-dts-calibration/actions/workflows/build.yml\n :alt: Test Status\n\n.. |version| image:: https://img.shields.io/pypi/v/dtscalibration.svg\n :alt: PyPI Package latest release\n :target: https://pypi.python.org/pypi/dtscalibration\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/dtscalibration/python-dts-calibration/v3.0.3.svg\n :alt: Commits since latest release\n :target: https://github.com/dtscalibration/python-dts-calibration/compare/v1.1.1...main\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/dtscalibration.svg\n :alt: PyPI Wheel\n :target: https://pypi.python.org/pypi/dtscalibration\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/dtscalibration.svg\n :alt: Supported versions\n :target: https://pypi.python.org/pypi/dtscalibration\n\n.. |zenodo| image:: https://zenodo.org/badge/143077491.svg\n :alt: It would be greatly appreciated if you could cite this package in eg articles presentations\n :target: https://zenodo.org/badge/latestdoi/143077491\n\n.. |example-notebooks| image:: https://mybinder.org/badge.svg\n :alt: Interactively run the example notebooks online\n :target: https://mybinder.org/v2/gh/dtscalibration/python-dts-calibration/main?labpath=docs%2Fnotebooks\n\n.. end-badges\n\nA 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 .\n\nDo 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>`_!\n\nInstallation\n============\n\n.. code-block:: zsh\n\n pip install dtscalibration\n\nOr the development version directly from GitHub\n\n.. code-block:: zsh\n\n pip install https://github.com/dtscalibration/python-dts-calibration/zipball/main --upgrade\n\nPackage features\n================\nDTS 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.\n\n* Advanced calibration routine\n * Supports `single <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/07Calibrate_single_ended.ipynb>`_- and `double-ended <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/08Calibrate_double_ended.ipynb>`_ setups\n * Compute uncertainty of the calibrated temperature\n * All measurements are used to estimate parameter values that are constant over time.\n * Weighted least-squares calibration\n * `Fixing parameters to a previously determined value <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/13Fixed_parameter_calibration.ipynb>`_\n * `(Asymmetric) step loss correction <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/14Lossy_splices.ipynb>`_ so that fiber connectors can be used instead of welds/splices.\n * `Matching temperature sections <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/15Matching_sections.ipynb>`_ to support J-configurations\n* Dynamic reference section definition\n* Tools for merging and aligning double-ended setups\n* Data formats of most manufacturers are supported\n\nDevices currently supported\n===========================\n* Silixa Ltd.: **Ultima** & **XT-DTS** .xml files *(up to version 8.1)*\n* Sensornet Ltd.: **Oryx**, **Halo** & **Sentinel** .ddf files\n* AP Sensing: **CP320** .xml files *(single ended only)*\n* SensorTran: **SensorTran 5100** .dat binary files *(single ended only)*\n\nDocumentation\n=============\n\n* A full calibration procedure for single-ended setups is presented in notebook `07Calibrate_single_ended.ipynb <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/07Calibrate_single_ended.ipynb>`_ and for double-ended setups in `08Calibrate_double_ended.ipynb <https://github.com/dtscalibration/python-dts-calibration/blob/main/docs/notebooks/08Calibrate_double_ended.ipynb>`_.\n* Documentation at `readthedocs <https://python-dts-calibration.readthedocs.io/en/latest/>`_.\n* Example notebooks (`./docs/notebooks`) that work within the browser can be viewed `here <https://mybinder.org/v2/gh/dtscalibration/python-dts-calibration/main?labpath=docs%2Fnotebooks>`_.\n\nHow to cite\n===========\nThe following article explains and discusses the calibration procedure:\n\n 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\n\nCite the specific implementation / repository via Zenodo:\n\n1. Check the version of `dtscalibration` that is used in your Python console with:\n\n >>> # The following line introduces the .dts accessor for xarray datasets\n >>> import dtscalibration # noqa: E401\n >>> dtscalibration.__version__\n '3.0.1'\n2. Go to `Zenodo <https://zenodo.org/search?q=conceptrecid:%221410097%22&sort=-version&all_versions=True>`_ and follow the link to the version of interest.\n3. The citation is found on the bottom right of the page.\n",
"bugtrack_url": null,
"license": null,
"summary": "Load Distributed Temperature Sensing (DTS) files, calibrate the temperature and estimate its uncertainty.",
"version": "3.0.3",
"project_urls": null,
"split_keywords": [
"dts",
" calibration",
" confidence intervals",
" distributed temperature sensing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3bc33e27e40cf8c2b8cc0132d7805cb7cd1239ac8e32ae64eb426b50a642d497",
"md5": "c432a8d9af9b056d0a36f962ec1184f7",
"sha256": "e304451e694686e09417c2bedb194665dc5f4905aa6e57f228ebe3eadf2cf9b6"
},
"downloads": -1,
"filename": "dtscalibration-3.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c432a8d9af9b056d0a36f962ec1184f7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 82340,
"upload_time": "2024-04-18T10:52:03",
"upload_time_iso_8601": "2024-04-18T10:52:03.678019Z",
"url": "https://files.pythonhosted.org/packages/3b/c3/3e27e40cf8c2b8cc0132d7805cb7cd1239ac8e32ae64eb426b50a642d497/dtscalibration-3.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d17e923fb8e49a80457d43fe61bbd4de2391d63c9c725267c4b00f450e0a342c",
"md5": "080f8e986d56102ee16fdd9cea354079",
"sha256": "0686cf36fd14c76e91813476d1165a3b7edf1ef034013622e36c4ea4414673dd"
},
"downloads": -1,
"filename": "dtscalibration-3.0.3.tar.gz",
"has_sig": false,
"md5_digest": "080f8e986d56102ee16fdd9cea354079",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 9057049,
"upload_time": "2024-04-18T10:52:06",
"upload_time_iso_8601": "2024-04-18T10:52:06.615410Z",
"url": "https://files.pythonhosted.org/packages/d1/7e/923fb8e49a80457d43fe61bbd4de2391d63c9c725267c4b00f450e0a342c/dtscalibration-3.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 10:52:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "dtscalibration"
}
JSON