Welcome to the documentation for rowan, a package for working with quaternions! Quaternions form a number system with various interesting properties, and they have a number of uses. This package provides tools for standard algebraic operations on quaternions as well as a number of additional tools for e.g. measuring distances between quaternions, interpolating between them, and performing basic point-cloud mapping. A particular focus of the rowan package is working with unit quaternions, which are a popular means of representing rotations in 3D. In order to provide a unified framework for working with the various rotation formalisms in 3D, rowan allows easy interconversion between these formalisms.
To install rowan, first clone the repository from source. Once installed, the package can be installed using setuptools:
$ python setup.py install --user
.. toctree:: :maxdepth: 2 :caption: Contents: package-rowan package-random development
.. toctree:: :maxdepth: 1 :caption: Reference: license changelog credits
This package is hosted on Bitbucket. Please report any bugs or problems that you find on the issue tracker.
All contributions to rowan are welcomed! Please see the :doc:`development guide <development>` for more information.