.. IndenToolBox documentation master file, created by
   sphinx-quickstart on Fri Jun 23 14:31:07 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to IndenToolBox's documentation!
========================================

IndenToolBox is an open‑source Python toolbox for instrumented indentation (nanoindentation) data. It takes you from raw instrument exports to structured, reproducible batch analyses and publication‑ready results — all within notebooks or Python scripts.

Key features
------------

- Pre‑processing: parse vendor exports (e.g. Hysitron TI‑950, CSM), define the indenter tip and test protocol, assemble a `Batch`, and export `TOML`/`CSV`.
- Interactive widgets: optional UI in Jupyter for file selection and metadata entry.
- Post‑processing: step‑wise feature extraction (parabolic loading fit, unloading fit) and Oliver–Pharr modulus computation.
- Reverse analysis (demo): run methods such as GIAN99, DAO01, and CASA05 to back‑out material parameters.
- Plotting: quick inspection and interactive force–displacement plots.
- Reproducible pipeline: a shared data model between notebooks and the Python API.

Get started
-----------

- Installation and configuration: see :doc:`setup`.
- Hands‑on examples: see :doc:`tutorials` (pre‑ and post‑processing).
- API details: see :doc:`reference`.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   setup
   tutorials
   reference
   project

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`