diff --git a/README.md b/README.md index 6cdd785..37196a2 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ BSD-3-Clause License. 1. Fork this repository 2. Install the extended version of Hugo from [https://gohugo.io/installation/](https://gohugo.io/installation/) - and add it to your `PATH` + and [`dart-sass`](https://sass-lang.com/dart-sass/) and add them to your `PATH` 3. Clone your forked repository and add the theme repository as a submodule, from [https://github.com/scientific-python/scientific-python-hugo-theme](https://github.com/scientific-python/scientific-python-hugo-theme). You may update the submodule and pull the latest changes with diff --git a/assets/css/overrides.css b/assets/css/overrides.css index 4e0f8c1..baf850f 100644 --- a/assets/css/overrides.css +++ b/assets/css/overrides.css @@ -1,168 +1,19 @@ -/* Overrides for the PyBaMM hero on the homepage */ +/* White backgrounds behind images */ -/* We use these styles to provide precedence over submodule theme changes to come close -to near-parity with NumPy and SciPy websites (which use older versions of the theme) */ - - -/* Make PyBaMM logo smaller */ -.hero-logo { - max-height: 75px; - padding: 0px 0 0 15px; -} - -/* Hero button should be left aligned */ -.hero-cta { - padding: 15px 0; - display: flex; - flex-wrap: wrap; - align-self: normal; -} - -/* Add space between navbar and hero, reduce distance between title and subtitle */ -.hero-title-content { - margin: 6vh auto; - max-width: 1200px; -} - -/* Move PyBaMM logo in hero to text superscript */ -.hero-title { - align-content: auto; - align-items: normal; - display: flex; - flex-direction: row; - font-family: var(--fontFamily), sans-serif; - font-weight: 900; - font-size: 6em; - color: var(--colorPrimaryDark); -} - -/* Removes padding between hero title and subtitle */ -.hero-title { - padding: 0 0 0 0; -} - -/* General improvements */ - -/* Do not induce padding on code blocks */ -.highlight { - padding: 10px 0px; -} - -/* Media settings for narrower screens */ - -@media only screen and (max-width: 1090px) { - .hero-content { - flex-direction: column; - padding: 0; - align-items: center; - } - - .hero-title-content { - flex-direction: column; - align-items: center; - align-self: center; - justify-content: center; - } - - button.cta-button { - align-items: center; - align-self: center; - } - - .hero-cta { - align-self: center; - } - - .flex-column { - /* align all items center */ - align-items: center; - } - - .footer-column { - padding-inline-end: 20px; - } -} - -@media only screen and (max-width: 600px) { - .flex-column { - margin: 0 30px; - } - - .hero-title { - font-size: 4em; - } - - .hero-subtitle { - text-align: center; - padding-top: 20px; - } - - .hero-cta { - align-self: center; - } - - .hero-title { - flex-direction: column; - } - -} - -@media only screen and (max-width: 400px) { - .hero-title { - flex-direction: column; - } - - .hero-logo { - align-self: center; - } -} - -/* Accessibility improvements */ - -.footer-link, .footer-link:hover { - line-height: 2rem; -} - -.copyright { - font-size: 16px; -} - -.footer-link:hover { - color: var(--colorHighlight); -} - -/* Individual highlights */ - -.cta-button:hover { - color: var(--colorHighlight); -} - -.news-title a:hover, .news-date a:hover { - color: var(--colorHighlight); -} - -/* Animations */ - -a, a:hover, a:active { - transition: color 0.25s ease-in-out; -} - -/* Adjustments for headings */ - -.content-container h2, .content-container h3, .content-container h4, .content-container h5, .content-container h6 { - margin-top: 0.75rem; -} - -.title:not(.is-spaced) + .subtitle { - margin-top: -0.2rem; +figure { + background-color: white; + padding: 15px; + border-radius: 15px; } -/* Navigation bar dropdown */ +/* Captions should be black above white background */ -.navbar.is-fresh .navbar-item.has-dropdown .navbar-link { - color: var(--colorPrimaryDark); +figure figcaption p span { + color: black !important; } -.navbar.is-fresh .navbar-item.has-dropdown .navbar-link:hover { - color: #4DABCF +/* Let table of contents inherit the bounds set by the +content-container class */ +#TableOfContents { + position: inherit; } diff --git a/config.yaml b/config.yaml index bae3e94..079b833 100644 --- a/config.yaml +++ b/config.yaml @@ -17,9 +17,10 @@ markup: unsafe: true params: - title: PyBaMM Team # for copyright + title: PyBaMM website description: "PyBaMM (Python Battery Mathematical Modelling) is an open-source battery simulation package written in Python." - + author: + name: PyBaMM Team # Privacy-preserving analytics plausible: dataDomain: pybamm.org @@ -81,10 +82,7 @@ params: - title: About PyBaMM url: /about/ - title: Ionworks - url: https://ion-works.com/ - is_external: true - - title: PyBaMM on Twitter - url: https://twitter.com/pybamm_/ + url: https://ionworks.com/ is_external: true - title: Governance url: /governance/ @@ -94,32 +92,6 @@ params: - title: News url: /news/ - - title: Contribute - url: /contribute/ - - # Grid of features - keyfeatures: - features: - - - title: Enhanced Simulation Performance - text: PyBaMM enables efficient simulations of battery performance and aging, accelerating battery design and innovation. - - - title: Modular Framework - text: The flexible nature of PyBaMM allows for quick model interchangeability, making it useful in different stages of battery R&D. - - - title: Open Source - text: PyBaMM is open source, which means anyone can use, modify, and distribute the software. This makes it accessible to researchers worldwide, - enhancing global battery technology research. - - - title: Comprehensive Model Library - text: PyBaMM's model library includes a wide range of physics-based models, making it a vital tool in diverse battery research. - - - title: Detailed Visualization Tools - text: PyBaMM includes data visualization tools that enable researchers to better interpret their simulation results, facilitating the identification of trends and potential improvements. - - - title: Python Ecosystem - text: PyBaMM can be combined with any of the advanced data science and machine learning tools in Python's extensive ecosystem. - footer: logo: pybamm_logo_whitetext.svg socialmediatitle: "" @@ -156,7 +128,7 @@ params: title: "" links: - text: Contact - link: /contact/ + link: /community/ - text: Get involved link: /contribute/ @@ -165,7 +137,7 @@ params: link: /training/ - text: Ionworks - link: https://ion-works.com/ + link: https://ionworks.com/ - text: News link: /news/ diff --git a/content/404.md b/content/404.md index dbb0144..b7866b7 100644 --- a/content/404.md +++ b/content/404.md @@ -10,7 +10,7 @@ It looks like you've followed a broken link or entered a URL that doesn't exist [Go back to PyBaMM Home](/) -Seeing something you shouldn't? Please feel free to [contact us](/contact) and let us know what you were looking for, or open +Seeing something you shouldn't? Please feel free to [contact us](/community) and let us know what you were looking for, or open an issue on our [GitHub repository](https://www.github.com/pybamm-team/pybamm.org/issues).
diff --git a/content/GOVERNANCE.md b/content/GOVERNANCE.md index f64aa94..22e4bbb 100644 --- a/content/GOVERNANCE.md +++ b/content/GOVERNANCE.md @@ -22,7 +22,7 @@ handled on a case-by-case basis. - [Ferran Brosa Planella](https://www.brosaplanella.xyz) - University of Warwick and Ionworks - [Saransh Chopra](https://saransh-cpp.github.io) - Cluster Innovation Centre, University of Delhi -- Scott Marquis - Northvolt +- [Scott Marquis](https://se.linkedin.com/in/scottmar93) - Northvolt - [Gregory Offer](https://www.imperial.ac.uk/people/gregory.offer) - Imperial College London - [Valentin Sulzer](https://sites.google.com/view/valentinsulzer) - Ionworks - [Martin Robinson](https://www.sabsr3.ox.ac.uk/people/dr-martin-robinson) - University of Oxford diff --git a/content/_index.md b/content/_index.md new file mode 100644 index 0000000..ae3ddf6 --- /dev/null +++ b/content/_index.md @@ -0,0 +1,47 @@ +--- +title: Homepage +--- + +{{< grid columns="1 2 2 3" >}} +[[item]] +type = 'card' +title = 'Enhanced Simulation Performance' +body = ''' +PyBaMM enables efficient simulations of battery performance and aging, accelerating battery design and innovation. +''' + +[[item]] +type = 'card' +title = 'Modular Framework' +body = ''' +The flexible nature of PyBaMM allows for quick model interchangeability, making it useful in different stages of battery R&D. +''' + +[[item]] +type = 'card' +title = 'Open Source' +body = ''' +PyBaMM is open source, which means anyone can use, modify, and distribute the software. This makes it accessible to researchers worldwide, enhancing global battery technology research. +''' + +[[item]] +type = 'card' +title = 'Comprehensive Model Library' +body = ''' +PyBaMM's model library includes a wide range of physics-based models, making it a vital tool in diverse battery research. +''' + +[[item]] +type = 'card' +title = 'Detailed Visualization Tools' +body = ''' +PyBaMM includes data visualization tools that enable researchers to better interpret their simulation results, facilitating the identification of trends and potential improvements. +''' + +[[item]] +type = 'card' +title = 'Python Ecosystem' +body = ''' +PyBaMM can be combined with any of the advanced data science and machine learning tools in Python's extensive ecosystem. +''' +{{< /grid >}} diff --git a/content/about/index.md b/content/about/index.md index 6b2b198..dcc441f 100644 --- a/content/about/index.md +++ b/content/about/index.md @@ -22,57 +22,53 @@ donations and how you can support, please see the [Donate](/donate/) page. ### Ionworks -[Ionworks](https://ion-works.com/) is a company founded by members of the PyBaMM core development team to ensure [PyBaMM's long-term success](https://ion-works.com/blog/our-relationship-with-pybamm). +[Ionworks](https://ionworks.com/) is a company founded by members of the PyBaMM core development team to ensure [PyBaMM's long-term success](https://ionworks.com/blog/our-relationship-with-pybamm). Ionworks provides support and custom feature development for PyBaMM, as well as software to make modeling easier and faster. 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://ion-works.com/contact) to find out more. -+{{< figure >}} +src = '/images/logos/ionworks-logo.png' +alt = 'Logo for Ionworks' +width = 500 +attributionlink = '' +{{< /figure >}} ### 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="500px" >}} - - - -
+{{< figure >}}
+src = '/images/logos/2024_oxrse_rectangle.svg'
+alt = 'Logo for OxRSE'
+width = 500
+attributionlink = ''
+{{< /figure >}}
### 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="500px" >}}
-
-
-
-
+{{< figure >}}
+src = '/images/logos/faraday-logo.png'
+alt = 'Logo for The Faraday Institution'
+width = 500
+attributionlink = ''
+caption = "Logo for The Faraday Institution"
+{{< /figure >}}
### 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="500px" >}}
-
-
+{{< figure >}}
+src = '/images/logos/NumFOCUS_sponsored_project_logo.svg'
+alt = 'NumFOCUS Logo'
+width = 500
+attributionlink = ''
+caption = "NumFOCUS Logo"
+{{< /figure >}}
### Google Summer of Code
@@ -82,38 +78,70 @@ Since 2021, the [Google Summer of Code](/gsoc/) programme has provided funding f
We are grateful to the following organizations for supporting PyBaMM's development, either directly through employee/student time or indirectly through financial support:
-
-
-
-
-
{{< pybamm-twitter >}}
## Current PyBaMM Steering Council
diff --git a/content/changelog.md b/content/changelog.md
index 8e64515..7ba3608 100644
--- a/content/changelog.md
+++ b/content/changelog.md
@@ -1,5 +1,5 @@
---
-title: PyBaMM CHANGELOG
+title: PyBaMM Changelog and Release Notes
summary: This page contains the PyBaMM CHANGELOG, which is automatically updated when the file in the repository is changed.
---
diff --git a/content/community.md b/content/community.md
index b2331f8..29c4b3a 100644
--- a/content/community.md
+++ b/content/community.md
@@ -1,11 +1,36 @@
---
title: PyBaMM Community
-shortcutDepth: 2
+shortcutDepth: 1
---
## Contact PyBaMM
-{{< include-md "contact.md" >}}
+There are a few ways to get in touch, whether it is through reporting bugs,
+requesting features, asking for help, or just saying hello!
+
+### GitHub
+
+To submit bug reports or feature requests, please go to our
+[GitHub issue tracker](https://www.github.com/pybamm-team/PyBaMM/issues).
+We will always appreciate these contributions and feedback! For more general
+discussions, please use the [GitHub discussions](https://github.com/pybamm-team/PyBaMM/discussions).
+
+### Slack
+
+For development discussions and to get help using PyBaMM, head over to our
+[Slack workspace](https://pybamm.org/slack/).
+If the link doesn't work, you can email us at [pybamm@gmail.com](mailto:pybamm@gmail.com) for an invitation.
+
+### General inquiries
+
+For general inquiries, you can contact us by emailing [pybamm@gmail.com](mailto:pybamm@gmail.com).
+
+### Get help
+
+[Ionworks](https://ionworks.com/) is a company founded by members of the PyBaMM core development team to ensure [PyBaMM's long-term success](https://ionworks.com/blog/our-relationship-with-pybamm).
+Ionworks provides support and custom feature development for PyBaMM, as well as software to make modeling easier and faster.
+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/contact) to find out more.
## Governance
diff --git a/content/contact.md b/content/contact.md
deleted file mode 100644
index 929ed0f..0000000
--- a/content/contact.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-title: Contact PyBaMM
----
-
-There are a few ways to get in touch, whether it is through reporting bugs,
-requesting features, asking for help, or just saying hello!
-
-### GitHub
-
-To submit bug reports or feature requests, please go to our
-[GitHub issue tracker](https://www.github.com/pybamm-team/PyBaMM/issues).
-We will always appreciate these contributions and feedback! For more general
-discussions, please use the [GitHub discussions](https://github.com/pybamm-team/PyBaMM/discussions).
-
-### Slack
-
-For development discussions and to get help using PyBaMM, head over to our
-[Slack workspace](https://pybamm.org/slack/).
-If the link doesn't work, you can email us at [pybamm@gmail.com](mailto:pybamm@gmail.com) for an invitation.
-
-### General inquiries
-
-For general inquiries, you can contact us by emailing [pybamm@gmail.com](mailto:pybamm@gmail.com).
-
-### Get help
-
-[Ionworks](https://ion-works.com/) is a company founded by members of the PyBaMM core development team to ensure [PyBaMM's long-term success](https://ion-works.com/blog/our-relationship-with-pybamm).
-Ionworks provides support and custom feature development for PyBaMM, as well as software to make modeling easier and faster.
-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://ion-works.com/contact) to find out more.
diff --git a/content/contribute.md b/content/contribute.md
index 08db003..05ae165 100644
--- a/content/contribute.md
+++ b/content/contribute.md
@@ -1,5 +1,6 @@
---
title: Contribute to PyBaMM
+toc: true
---
If you'd like to contribute to PyBaMM whether via reporting issues and bugs, updating the documentation, or adding new features (thanks!), please have a look at the [Contributing Guidelines](https://docs.pybamm.org/en/latest/source/user_guide/contributing.html).
@@ -79,11 +80,9 @@ If you work for a company that uses PyBaMM and would like to sponsor the project
Recurring donations without a specific deliverable. Donations are acknowledged on public project pages, and opportunities for interaction with the core development team. See our GitHub sponsor page for details.
-
-
-{{< notice tip >}}
+{{< admonition hint >}}
Check out our [Donate](/donate/) page for more details about sponsorship and payment options.
-{{< /notice >}}
+{{< /admonition >}}
#### Community work orders
diff --git a/content/learn.md b/content/learn.md
index 47b5afb..a463481 100644
--- a/content/learn.md
+++ b/content/learn.md
@@ -1,10 +1,11 @@
---
title: Get started with PyBaMM
+toc: true
---
-{{< notice tip >}}
+{{< admonition hint >}}
For the official PyBaMM documentation, please visit https://docs.pybamm.org/en/stable/
-{{< /notice >}}
+{{< /admonition >}}
## Installation instructions
@@ -36,12 +37,8 @@ For more resources, please refer to the [Examples section](https://docs.pybamm.o
## Video tutorials
-We regularly hold PyBaMM workshops. You can find a list of the workshops we have held with links to the corresponding recordings below.
-
-
-
-{{< include-md "./training.md" >}}
+We regularly hold PyBaMM workshops. You can find a list of the workshops we have held with links to the corresponding recordings on the [Training](/training/) page.
## Get help
-You can get help by posting questions on the [PyBaMM Slack channels](https://pybamm.org/slack/) or preferably in [GitHub discussions](https://github.com/pybamm-team/PyBaMM/discussions). You can also get paid support from [Ionworks](https://ion-works.com/contact).
+You can get help by posting questions on the [PyBaMM Slack channels](https://pybamm.org/slack/) or preferably in [GitHub discussions](https://github.com/pybamm-team/PyBaMM/discussions). You can also get paid support from [Ionworks](https://ionworks.com/contact).
diff --git a/content/news/2020/11/24/faraday-institution-conference.md b/content/news/2020/11/24/faraday-institution-conference.md
index 95da31e..f772586 100644
--- a/content/news/2020/11/24/faraday-institution-conference.md
+++ b/content/news/2020/11/24/faraday-institution-conference.md
@@ -11,6 +11,6 @@ Robert Timms (University of Oxford) presented PyBaMM today in the Faraday Instit
The talk introduced the main features of PyBaMM's framework and then presented different real case studies. These case studies showcased how PyBaMM can be used to simulate mechanical, thermal and degradation effects.
-The recording of the talk is available on [YouTube](https://www.youtube.com/watch?v=1YlFr930Cv8&ab_channel=PyBaMM). Try out PyBaMM for yourself by going to [Examples](https://github.com/pybamm-team/PyBaMM/tree/develop/examples/) (to see the examples) or [Google Colab](https://colab.research.google.com/github/pybamm-team/PyBaMM/blob/develop) (to run them online, with no local installation). If you have any questions, please feel free to [contact us](/contact).
+The recording of the talk is available on [YouTube](https://www.youtube.com/watch?v=1YlFr930Cv8&ab_channel=PyBaMM). Try out PyBaMM for yourself by going to [Examples](https://github.com/pybamm-team/PyBaMM/tree/develop/examples/) (to see the examples) or [Google Colab](https://colab.research.google.com/github/pybamm-team/PyBaMM/blob/develop) (to run them online, with no local installation). If you have any questions, please feel free to [contact us](/community).
{{< youtube id="1YlFr930Cv8" class="workshop" levelOffset=4 >}}{{< /youtube >}}
diff --git a/content/news/2021/06/09/pybamm-jors-paper.md b/content/news/2021/06/09/pybamm-jors-paper.md
index ff281a1..dcd2343 100644
--- a/content/news/2021/06/09/pybamm-jors-paper.md
+++ b/content/news/2021/06/09/pybamm-jors-paper.md
@@ -8,16 +8,12 @@ _June 09, 2021_
Our introductory paper is now out in the Journal of Open Research Software! This paper explains the motivation and design philosophy behind PyBaMM. Find it here: https://doi.org/10.5334/jors.309
-
-
The paper can be cited in APA format as follows:
```
Sulzer, V., Marquis, S. G., Timms, R., Robinson, M., & Chapman, S. J. (2021). Python Battery Mathematical Modelling (PyBaMM) (Version 23.4.1) [Computer software]. https://doi.org/10.5334/jors.309
```
-
-
or with BibTeX, as:
```
diff --git a/content/news/2024/01/31/pybamm-24.1.md b/content/news/2024/01/31/pybamm-24.1.md
index d556466..6b76d8c 100644
--- a/content/news/2024/01/31/pybamm-24.1.md
+++ b/content/news/2024/01/31/pybamm-24.1.md
@@ -14,19 +14,16 @@ The full list of changes can be found in the [CHANGELOG](https://pybamm.org/chan
PyBaMM now includes support for Python 3.12, which was released in October 2023. There is some functionality still not yet fully supported in Python 3.12 plus some functionality deprecated for Python 3.8 (see warnings below), but versions 3.9 to 3.11 support all functionality.
-
-
-{{< notice warning >}}
-
+{{< admonition caution >}}
We have deprecated support for the `JaxSolver`, i.e., the `[jax]` optional dependency on Python 3.8 and it is supported on Python 3.9 and above for macOS, Linux, and Windows.
-{{< /notice >}}
+{{< /admonition >}}
-{{< notice note >}}
+{{< admonition note >}}
The `scikits.odes` solver is not supported on Python `3.12` yet. It is supported on Python versions `3.8` to `3.11`, for macOS and Linux.
-{{< /notice >}}
+{{< /admonition >}}
## Custom termination conditions
diff --git a/content/teams.md b/content/teams.md
index 8fdcea7..0cfd40d 100644
--- a/content/teams.md
+++ b/content/teams.md
@@ -3,7 +3,7 @@ title: PyBaMM Teams
shortcutDepth: 2
---
-{{< notice note >}}
+{{< admonition note >}}
PyBaMM follows the [all-contributors](https://allcontributors.org/) specification to list contributions
beyond just code (ideas, bug reports, adding documentation, maintenance, examples, and more).
@@ -11,7 +11,7 @@ beyond just code (ideas, bug reports, adding documentation, maintenance, example
For viewing various types of contributions (financial support, bug reports, ideas), see the [PyBaMM repository](https://github.com/pybamm-team/PyBaMM#-contributors) on GitHub.
Contributions of any kind are welcome!
-{{< /notice >}}
+{{< /admonition >}}
{{< include-html "static/teams/maintainers.html" >}}
diff --git a/layouts/_default/single.html b/layouts/_default/single.html
new file mode 100644
index 0000000..d39083f
--- /dev/null
+++ b/layouts/_default/single.html
@@ -0,0 +1,24 @@
+{{ define "main" }}
+
+ {{ .Title }}
+ {{ if .Params.Subtitle }}
+ {{ .Params.Subtitle }}
+ {{ end }}
+ {{ .Title }}
- {{ .Params.Subtitle }}
-
-