From 49b8c6acdddef386d073808447938aab9a247d3f Mon Sep 17 00:00:00 2001 From: CosmoMatt Date: Mon, 22 Apr 2024 10:39:05 +0100 Subject: [PATCH 01/10] alias badges to render inline github --- README.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 0c2b15ee..bc552022 100644 --- a/README.rst +++ b/README.rst @@ -1,24 +1,26 @@ -.. image:: https://img.shields.io/badge/GitHub-harmonic-brightgreen.svg?style=flat +.. |github| image:: https://img.shields.io/badge/GitHub-harmonic-brightgreen.svg?style=flat :target: https://github.com/astro-informatics/harmonic -.. image:: https://github.com/astro-informatics/harmonic/actions/workflows/python.yml/badge.svg +.. |tests| image:: https://github.com/astro-informatics/harmonic/actions/workflows/python.yml/badge.svg :target: https://github.com/astro-informatics/harmonic/actions/workflows/python.yml -.. image:: https://readthedocs.org/projects/ansicolortags/badge/?version=latest +.. |docs| image:: https://readthedocs.org/projects/ansicolortags/badge/?version=latest :target: https://astro-informatics.github.io/harmonic/ -.. image:: https://codecov.io/gh/astro-informatics/harmonic/branch/main/graph/badge.svg?token=1s4SATphHV +.. |codecov| image:: https://codecov.io/gh/astro-informatics/harmonic/branch/main/graph/badge.svg?token=1s4SATphHV :target: https://codecov.io/gh/astro-informatics/harmonic -.. image:: https://badge.fury.io/py/harmonic.svg +.. |pypi| image:: https://badge.fury.io/py/harmonic.svg :target: https://badge.fury.io/py/harmonic -.. image:: https://img.shields.io/badge/License-GPL-blue.svg +.. |licence| image:: https://img.shields.io/badge/License-GPL-blue.svg :target: http://perso.crans.org/besson/LICENSE.html -.. image:: http://img.shields.io/badge/arXiv-2111.12720-orange.svg?style=flat +.. |arxiv1| image:: http://img.shields.io/badge/arXiv-2111.12720-orange.svg?style=flat :target: https://arxiv.org/abs/2111.12720 -.. image:: http://img.shields.io/badge/arXiv-2207.04037-orange.svg?style=flat +.. |arxiv2| image:: http://img.shields.io/badge/arXiv-2207.04037-orange.svg?style=flat :target: https://arxiv.org/abs/2207.04037 -.. image:: http://img.shields.io/badge/arXiv-2307.00048-orange.svg?style=flat +.. |arxiv3| image:: http://img.shields.io/badge/arXiv-2307.00048-orange.svg?style=flat :target: https://arxiv.org/abs/2307.00048 .. .. image:: https://img.shields.io/pypi/pyversions/harmonic.svg .. :target: https://pypi.python.org/pypi/harmonic/ +|github| |tests| |docs| |codecov| |pypi| |licence| |arxiv1| |arxiv2| |arxiv3| + |logo| Harmonic ================================================================================================================= From 5b39ade85825e93804408f42f38ea8adb1f8dc78 Mon Sep 17 00:00:00 2001 From: CosmoMatt Date: Mon, 22 Apr 2024 10:40:10 +0100 Subject: [PATCH 02/10] move logo alias to before title --- README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index bc552022..41a9ca1c 100644 --- a/README.rst +++ b/README.rst @@ -21,12 +21,12 @@ |github| |tests| |docs| |codecov| |pypi| |licence| |arxiv1| |arxiv2| |arxiv3| -|logo| Harmonic -================================================================================================================= - .. |logo| raw:: html + +|logo| Harmonic +================================================================================================================= ``harmonic`` is an open source, well tested and documented Python implementation of the *learnt harmonic mean estimator* (`McEwen et al. 2021 `_) to compute the marginal likelihood (Bayesian evidence), required for Bayesian model selection. From fbc2970ed52f2d47dda5dd94ba3f670d73cc248f Mon Sep 17 00:00:00 2001 From: CosmoMatt Date: Mon, 22 Apr 2024 10:46:17 +0100 Subject: [PATCH 03/10] change logo alias from raw html to image:: --- README.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 41a9ca1c..3049e9d7 100644 --- a/README.rst +++ b/README.rst @@ -21,10 +21,9 @@ |github| |tests| |docs| |codecov| |pypi| |licence| |arxiv1| |arxiv2| |arxiv3| -.. |logo| raw:: html - - +.. |logo| image:: ./docs/assets/harm_badge_simple.svg + |logo| Harmonic ================================================================================================================= From d4f8c59bfdcb321fab37e44c7986ca06936c04a2 Mon Sep 17 00:00:00 2001 From: CosmoMatt Date: Mon, 22 Apr 2024 10:46:54 +0100 Subject: [PATCH 04/10] change size of logo --- README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 3049e9d7..bd0d25f9 100644 --- a/README.rst +++ b/README.rst @@ -23,7 +23,9 @@ .. |logo| image:: ./docs/assets/harm_badge_simple.svg - + :width: 52 + :height: 52 + |logo| Harmonic ================================================================================================================= From 6707fdc66191e55edd5dc14afeeb87850b2e20ef Mon Sep 17 00:00:00 2001 From: CosmoMatt Date: Mon, 22 Apr 2024 10:47:49 +0100 Subject: [PATCH 05/10] set logo vertical alignment to middle --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index bd0d25f9..3c824c38 100644 --- a/README.rst +++ b/README.rst @@ -25,6 +25,7 @@ .. |logo| image:: ./docs/assets/harm_badge_simple.svg :width: 52 :height: 52 + :align: middle |logo| Harmonic ================================================================================================================= From 3e3a524a7003fbad3074b969f9dad1a1ed832666 Mon Sep 17 00:00:00 2001 From: CosmoMatt Date: Mon, 22 Apr 2024 10:48:22 +0100 Subject: [PATCH 06/10] set logo vertical alignment to middle --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 3c824c38..59d8b538 100644 --- a/README.rst +++ b/README.rst @@ -25,7 +25,7 @@ .. |logo| image:: ./docs/assets/harm_badge_simple.svg :width: 52 :height: 52 - :align: middle + :align: center |logo| Harmonic ================================================================================================================= From d88acc4acaacd65eccae7e013b180db8128598e3 Mon Sep 17 00:00:00 2001 From: CosmoMatt Date: Mon, 22 Apr 2024 10:55:19 +0100 Subject: [PATCH 07/10] more fiddling with logo... --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 59d8b538..998f7ae2 100644 --- a/README.rst +++ b/README.rst @@ -22,12 +22,9 @@ |github| |tests| |docs| |codecov| |pypi| |licence| |arxiv1| |arxiv2| |arxiv3| -.. |logo| image:: ./docs/assets/harm_badge_simple.svg - :width: 52 - :height: 52 - :align: center + -|logo| Harmonic +Harmonic ================================================================================================================= ``harmonic`` is an open source, well tested and documented Python implementation of the *learnt harmonic mean estimator* (`McEwen et al. 2021 `_) to compute the marginal likelihood (Bayesian evidence), required for Bayesian model selection. From 9fc32f48ceaf99903917ae0a554a599fea367e94 Mon Sep 17 00:00:00 2001 From: CosmoMatt Date: Mon, 22 Apr 2024 10:57:30 +0100 Subject: [PATCH 08/10] revert previous --- README.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 998f7ae2..4e92f944 100644 --- a/README.rst +++ b/README.rst @@ -22,9 +22,14 @@ |github| |tests| |docs| |codecov| |pypi| |licence| |arxiv1| |arxiv2| |arxiv3| +.. |logo| image:: ./docs/assets/harm_badge_simple.svg + :width: 52 + :height: 52 + :align: center + -Harmonic +|logo| Harmonic ================================================================================================================= ``harmonic`` is an open source, well tested and documented Python implementation of the *learnt harmonic mean estimator* (`McEwen et al. 2021 `_) to compute the marginal likelihood (Bayesian evidence), required for Bayesian model selection. From f9f514e0ffef8ca206e9bb908f684f7a65b24258 Mon Sep 17 00:00:00 2001 From: CosmoMatt Date: Mon, 22 Apr 2024 10:57:56 +0100 Subject: [PATCH 09/10] revert previous --- README.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.rst b/README.rst index 4e92f944..59d8b538 100644 --- a/README.rst +++ b/README.rst @@ -27,8 +27,6 @@ :height: 52 :align: center - - |logo| Harmonic ================================================================================================================= From adcab2c81a10f28878abf251df4bd2812b2cbbf5 Mon Sep 17 00:00:00 2001 From: CosmoMatt Date: Mon, 22 Apr 2024 10:58:31 +0100 Subject: [PATCH 10/10] rescale logo as rst image alignment broken and html wont render... --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 59d8b538..851ef239 100644 --- a/README.rst +++ b/README.rst @@ -23,8 +23,8 @@ .. |logo| image:: ./docs/assets/harm_badge_simple.svg - :width: 52 - :height: 52 + :width: 32 + :height: 32 :align: center |logo| Harmonic