Skip to main content

Handling TAM Air calorimetry files made easy.

Project description

Logo

Interfacing with experimental results file from TAM Air calorimeters made easy.

After collecting multiple experimental results files from a TAM Air calorimeter you will be left with multiple .xls-files obtained as exports from the device control software. To achieve a side by side comparison of theses results and some basic extraction of relevant parameters, CaloCem is here to get this done smoothly.

Documentation

The full documentation can be found here.

Download Stats

PyPI - Downloads PyPI - Downloads PyPI - Python Version

Example Usage

Import the tacalorimetry module from CaloCem.

# import
import os
from CaloCem import tacalorimetry

Next, we define where the exported files are stored. With this information at hand, a Measurement is initialized. Experimental raw data and the metadata passed in the course of the measurement are retrieved by the methods get_data() and get_information(), respectively.

# define data path
# "mycalodata" is the subfoldername where the calorimetry
# data files (both .csv or .xlsx) are stored

pathname = os.path.dirname(os.path.realpath(__file__))
path_to_data = pathname + os.sep + "mycalodata"

# Example: if projectfile is at "C:\Users\myname\myproject\myproject.py", then "mydata"
# refers to "C:\Users\myname\myproject\mycalodata" where the data is stored

# load experiments via class, i.e. instantiate tacalorimetry object with data
tam = tacalorimetry.Measurement(folder=path_to_data)

# get sample and information
data = tam.get_data()
info = tam.get_information()

Basic plotting

Furthermore, the Measurement features a plot()-method for readily visualizing the collected results.

# make plot
tam.plot()
# show plot
tacalorimetry.plt.show()

Without further options specified, the plot()-method yields the following.

enter image description here

The plot()-method can also be tuned to show the temporal course of normalized heat. On the one hand, this "tuning" refers to the specification of further keyword arguments such as t_unit and y. On the other hand, the plot()-method returns an object of type matplotlib.axes._subplots.AxesSubplot, which can be used to further customize the plot. In the following, a guide-to-the-eye line is introduced next to adjuting the axes limts, which is not provided for via the plot()-method's signature.

# show cumulated heat plot
ax = tam.plot(
    t_unit="h",
    y='normalized_heat',
    y_unit_milli=False
)

# define target time
target_h = 1.5

# guide to the eye line
ax.axvline(target_h, color="gray", alpha=0.5, linestyle=":")

# set upper limits
ax.set_ylim(top=250)
ax.set_xlim(right=6)
# show plot
tacalorimetry.plt.show()

The following plot is obtained:

enter image description here

Feature Extraction

Additionally, the package allows among others for streamlining routine tasks such as

  • getting cumulated heat values,
  • identifying peaks positions and characteristics,
  • identifying peak onsets,
  • Plotting by Category,
  • ...

Installation

Use the package manager pip to install TAInstCalorimetry.

pip install CaloCem

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

List of contributors:

License

GNU GPLv3

Test

Tests

Code Styling

Code style: black

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

calocem-0.1.17.tar.gz (13.2 MB view details)

Uploaded Source

Built Distribution

calocem-0.1.17-py3-none-any.whl (13.2 MB view details)

Uploaded Python 3

File details

Details for the file calocem-0.1.17.tar.gz.

File metadata

  • Download URL: calocem-0.1.17.tar.gz
  • Upload date:
  • Size: 13.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1025-azure

File hashes

Hashes for calocem-0.1.17.tar.gz
Algorithm Hash digest
SHA256 b3af468a697fe4c959c02feaebb2cfe8e61d9155666f88fbc4a394b4c258bb6f
MD5 c34adf0bc34772e6e22c4a83801e11c4
BLAKE2b-256 6313f8e57f3c22a766837d0ee74e30e0dd20560af4d0e0021c592a7dec52cb11

See more details on using hashes here.

File details

Details for the file calocem-0.1.17-py3-none-any.whl.

File metadata

  • Download URL: calocem-0.1.17-py3-none-any.whl
  • Upload date:
  • Size: 13.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1025-azure

File hashes

Hashes for calocem-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 016d6ca566a54bef0a6d9f2c5e3287d52ff144ebc01b169baab5d4d56415b76d
MD5 4345f0b4352b017350c21dc6128cd0f3
BLAKE2b-256 885ad126fe6a4da0c058f44ada1ce1351b5d76c502df62190a04aa0227b940b9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page