.. APyTypes documentation master file.

Welcome to APyTypes' documentation!
===================================

APyTypes is a Python library providing algorithmic data types, both fixed- and
floating-point in Python. The main purpose is to simplify finite word length design and
simulation. Written in C++, the focus is on performance and flexibility.

The repository can be found at `https://github.com/apytypes/apytypes <https://github.com/apytypes/apytypes>`_.
Please report any issues or suggestions there. Contributions are also welcome!

To install APyTypes do

.. code-block:: bash

   pip install apytypes

To install the latest version from source, without having to set up git etc, do

.. code-block:: bash

   pip install git+https://github.com/apytypes/apytypes.git

Or look at the :ref:`development` instructions.

Now, have a look at the examples and play around. Using an enhanced terminal, like
Jupyter Notebooks or Spyder, will provide a nicer output of the numbers.

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   api/index
   cpp_api/index
   examples/index
   performance
   comparison
   development
   publications
   changelog
   licenses

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

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

APyTypes is developed by the Division of Electronics and Computer Engineering at Linköping University, Sweden.

.. image:: _static/liu-white.svg
   :class: only-dark

.. image:: _static/liu-black.svg
   :class: only-light