Welcome to hermes's documentation!
==================================

`hermes <https://github.com/3mcloud/hermes-rheo>`_ is a Python package developed at `3M <https://www.3m.com/3M/en_US/company-us/about-3m/research-development/>`_ designed to complement and extend the `piblin <https://github.com/3mcloud/piblin>`_ library, offering a set of transforms tailored for analysis of rheological data.

Check out the :doc:`quickstart` section for more information on getting started.

.. image:: https://img.shields.io/pypi/v/hermes-rheo
   :target: https://pypi.org/project/hermes-rheo
   :alt: PyPI Version

.. image:: https://img.shields.io/pypi/dm/hermes-rheo
   :target: https://pypi.org/project/hermes-rheo
   :alt: PyPI Downloads

.. image:: https://zenodo.org/badge/851879885.svg
   :target: https://doi.org/10.5281/zenodo.14182224
   :alt: DOI


.. note::

   This project is under active development. Check back for updates!

Contents
--------

.. toctree::
   :maxdepth: 2
   :caption: Introduction

   background
   readers
   quickstart

.. toctree::
   :maxdepth: 2
   :caption: Tutorials

   tutorials

.. toctree::
   :maxdepth: 2
   :caption: API

   file_readers
   transforms