kingdon 0.1.0__tar.gz

kingdon-0.1.0/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Martin Roelfs <martinroelfs@yahoo.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

kingdon-0.1.0/CONTRIBUTING.rst

@@ -0,0 +1,128 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/tbuli/kingdon/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Kingdon could always use more documentation, whether as part of the
+official Kingdon docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/tbuli/kingdon/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `kingdon` for local development.
+
+1. Fork the `kingdon` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/kingdon.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv kingdon
+    $ cd kingdon/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the
+   tests, including testing other Python versions with tox::
+
+    $ flake8 kingdon tests
+    $ python setup.py test or pytest
+    $ tox
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 3.8, 3.9, and 3.10, and for PyPy. Check
+   https://travis-ci.com/tbuli/kingdon/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+$ pytest tests.test_kingdon
+
+
+Deploying
+---------
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in HISTORY.rst).
+Then run::
+
+$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+Travis will then deploy to PyPI if tests pass.

kingdon-0.1.0/HISTORY.rst

@@ -0,0 +1,8 @@
+=======
+History
+=======
+
+0.1.0 (2023-08-12)
+------------------
+
+* First release on PyPI.

kingdon-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022, Martin Roelfs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

kingdon-0.1.0/MANIFEST.in

@@ -0,0 +1,11 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

kingdon-0.1.0/PKG-INFO

