From 64d1be630fc2dbaa8576c4c9f904915cf3caa751 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gonzalo=20Pe=C3=B1a-Castellanos?= Date: Mon, 19 May 2025 20:32:26 -0500 Subject: [PATCH 1/8] Update figure shortcodes to new syntax --- content/about/index.md | 162 ++++++++++++++-------------- content/publications.md | 78 ++++++++------ themes/scientific-python-hugo-theme | 2 +- 3 files changed, 127 insertions(+), 115 deletions(-) diff --git a/content/about/index.md b/content/about/index.md index 2338d75a..d05d3070 100644 --- a/content/about/index.md +++ b/content/about/index.md @@ -28,48 +28,48 @@ Ionworks provides support and custom feature development for PyBaMM, as well as For companies who want to leverage the power, flexibility, and openness of the Python ecosystem for their battery simulation needs, Ionworks is the go-to partner. [Contact Ionworks](https://ionworks.com/) to find out more. -{{< figure >}} -src = '/images/logos/ionworks-logo.png' -alt = 'Logo for Ionworks' -width = 500 -attributionlink = '' -{{< /figure >}} +{{< figure + src="/images/logos/ionworks-logo.png" + alt="Logo for Ionworks" + width=500 + attributionlink="" +>}} ### The Oxford Research Software Engineering Group [OxRSE](https://www.rse.ox.ac.uk/) is the central RSE team at the University of Oxford. They have been part of the PyBaMM core development team since its inception and provide on-going software development support, funded by the [Faraday Institution](https://faraday.ac.uk/). If you want to know more about OxRSE can support your research, please [get in touch](https://www.rse.ox.ac.uk/contact). -{{< figure >}} -src = '/images/logos/2024_oxrse_rectangle.svg' -alt = 'Logo for OxRSE' -width = 500 -attributionlink = '' -{{< /figure >}} +{{< figure + src="/images/logos/2024_oxrse_rectangle.svg" + alt="Logo for OxRSE" + width=500 + attributionlink="" +>}} ### The Faraday Institution The Faraday Institution supports many PyBaMM contributors, who contribute to the project as part of their official duties at universities across the UK. -{{< figure >}} -src = '/images/logos/faraday-logo.png' -alt = 'Logo for The Faraday Institution' -width = 500 -attributionlink = '' -caption = "Logo for The Faraday Institution" -{{< /figure >}} +{{< figure + src="/images/logos/faraday-logo.png" + alt="Logo for The Faraday Institution" + width=500 + attributionlink="" + caption="Logo for The Faraday Institution" +>}} ### NumFOCUS PyBaMM is a Sponsored Project of NumFOCUS, a 501(c)(3) nonprofit charity in the United States. The mission of NumFOCUS is to promote open practices in research, data, and scientific computing by serving as a fiscal sponsor for open source projects and organizing community-driven educational programs. -{{< figure >}} -src = '/images/logos/NumFOCUS_sponsored_project_logo.svg' -alt = 'NumFOCUS Logo' -width = 500 -attributionlink = '' -caption = "NumFOCUS Logo" -{{< /figure >}} +{{< figure + src="/images/logos/NumFOCUS_sponsored_project_logo.svg" + alt="NumFOCUS Logo" + width=500 + attributionlink="" + caption="NumFOCUS Logo" +>}} ### Google Summer of Code @@ -81,61 +81,61 @@ We are grateful to the following organizations for supporting PyBaMM's developme
-{{< figure >}} -src = '/images/logos/university_of_oxford.svg' -alt = 'Logo for the University of Oxford' -width = 500 -attributionlink = '' -{{< /figure >}} - -{{< figure >}} -src = '/images/logos/university_of_michigan.svg' -alt = 'Logo for the University of Michigan' -width = 500 -attributionlink = '' -{{< /figure >}} - -{{< figure >}} -src = '/images/logos/carnegie_mellon_university.svg' -alt = 'Logo for Carnegie Mellon University' -width = 500 -attributionlink = '' -{{< /figure >}} - -{{< figure >}} -src = '/images/logos/imperial_college_london.png' -alt = 'Logo for Imperial College London' -width = 500 -attributionlink = '' -{{< /figure >}} - -{{< figure >}} -src = '/images/logos/university_of_warwick.png' -alt = 'Logo for the University of Warwick' -width = 500 -attributionlink = '' -{{< /figure >}} - -{{< figure >}} -src = '/images/logos/university_college_london.svg' -alt = 'Logo for University College London' -width = 500 -attributionlink = '' -{{< /figure >}} - -{{< figure >}} -src = '/images/logos/lilium.png' -alt = 'Logo for Lilium GmbH' -width = 500 -attributionlink = '' -{{< /figure >}} - -{{< figure >}} -src = '/images/logos/sila.png' -alt = 'Logo for Sila Nanotechnologies' -width = 500 -attributionlink = '' -{{< /figure >}} +{{< figure + src="/images/logos/university_of_oxford.svg" + alt="Logo for the University of Oxford" + width=500 + attributionlink="" +>}} + +{{< figure + src="/images/logos/university_of_michigan.svg" + alt="Logo for the University of Michigan" + width=500 + attributionlink="" +>}} + +{{< figure + src="/images/logos/carnegie_mellon_university.svg" + alt="Logo for Carnegie Mellon University" + width=500 + attributionlink="" +>}} + +{{< figure + src="/images/logos/imperial_college_london.png" + alt="Logo for Imperial College London" + width=500 + attributionlink="" +>}} + +{{< figure + src="/images/logos/university_of_warwick.png" + alt="Logo for the University of Warwick" + width=500 + attributionlink="" +>}} + +{{< figure + src="/images/logos/university_college_london.svg" + alt="Logo for University College London" + width=500 + attributionlink="" +>}} + +{{< figure + src="/images/logos/lilium.png" + alt="Logo for Lilium GmbH" + width=500 + attributionlink="" +>}} + +{{< figure + src="/images/logos/sila.png" + alt="Logo for Sila Nanotechnologies" + width=500 + attributionlink="" +>}}
diff --git a/content/publications.md b/content/publications.md index d9791f07..113f4922 100644 --- a/content/publications.md +++ b/content/publications.md @@ -18,6 +18,7 @@ The following papers have contributed directly to the development of PyBaMM. {{< grid columns="1 2 2 3" >}} + [[item]] type = 'card' title = 'Marquis, S. G., Sulzer, V., Timms, R., Please, C. P., & Chapman, S. J. (2019).' @@ -27,14 +28,16 @@ body = ''' ''' footer = '''
-{{< button dark >}} -label: Preprint -link: https://arxiv.org/abs/1905.12553 -{{< /button >}} -{{< button light >}} -label: DOI -link: https://doi.org/10.1149/2.0341915jes -{{< /button >}} +{{< button + style="dark" + label="Preprint" + link="https://arxiv.org/abs/1905.12553" +>}} +{{< button + style="light" + label="DOI" + link="https://doi.org/10.1149/2.0341915jes" +>}}
''' @@ -49,10 +52,11 @@ Development of Experimental Techniques for Parameterization of Multi-scale Lithi footer = '''
-{{< button light >}} -label: DOI -link: https://doi.org/10.1149/1945-7111/ab9050 -{{< /button >}} +{{< button + style="light" + label="DOI" + link="https://doi.org/10.1149/1945-7111/ab9050" +>}}
''' @@ -68,10 +72,11 @@ body = ''' footer = '''
-{{< button light >}} -label: DOI -link: https://doi.org/10.1149/1945-7111/aba44b -{{< /button >}} +{{< button + style="light" + label="DOI" + link="https://doi.org/10.1149/1945-7111/aba44b" +>}}
''' @@ -84,14 +89,18 @@ body = ''' ''' footer = '''
-{{< button dark >}} -label: Preprint -link: https://arxiv.org/abs/2005.05127 -{{< /button >}} -{{< button light >}} -label: Code -link: https://github.com/rtimms/asymptotic-pouch-cell -{{< /button >}} +{{< button + style="dark" + label="Preprint" + link="https://arxiv.org/abs/2005.05127" +>}} + +{{< button + style="light" + label="Code" + link="https://github.com/rtimms/asymptotic-pouch-cell" +>}} +
''' @@ -105,18 +114,21 @@ body = ''' ''' footer = '''
-{{< button dark >}} -label: Preprint -link: https://arxiv.org/abs/2008.03691 -{{< /button >}} -{{< button light >}} -label: DOI -link: https://doi.org/10.1149/1945-7111/abbce4 -{{< /button >}} +{{< button + style="dark" + label="Preprint" + link="https://arxiv.org/abs/2008.03691" +>}} + +{{< button + style="light" + label="DOI" + link="https://doi.org/10.1149/1945-7111/abbce4" +>}}
''' -{{< /grid >}} +{{< /grid >}} ## Citations diff --git a/themes/scientific-python-hugo-theme b/themes/scientific-python-hugo-theme index 9f4cf222..42b638f3 160000 --- a/themes/scientific-python-hugo-theme +++ b/themes/scientific-python-hugo-theme @@ -1 +1 @@ -Subproject commit 9f4cf2224b149f545a0da6198389b5249aaf77e1 +Subproject commit 42b638f37c0f5869a112f0c274d03bc349d1a7b3 From 0090580fa0fdff5743f930989dfe28c8d9bac5ee Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Thu, 4 Dec 2025 19:33:30 +0530 Subject: [PATCH 2/8] Update theme to v22 --- themes/scientific-python-hugo-theme | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/scientific-python-hugo-theme b/themes/scientific-python-hugo-theme index 42b638f3..d8388d2f 160000 --- a/themes/scientific-python-hugo-theme +++ b/themes/scientific-python-hugo-theme @@ -1 +1 @@ -Subproject commit 42b638f37c0f5869a112f0c274d03bc349d1a7b3 +Subproject commit d8388d2f417c63d3c2aa0a2f51687d34a0b56208 From 5aa3902a7e39068aa6823c7dd70538fc51beeec8 Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Thu, 4 Dec 2025 20:21:47 +0530 Subject: [PATCH 3/8] Add margin, remove old breadcrumbs, remove viewport-width --- assets/css/overrides.css | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/assets/css/overrides.css b/assets/css/overrides.css index fc6a7436..9362eb2a 100644 --- a/assets/css/overrides.css +++ b/assets/css/overrides.css @@ -35,8 +35,13 @@ content-container class */ text-decoration: none; } -/* Remove breadcrumbs background from navbar */ +/* More gaps for footer columns because of external link indicators */ +.footer-column { + margin-right: 2em; +} -nav[aria-label="Breadcrumb"] { - background-color: unset; +/* Don't set widths for 100% of the viewport for these, just the screen. */ +.news-container, .hero-container { + width: 100%; } + From d03e148fe559ff5afd8c9cc4199a31b62a07ea3a Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Thu, 4 Dec 2025 20:22:00 +0530 Subject: [PATCH 4/8] Mark links as external --- config.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/config.yaml b/config.yaml index 063a3570..6286c2a8 100644 --- a/config.yaml +++ b/config.yaml @@ -127,15 +127,18 @@ params: title: "" links: - text: Install PyBaMM + is_external: true link: https://docs.pybamm.org/en/stable/source/user_guide/installation/index.html - text: Getting started link: /learn/ - text: Examples + is_external: true link: https://github.com/pybamm-team/PyBaMM/tree/develop/examples/ - text: Documentation + is_external: true link: https://docs.pybamm.org/ - text: Release notes @@ -151,6 +154,7 @@ params: link: /contribute/ - text: Ionworks + is_external: true link: https://ionworks.com/ - text: News From e7b399158742b7d487a50240c58f706fcaf79c91 Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Thu, 4 Dec 2025 20:22:08 +0530 Subject: [PATCH 5/8] Roadmap has an internal link --- config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config.yaml b/config.yaml index 6286c2a8..d3983320 100644 --- a/config.yaml +++ b/config.yaml @@ -176,4 +176,4 @@ params: link: /governance/ - text: Roadmap - link: https://github.com/pybamm-team/PyBaMM/wiki/Roadmap/ + link: /roadmap/ From 4fc090338d3989145869b31a75a902ac8296229f Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 4 Dec 2025 14:52:19 +0000 Subject: [PATCH 6/8] style: pre-commit fixes --- assets/css/overrides.css | 1 - 1 file changed, 1 deletion(-) diff --git a/assets/css/overrides.css b/assets/css/overrides.css index 9362eb2a..e2ae56a2 100644 --- a/assets/css/overrides.css +++ b/assets/css/overrides.css @@ -44,4 +44,3 @@ content-container class */ .news-container, .hero-container { width: 100%; } - From af0b88f26e0453f4a2fd9dbd80870592a782e286 Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Thu, 4 Dec 2025 20:33:39 +0530 Subject: [PATCH 7/8] Exclude Google Scholar links from link checker --- .github/workflows/links.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index 7b4c6efc..539d9035 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -40,6 +40,7 @@ jobs: --exclude "https://doi\.org|www.sciencedirect\.com/*" --exclude https://plausible.io/pybamm.org --exclude https://ecsarxiv.org/67ckj/ + --exclude https://scholar.google.com/ --exclude-path ./static/teams/contributors.html --exclude-path ./content/gsoc/ --accept 200,429,999 From b2c8c9edb630ec4f88f763ea54cd08ec6ed9116d Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Thu, 4 Dec 2025 20:37:44 +0530 Subject: [PATCH 8/8] Fix hysteresis notebook link --- content/news/2024/05/31/pybamm-24.5.md | 2 +- content/news/2025/04/02/pybamm-25.4.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/news/2024/05/31/pybamm-24.5.md b/content/news/2024/05/31/pybamm-24.5.md index 228a0241..c8cb1068 100644 --- a/content/news/2024/05/31/pybamm-24.5.md +++ b/content/news/2024/05/31/pybamm-24.5.md @@ -108,7 +108,7 @@ model = pybamm.lithium_ion.DFN( ) ``` -Note that additional parameter values might be required for the model to run. For more details, please see the [corresponding notebook](https://docs.pybamm.org/en/latest/source/examples/notebooks/models/differential-capacity-hysteresis-state.html). +Note that additional parameter values might be required for the model to run. For more details, please see the [corresponding notebook](https://docs.pybamm.org/en/latest/source/examples/notebooks/models/hysteresis-state-models.html). ## Lithium plating for composite electrodes _Implemented by [Simon O'Kane](https://github.com/DrSOKane)_ diff --git a/content/news/2025/04/02/pybamm-25.4.md b/content/news/2025/04/02/pybamm-25.4.md index 1b3e61a6..49c35970 100644 --- a/content/news/2025/04/02/pybamm-25.4.md +++ b/content/news/2025/04/02/pybamm-25.4.md @@ -39,7 +39,7 @@ pybamm.lithium_ion.DFN( ) ``` -For more information on this and the other hysteresis models available in PyBaMM, see [the hysteresis notebook](https://docs.pybamm.org/en/stable/source/examples/notebooks/models/differential-capacity-hysteresis-state.html). +For more information on this and the other hysteresis models available in PyBaMM, see [the hysteresis notebook](https://docs.pybamm.org/en/latest/source/examples/notebooks/models/hysteresis-state-models.html). ## Experiments compatible with input parameters _Implemented by [Rishab Kumar Jha](https://github.com/Rishab87)_