:html_theme.sidebar_secondary.remove:

PipeWhy documentation
=====================

**Version:** |release|

Data changed. Find out where, with the evidence to explain what is known.

PipeWhy captures versioned data, compares fingerprints and follows declared
lineage. Its reports keep missing observations and uncertain causes visible.
Use the dependency-free reference engine or opt into native CPU and experimental
CUDA execution.

.. note::

   This is development-candidate documentation. The first release targets
   accidental drift and corruption detection. It does not provide an adversarial
   integrity guarantee. Check the package index for available prereleases; the repository and release
   downloads require repository access.

.. grid:: 1 1 2 2
   :gutter: 4
   :class-container: landing-grid

   .. grid-item-card::

      .. image:: _static/start.svg
         :class: landing-icon
         :alt:

      Getting started
      ^^^^^^^^^^^^^^^

      New to PipeWhy? Install the project, capture a local fixture and read your
      first comparison. Learn what a snapshot can and cannot establish.

      +++

      .. button-ref:: getting_started/index
         :color: secondary
         :expand:

         To the getting started guide

   .. grid-item-card::

      .. image:: _static/guide.svg
         :class: landing-icon
         :alt:

      User guide
      ^^^^^^^^^^

      Explore normalization, fingerprints, Enron data, lineage, saved queries
      and resumable local workers. Follow practical examples and their limits.

      +++

      .. button-ref:: user_guide/index
         :color: secondary
         :expand:

         To the user guide

   .. grid-item-card::

      .. image:: _static/reference.svg
         :class: landing-icon
         :alt:

      API reference
      ^^^^^^^^^^^^^

      Find signatures and behavior for the Python entry points used throughout
      the guides, generated from the installed package.

      +++

      .. button-ref:: reference/index
         :color: secondary
         :expand:

         To the reference guide

   .. grid-item-card::

      .. image:: _static/develop.svg
         :class: landing-icon
         :alt:

      Developer guide
      ^^^^^^^^^^^^^^^

      Set up Poetry, run the quality checks, build distributions and documentation,
      and consult the architecture contracts and qualification records.

      +++

      .. button-ref:: development/index
         :color: secondary
         :expand:

         To the developer guide

Reading offline
---------------

This complete site works from a local folder. The documentation build also creates
``dist/pipewhy-docs.zip``. Extract it and open ``index.html``; use a local web server
if your browser restricts search on local files. See :doc:`development/documentation`.

.. raw:: html

   <p><a href="pipewhy-docs.zip" download>Download the offline documentation ZIP</a></p>

.. toctree::
   :hidden:

   getting_started/index
   user_guide/index
   reference/index
   development/index
