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 GitHub. Please report any issues or suggestions there. Contributions are also welcome!

Installation

Releases of APyTypes come with pre-built wheels for Linux, Windows, and MacOS (ARM64 and x86-64). Release wheels are made available through PyPi. Using a pre-built wheel is the recommended way of installing APyTypes.

Install APyTypes

$ pip install apytypes

It is also possible to build APyTypes from source code. Unreleased content not yet available through a release is made available in this way.

Install APyTypes from source

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

Installing APyTypes from source requires:

• A C++17-compatible compiler

• Git

• CMake

• Meson

See also

Development

Detailed information on building APyTypes and its documentation from source.

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.

Contents:

• apytypes Python package
• APyTypes C++ API
• Examples
• APyTypes Playground
• Computational performance
• Comparison
• Development
• Publications
• Changelog
• Licenses

Indices and tables

• Index

• Module Index

• Search Page

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