From f4e44db40a4fbc402a47c158e24de2c4cbf1b6e7 Mon Sep 17 00:00:00 2001 From: Utensil Date: Tue, 30 Apr 2024 17:45:37 +0800 Subject: [PATCH 1/3] Create CITATION.md --- CITATION.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CITATION.md diff --git a/CITATION.md b/CITATION.md new file mode 100644 index 00000000..207fda21 --- /dev/null +++ b/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 From 4607cdaf35958f5e955fe22e71155752ca7be230 Mon Sep 17 00:00:00 2001 From: Utensil Date: Tue, 30 Apr 2024 17:47:18 +0800 Subject: [PATCH 2/3] Add "Citing This Library" to README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 0ed61770..44b6ceaf 100644 --- a/README.md +++ b/README.md @@ -251,3 +251,8 @@ Note that in the [doc/books](https://github.com/pygae/galgebra/blob/master/doc/b - `Macdonald` which contains bundled supplementary materials for [Linear and Geometric Algebra](http://www.faculty.luther.edu/~macdonal/laga/index.html) and [Vector and Geometric Calculus](http://www.faculty.luther.edu/~macdonal/vagc/index.html) by Alan Macdonald, see [here](https://github.com/pygae/galgebra/blob/master/doc/books/Macdonald/) and [here](https://github.com/pygae/galgebra/blob/master/examples/Macdonald/) for more information. + +Citing This Library +------------------- + +For citation information, see [our `CITATION.md` file](https://github.com/pygae/galgebra/blob/master/CITATION.md). From d4d09bdc550ade42b1e7aa5a3c73694127982dce Mon Sep 17 00:00:00 2001 From: Utensil Date: Wed, 1 May 2024 18:12:40 +0800 Subject: [PATCH 3/3] Release 0.5.2 (#517) Add citation info, star history, contributors to README, and fix zenodo citation issue for `0.5.1`. --- README.md | 20 ++++++++++++++++++++ doc/changelog.rst | 4 ++++ galgebra/_version.py | 2 +- 3 files changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 44b6ceaf..c0f0b088 100644 --- a/README.md +++ b/README.md @@ -252,6 +252,26 @@ Note that in the [doc/books](https://github.com/pygae/galgebra/blob/master/doc/b +Star History +------------------- + + + + + + Star History Chart + + + +Contributors +------------------- + + + + + +Made with [contrib.rocks](https://contrib.rocks). + Citing This Library ------------------- diff --git a/doc/changelog.rst b/doc/changelog.rst index 59b5281a..489fed42 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -2,6 +2,10 @@ Changelog ========= +- :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`). diff --git a/galgebra/_version.py b/galgebra/_version.py index 726c6978..5aa7f5f3 100644 --- a/galgebra/_version.py +++ b/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'