Metadata-Version: 2.1
Name: caldus
Version: 1.3
Summary: Conversion of resistance values to temperatures for platinum resistors such as RTDs
Author-email: "Gunnstein T. Frøseth" <gunnstein@mailbox.org>
License: MIT License
        
        Copyright (c) 2023 Gunnstein T. Frøseth <gunnstein@mailbox.org>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: repository, https://github.com/gunnstein/caldus
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

caldus: Platinum Resistor Conversion Python Package
===================================================

Introduction
------------

`caldus` is a user-friendly, robust Python package specifically designed to facilitate the 
conversion between resistance values and temperatures of platinum resistors. It is based on the 
Callender-Van Dusen equations (thus the name `caldus`) and the IEC 60751:2022 standard.


Key Features
------------

1. **Supports Various Platinum Resistors:** The package supports a broad range of platinum resistors including PT100, PT500, PT1000, and more.

2. **Easy to Use:** Simply input the resistance or the temperature and the corresponding value will be returned.

3. **Flexible Integration:** Written in Python, `caldus` can be easily integrated with other Python applications or used for data analysis.


Installation
------------

To install `caldus` from PyPI, run:

.. code-block:: bash

    pip install caldus

To install the latest development version from Github, run:

.. code-block:: bash

    pip install git+https://github.com/gunnstein/caldus.git


Usage
-----

Below is a simple usage example:

.. code-block:: python

    import caldus

    # Convert resistance to temperature
    temp = caldus.resistance2temperature(110)

    # Convert temperature to resistance
    res = caldus.temperature2resistance(25)
    
    # Alternatively you can use the wrapper functions `r2t` and `t2r` to achieve the same.
    res = caldus.r2t(110)
    temp = caldus.t2r(25)

    print(temp) # output: ~25.68
    print(res)  # output: ~109

    # All functions can also take array like objects
    temps = [0., 12., 21.]
    resistances = caldus.t2r(temps)


Support and Contribution
------------------------

Please report issues via the GitHub issue tracker. 

To contribute, please fork this repository, make your changes, and issue a pull request.


