Package quaternion_djs
Welcome.
This package contains the code to enable calculations with Quaternions. Quaternion are in essence, 4-dimensional complex numbers that have applications in Mathematics, Physics and Computer Science. For more information check out (https://en.wikipedia.org/wiki/Quaternion)
This once was an area of study for myself during my undergraduate and I thought for a challenge I would make this package.
Table of contents
Installation
There are two sources for installation:
- GitHub, https://github.com/DrJStrudwick/Quaternion
- PyPi,
pip install quaternion-djs
As the package develops the changelog can be found here
Documentation
Our documentation is hosted on ReadTheDocs and can be found here: https://quaternion-djs.readthedocs.io/en/latest/
Example
The Quaternion class can be initialized easily by just supplying the corresponding values for the x, i, j, k components and then use in calculations as required. For the full list of methods and attributes available see the documentation.
>>>from quaternion_djs import Quaternion
>>>quaternion_1 = Quaternion(1, 2, 0, 1.2)
Contributing
If anyone wishes to contribute to improving this code base please see our contributing guide however please bear in mind our code of conduct
License
This work is released under the MIT License which you can find here
Sub-modules
quaternion_djs.quaternion-
The source code for the Quaternion class.
quaternion_djs.tests-
The test suite for the package.