.. image:: _static/home_image.png
   :alt: piec logo
   :align: center
   :width: 300px

Welcome to piec's documentation!
==================================

**piec** (/peek/) is a Python library for controlling instruments and fast prototyping experiments
that enables scientists to quickly test and build new experimental setups.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   getting_started/what_is_piec
   getting_started/installation
   getting_started/quickstart

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   user_guide/the_driver
   user_guide/connecting_to_instrument
   user_guide/running_measurements
   user_guide/data_and_analysis

.. toctree::
   :maxdepth: 2
   :caption: Measurements

   measurements/amr
   measurements/ferroelectric
   measurements/iv_sweep

.. toctree::
   :maxdepth: 2
   :caption: Supported Instruments

   supported_instruments

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

   api_reference

.. toctree::
   :maxdepth: 2
   :caption: Contributing

   contributing/index
   contributing/adding_driver
   contributing/adding_measurement

.. toctree::
   :maxdepth: 1
   :caption: Administrative Info

   administrative/license
   administrative/authors
   administrative/changelog
   administrative/code_of_conduct