@@ -0,0 +1,227 @@
+Metadata-Version: 2.1
+Name: kingdon
+Version: 0.1.0
+Summary: Pythonic Geometric Algebra Package
+Home-page: https://github.com/tbuli/kingdon
+Author: Martin Roelfs
+Author-email: martinroelfs@yahoo.com
+License: MIT license
+Keywords: kingdon
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.8
+License-File: LICENSE
+License-File: AUTHORS.rst
+
+=======
+Kingdon
+=======
+
+
+.. image:: https://img.shields.io/pypi/v/kingdon.svg
+        :target: https://pypi.python.org/pypi/kingdon
+
+.. image:: https://img.shields.io/travis/tbuli/kingdon.svg
+        :target: https://travis-ci.com/tbuli/kingdon
+
+.. image:: https://readthedocs.org/projects/kingdon/badge/?version=latest
+        :target: https://kingdon.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+.. image:: https://coveralls.io/repos/github/tBuLi/kingdon/badge.svg?branch=master
+        :target: https://coveralls.io/github/tBuLi/kingdon?branch=master
+
+
+
+Pythonic Geometric Algebra Package
+
+
+* Free software: MIT license
+* Documentation: https://kingdon.readthedocs.io.
+
+
+Features
+--------
+
+Kingdon is a Geometric Algebra (GA) library which combines a Pythonic API with
+symbolic simplification and just-in-time compilation to achieve high-performance in a single package.
+It support both symbolic and numerical GA computations.
+Moreover, :code:`kingdon` uses :code:`ganja.js` for visualization in notebooks,
+making it an extremely well rounded GA package.
+
+In bullet points:
+
+- Symbolically optimized.
+- Leverage sparseness of input.
+- :code:`numba` enabled for numerical computations.
+- :code:`sympy` support for symbolic computations.
+- :code:`ganja.js` enabled graphics in jupyter notebooks.
+- Automatic broadcasting, such that transformations can be applied to e.g. point-clouds.
+
+Code Example
+------------
+In order to demonstrate the power of :code:`Kingdon`, let us first consider the common use-case of the
+commutator product between a bivector and vector.
+
+In order to create an algebra, use :code:`Algebra`. When calling :code:`Algebra` we must provide the signature of the
+algebra, in this case we shall go for 3DPGA, which is the algebra :math:`\mathbb{R}_{3,0,1}`.
+There are a number of ways to make elements of the algebra. It can be convenient to work with the basis blades directly.
+We can add them to the local namespace by calling :code:`locals().update(alg.blades)`:
+
+.. code-block:: python
+
+    >>> from kingdon import Algebra
+    >>> alg = Algebra(3, 0, 1)
+    >>> locals().update(alg.blades)
+    >>> b = 2 * e12
+    >>> v = 3 * e1
+    >>> b.cp(v)
+    (-6) * e2
+
+This example shows that only the :code:`e2` coefficient is calculated, despite the fact that there are
+6 bivector and 4 vector coefficients in 3DPGA. But by exploiting the sparseness of the input and by performing symbolic
+optimization, :code:`kingdon` knows that in this case only :code:`e2` can be non-zero.
+
+Symbolic usage
+--------------
+If only a name is provided for a multivector, :code:`kingdon` will automatically populate all
+relevant fields with symbols. This allows us to easily perform symbolic computations.
+
+.. code-block:: python
+
+    >>> from kingdon import Algebra
+    >>> alg = Algebra(3, 0, 1)
+    >>> b = alg.bivector(name='b')
+    >>> b
+    (b12) * e12 + (b13) * e13 + (b23) * e23 + (b14) * e14 + (b24) * e24 + (b34) * e34
+    >>> v = alg.vector(name='v')
+    >>> v
+    (v1) * e1 + (v2) * e2 + (v3) * e3 + (v4) * e4
+    >>> b.cp(v)
+    (-b12*v1 + b23*v3) * e2 + (b12*v2 + b13*v3) * e1 + (-b13*v1 - b23*v2) * e3 + (-b14*v1 - b24*v2 - b34*v3) * e4
+
+It is also possible to define some coefficients to be symbolic by inputting a string, while others can be numeric::
+
+    >>> from kingdon import Algebra, symbols
+    >>> alg = Algebra(3, 0, 1)
+    >>> b = alg.bivector(e12='b12', e34=3)
+    >>> b
+    (b12) * e12 + (3) * e34
+    >>> v = alg.vector(e1=1, e3=1)
+    >>> v
+    (1) * e1 + (1) * e3
+    >>> w = b.cp(v)
+    >>> w
+    (-b12) * e2 + (-3) * e4
+
+
+A :code:`kingdon` MultiVector with symbols is callable. So in order to evaluate :code:`w` from the previous example,
+for a specific value of :code:`b12`, simply call :code:`w`::
+
+    >>> w(b12=10)
+    (-10) * e2 + (-3) * e4
+
+
+Overview of Operators
+=====================
+.. list-table:: Operators
+   :widths: 50 25 25 25
+   :header-rows: 1
+
+   * - Operation
+     - Expression
+     - Infix
+     - Inline
+   * - Geometric product
+     -  $ab$
+     - :code:`a*b`
+     - :code:`a.gp(b)`
+   * - Inner
+     - $a \\cdot b$
+     - :code:`a|b`
+     - :code:`a.ip(b)`
+   * - Scalar product
+     - $\\langle a \\cdot b \\rangle_0$
+     -
+     - :code:`a.sp(b)`
+   * - Left-contraction
+     - $a \\rfloor b$
+     -
+     - :code:`a.lc(b)`
+   * - Right-contraction
+     - $a \\lfloor b$
+     -
+     - :code:`a.rc(b)`
+   * - Outer (Exterior)
+     - $a \\wedge b$
+     - :code:`a ^ b`
+     - :code:`a.op(b)`
+   * - Regressive
+     - $a \\vee b$
+     - :code:`a & b`
+     - :code:`a.rp(b)`
+   * - Conjugate :code:`b` by :code:`a`
+     - $a b \\widetilde{a}$
+     - :code:`a >> b`
+     - :code:`a.sw(b)`
+   * - Project :code:`a` onto :code:`b`
+     - $(a \\cdot b) \\widetilde{b}$
+     - :code:`a @ b`
+     - :code:`a.proj(b)`
+   * - Commutator of :code:`a` and :code:`b`
+     - $a \\times b = \\tfrac{1}{2} [a, b]$
+     -
+     - :code:`a.cp(b)`
+   * - Anti-commutator of :code:`a` and :code:`b`
+     - $\\tfrac{1}{2} \\{a, b\\}$
+     -
+     - :code:`a.acp(b)`
+   * - Sum of :code:`a` and :code:`b`
+     - :math:`a + b`
+     - :code:`a + b`
+     - :code:`a.add(b)`
+   * - Difference of :code:`a` and :code:`b`
+     - :math:`a - b`
+     - :code:`a - b`
+     - :code:`a.sub(b)`
+   * - Reverse of :code:`a`
+     - :math:`\\widetilde{a}`
+     - :code:`~a`
+     - :code:`a.reverse()`
+   * - Squared norm of :code:`a`
+     - :math:`a \\widetilde{a}`
+     -
+     - :code:`a.normsq()`
+   * - Norm of :code:`a`
+     - :math:`\\sqrt{a \\widetilde{a}}`
+     -
+     - :code:`a.norm()`
+   * - Normalize :code:`a`
+     - :math:`a / \\sqrt{a \\widetilde{a}}`
+     -
+     - :code:`a.normalized()`
+   * - Square root of :code:`a`
+     - :math:`\\sqrt{a}`
+     -
+     - :code:`a.sqrt()`
+
+Credits
+-------
+
+This package was inspired by GAmphetamine.js.
+
+
+=======
+History
+=======
+
+0.1.0 (2023-08-12)
+------------------
+
+* First release on PyPI.

