hermes-rheo 1.0.11

piblin transforms tailored for advanced rheological analysis

hermes-rheo

Python package designed to complement and extend the piblin library, offering a set of transforms tailored for analysis of rheological data. Publication of this work is forthcoming. For now, if you use this software, please cite it using the metadata in the citation file and the above DOI.

Documentation

Documentation to learn more about the package and how to use its API will be available soon. In the meantime, tutorial notebooks can be found in the tutorial_notebooks folder

Installation

hemres-rheo is in the PyPI! You can easily install it using pip:

pip install hermes-rheo

and likewise update it:

pip install hermes-rheo --upgrade

Usage

Importing the package

Once the package has been installed, you can simply import its modules:

from hermes_rheo.transforms.rheo_analysis import RheoAnalysis

File readers

The file_readers directory, contains an example file reader for rheological data collected using TA TRIOS software. This reader was designed to read .txt files generated via the "Export to LIMS" command in TRIOS. Starting with TRIOS V5, a new export format, .json, has been introduced. See new features here, and a reader for this format is currently in development.

For other formats or instruments, users can develop custom readers while still utilizing the package's data transforms for analysis. For assistance in developing a reader for your data format, please contact aperego[at]mmm.com.

Examples

The tutorial_notebooks folder, contains multiple examples that showcase the software’s functionality in detail.

Style and Supporting Tools

This repository follows the naming conventions in PEP-8, docstring conventions in PEP-257 and versioning conventions in PEP-440. The pytest library is used for testing, using the pytest-html and pytest-cov plugins. Documentation is produced with Sphinx and all docstrings are written in the numpy format. Distributions are produced with setuptools and conda-build. The use of the conventional commits format for commit messages is suggested but not enforced.

Contibuting

Inquiries and suggestions can be directed to aperego[at]mmm.com.

License

MIT