Merge branch 'master' of https://github.com/pygae/galgebra into prime…

…r-updates

CITATION.md

@@ -0,0 +1,28 @@
+Citing This Library
+-------------------
+
+`galgebra` is published to zenodo.
+DOI [10.5281/zenodo.10902114](https://doi.org/10.5281/zenodo.10902114) refers to all versions of `galgebra`.
+
+If you want to cite all releases, use:
+```BibTeX
+@software{galgebra,
+ author = {Alan Bromborsky and
+ Utensil Song and
+ Eric Wieser and
+ Hugo Hadfield and
+ {The Pygae Team}},
+ title = {pygae/galgebra},
+ month = jun,
+ year = 2020,
+ publisher = {Zenodo},
+ doi = {10.5281/zenodo.3857096},
+ url = {https://doi.org/10.5281/zenodo.3857096}
+}
+```
+
+To obtain BibTex citation information for a _specific_ release (recommended):
+
+* Run `python -m pip show galgebra` to determine which version you are using (or print `galgebra.__version__` from python)
+* Click on the corresponding version from [this list of versions](https://zenodo.org/search?q=parent.id%3A3857096&f=allversions%3Atrue&l=list&p=1&s=10&sort=version)
+* Scroll down to the bottom of the page, and click the "BibTex" link in the "Export" sidebar

README.md

@@ -252,3 +252,28 @@ Note that in the [doc/books](https://github.com/pygae/galgebra/blob/master/doc/b
  - Particularly, `GAlgebraPrimer.pdf` is an archived version of [GAlgebra Primer](http://www.faculty.luther.edu/~macdonal/GAlgebraPrimer.pdf) by Alan Macdonald, last updated on November 29, 2022.
 
 <!-- end: bundled-resources -->
+
+Star History
+-------------------
+
+<a href="https://star-history.com/#pygae/galgebra&Date">
+ <picture>
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=pygae/galgebra&type=Date&theme=dark" />
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=pygae/galgebra&type=Date" />
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=pygae/galgebra&type=Date" />
+ </picture>
+</a>
+
+Contributors
+-------------------
+
+<a href="https://github.com/pygae/galgebra/graphs/contributors">
+ <img src="https://contrib.rocks/image?repo=pygae/galgebra" />
+</a>
+
+Made with [contrib.rocks](https://contrib.rocks).
+
+Citing This Library
+-------------------
+
+For citation information, see [our `CITATION.md` file](https://github.com/pygae/galgebra/blob/master/CITATION.md).

doc/changelog.rst

@@ -66,6 +66,10 @@ Changelog
  * A geometric algebra for the unit sphere in :math:`\mathbb{R}^3` as a submanifold of :math:`\mathbb{R}^3` with spherical coordintes: :doc:`sp2sp3 <tutorials/sp2sp3>`
  * Spherical Coordinates in :math:`\mathbb{R}^3`: :doc:`sp3 <tutorials/sp3>`
 
+- :release:`0.5.2 <2024.05.01>`
+
+- :support:`517` Add citation info, star history, contributors to README, and fix zenodo citation issue for ``0.5.1``.
+
 - :release:`0.5.1 <2024.03.31>`
 
 - :bug:`495` ``MatrixFunction`` is broken since SymPy 1.11, which is required by initializing :class:`~galgebra.ga.Ga` with ``gsym`` and ``coords``, this is now fixed with a workaround (:issue:`507`).

galgebra/_version.py

@@ -5,4 +5,4 @@
 # 1) we don't load dependencies by storing it in __init__.py
 # 2) we can import it in setup.py for the same reason
 # 3) we can import it into your module
-__version__ = '0.5.1'
+__version__ = '0.5.2'