kingdon-0.1.0/README.rst

@@ -0,0 +1,196 @@
+=======
+Kingdon
+=======
+
+
+.. image:: https://img.shields.io/pypi/v/kingdon.svg
+        :target: https://pypi.python.org/pypi/kingdon
+
+.. image:: https://img.shields.io/travis/tbuli/kingdon.svg
+        :target: https://travis-ci.com/tbuli/kingdon
+
+.. image:: https://readthedocs.org/projects/kingdon/badge/?version=latest
+        :target: https://kingdon.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+.. image:: https://coveralls.io/repos/github/tBuLi/kingdon/badge.svg?branch=master
+        :target: https://coveralls.io/github/tBuLi/kingdon?branch=master
+
+
+
+Pythonic Geometric Algebra Package
+
+
+* Free software: MIT license
+* Documentation: https://kingdon.readthedocs.io.
+
+
+Features
+--------
+
+Kingdon is a Geometric Algebra (GA) library which combines a Pythonic API with
+symbolic simplification and just-in-time compilation to achieve high-performance in a single package.
+It support both symbolic and numerical GA computations.
+Moreover, :code:`kingdon` uses :code:`ganja.js` for visualization in notebooks,
+making it an extremely well rounded GA package.
+
+In bullet points:
+
+- Symbolically optimized.
+- Leverage sparseness of input.
+- :code:`numba` enabled for numerical computations.
+- :code:`sympy` support for symbolic computations.
+- :code:`ganja.js` enabled graphics in jupyter notebooks.
+- Automatic broadcasting, such that transformations can be applied to e.g. point-clouds.
+
+Code Example
+------------
+In order to demonstrate the power of :code:`Kingdon`, let us first consider the common use-case of the
+commutator product between a bivector and vector.
+
+In order to create an algebra, use :code:`Algebra`. When calling :code:`Algebra` we must provide the signature of the
+algebra, in this case we shall go for 3DPGA, which is the algebra :math:`\mathbb{R}_{3,0,1}`.
+There are a number of ways to make elements of the algebra. It can be convenient to work with the basis blades directly.
+We can add them to the local namespace by calling :code:`locals().update(alg.blades)`:
+
+.. code-block:: python
+
+    >>> from kingdon import Algebra
+    >>> alg = Algebra(3, 0, 1)
+    >>> locals().update(alg.blades)
+    >>> b = 2 * e12
+    >>> v = 3 * e1
+    >>> b.cp(v)
+    (-6) * e2
+
+This example shows that only the :code:`e2` coefficient is calculated, despite the fact that there are
+6 bivector and 4 vector coefficients in 3DPGA. But by exploiting the sparseness of the input and by performing symbolic
+optimization, :code:`kingdon` knows that in this case only :code:`e2` can be non-zero.
+
+Symbolic usage
+--------------
+If only a name is provided for a multivector, :code:`kingdon` will automatically populate all
+relevant fields with symbols. This allows us to easily perform symbolic computations.
+
+.. code-block:: python
+
+    >>> from kingdon import Algebra
+    >>> alg = Algebra(3, 0, 1)
+    >>> b = alg.bivector(name='b')
+    >>> b
+    (b12) * e12 + (b13) * e13 + (b23) * e23 + (b14) * e14 + (b24) * e24 + (b34) * e34
+    >>> v = alg.vector(name='v')
+    >>> v
+    (v1) * e1 + (v2) * e2 + (v3) * e3 + (v4) * e4
+    >>> b.cp(v)
+    (-b12*v1 + b23*v3) * e2 + (b12*v2 + b13*v3) * e1 + (-b13*v1 - b23*v2) * e3 + (-b14*v1 - b24*v2 - b34*v3) * e4
+
+It is also possible to define some coefficients to be symbolic by inputting a string, while others can be numeric::
+
+    >>> from kingdon import Algebra, symbols
+    >>> alg = Algebra(3, 0, 1)
+    >>> b = alg.bivector(e12='b12', e34=3)
+    >>> b
+    (b12) * e12 + (3) * e34
+    >>> v = alg.vector(e1=1, e3=1)
+    >>> v
+    (1) * e1 + (1) * e3
+    >>> w = b.cp(v)
+    >>> w
+    (-b12) * e2 + (-3) * e4
+
+
+A :code:`kingdon` MultiVector with symbols is callable. So in order to evaluate :code:`w` from the previous example,
+for a specific value of :code:`b12`, simply call :code:`w`::
+
+    >>> w(b12=10)
+    (-10) * e2 + (-3) * e4
+
+
+Overview of Operators
+=====================
+.. list-table:: Operators
+   :widths: 50 25 25 25
+   :header-rows: 1
+
+   * - Operation
+     - Expression
+     - Infix
+     - Inline
+   * - Geometric product
+     -  $ab$
+     - :code:`a*b`
+     - :code:`a.gp(b)`
+   * - Inner
+     - $a \\cdot b$
+     - :code:`a|b`
+     - :code:`a.ip(b)`
+   * - Scalar product
+     - $\\langle a \\cdot b \\rangle_0$
+     -
+     - :code:`a.sp(b)`
+   * - Left-contraction
+     - $a \\rfloor b$
+     -
+     - :code:`a.lc(b)`
+   * - Right-contraction
+     - $a \\lfloor b$
+     -
+     - :code:`a.rc(b)`
+   * - Outer (Exterior)
+     - $a \\wedge b$
+     - :code:`a ^ b`
+     - :code:`a.op(b)`
+   * - Regressive
+     - $a \\vee b$
+     - :code:`a & b`
+     - :code:`a.rp(b)`
+   * - Conjugate :code:`b` by :code:`a`
+     - $a b \\widetilde{a}$
+     - :code:`a >> b`
+     - :code:`a.sw(b)`
+   * - Project :code:`a` onto :code:`b`
+     - $(a \\cdot b) \\widetilde{b}$
+     - :code:`a @ b`
+     - :code:`a.proj(b)`
+   * - Commutator of :code:`a` and :code:`b`
+     - $a \\times b = \\tfrac{1}{2} [a, b]$
+     -
+     - :code:`a.cp(b)`
+   * - Anti-commutator of :code:`a` and :code:`b`
+     - $\\tfrac{1}{2} \\{a, b\\}$
+     -
+     - :code:`a.acp(b)`
+   * - Sum of :code:`a` and :code:`b`
+     - :math:`a + b`
+     - :code:`a + b`
+     - :code:`a.add(b)`
+   * - Difference of :code:`a` and :code:`b`
+     - :math:`a - b`
+     - :code:`a - b`
+     - :code:`a.sub(b)`
+   * - Reverse of :code:`a`
+     - :math:`\\widetilde{a}`
+     - :code:`~a`
+     - :code:`a.reverse()`
+   * - Squared norm of :code:`a`
+     - :math:`a \\widetilde{a}`
+     -
+     - :code:`a.normsq()`
+   * - Norm of :code:`a`
+     - :math:`\\sqrt{a \\widetilde{a}}`
+     -
+     - :code:`a.norm()`
+   * - Normalize :code:`a`
+     - :math:`a / \\sqrt{a \\widetilde{a}}`
+     -
+     - :code:`a.normalized()`
+   * - Square root of :code:`a`
+     - :math:`\\sqrt{a}`
+     -
+     - :code:`a.sqrt()`
+
+Credits
+-------
+
+This package was inspired by GAmphetamine.js.

kingdon-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = kingdon
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

kingdon-0.1.0/docs/authors.rst

@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst