diff --git a/README.md b/README.md index 80b1378..1e2d88f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# sdf-xarray +

+ +


![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fepochpic%2Fsdf-xarray%2Frefs%2Fheads%2Fmain%2Fpyproject.toml&query=%24.project.requires-python&label=python&logo=python) [![Available on PyPI](https://img.shields.io/pypi/v/sdf-xarray?color=blue&logo=pypi)](https://pypi.org/project/sdf-xarray/) @@ -115,7 +117,9 @@ To run checks locally before opening a pull request, see ## Broad EPOCH Analysis Modules (BEAM) -![BEAM logo](./BEAM.png) +

+ +

**BEAM** is a collection of independent yet complementary open-source tools for analysing EPOCH simulations, designed to be modular so researchers can adopt only @@ -135,6 +139,8 @@ parameter space using various sampling methods. ## PlasmaFAIR -![PlasmaFAIR logo](PlasmaFAIR.svg) +

+ +

Originally developed by [PlasmaFAIR](https://plasmafair.github.io), EPSRC Grant EP/V051822/1 diff --git a/BEAM.png b/docs/_static/BEAM.png similarity index 100% rename from BEAM.png rename to docs/_static/BEAM.png diff --git a/PlasmaFAIR.svg b/docs/_static/PlasmaFAIR.svg similarity index 100% rename from PlasmaFAIR.svg rename to docs/_static/PlasmaFAIR.svg diff --git a/docs/_static/sdf-xarray-logo-dark.svg b/docs/_static/sdf-xarray-logo-dark.svg new file mode 100644 index 0000000..1a5d77d --- /dev/null +++ b/docs/_static/sdf-xarray-logo-dark.svg @@ -0,0 +1,67 @@ + + + + + diff --git a/docs/_static/sdf-xarray-logo-light.svg b/docs/_static/sdf-xarray-logo-light.svg new file mode 100644 index 0000000..85a8ac4 --- /dev/null +++ b/docs/_static/sdf-xarray-logo-light.svg @@ -0,0 +1,55 @@ + + + + + diff --git a/docs/conf.py b/docs/conf.py index 2be3ee7..cd8d2d6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -116,6 +116,10 @@ "use_repository_button": True, "use_issues_button": True, "home_page_in_toc": False, + "logo": { + "image_light": "_static/sdf-xarray-logo-light.svg", + "image_dark": "_static/sdf-xarray-logo-dark.svg", + }, } pygments_style = "sphinx"