From faa6bb0082a51549487b682eea3ec9c8718cbe86 Mon Sep 17 00:00:00 2001
From: RemDelaporteMathurin
Date: Tue, 28 Apr 2026 20:24:02 -0400
Subject: [PATCH 01/12] first implementation
---
.../logos}/Beihang_University.png | Bin
...monwealth_Fusion_Systems Devens_MA_USA.png | Bin
.../logos}/Cranfield_University_UK.png | Bin
.../user_logos => _static/logos}/ENEA.png | Bin
.../user_logos => _static/logos}/ENI.png | Bin
.../logos}/Exeter_University_UK.png | Bin
.../logos}/Frazer_Nash.png | Bin
.../logos}/IRFM_cadarache_France.png | Bin
.../logos}/ITER_organization_France.png | Bin
.../logos/Institut_Jo\305\276ef_Stefan.png" | Bin
...ma_physics_Chinese_academy_of_sciences.png | Bin
.../logos}/Kyoto_Fusioneering.png | Bin
.../logos}/LSPM_Villetaneuse_France.png | Bin
.../logos}/Logo_of_University_of_Tsukuba.png | Bin
.../logos}/MEPhI_moscow_Russia.png | Bin
.../logos}/MIT_Cambridge_MA_USA.png | Bin
.../logos}/Marathon_Fusion_USA.png | Bin
.../logos}/Oak_Ridge_National_Laboratory.png | Bin
.../logos}/Politecnico_di_Torino.png | Bin
.../logos}/Thea_Energy_USA.png | Bin
.../user_logos => _static/logos}/UKAEA_UK.png | Bin
.../logos}/University_San_Diego.png | Bin
.../University_Wisconsin_Madison_USA.png | Bin
.../logos}/University_of_Surrey.png | Bin
.../logos}/University_of_Tsukuba.png | Bin
.../logos}/Zap_Energy.png | Bin
.../logos}/digiLab_UK.png | Bin
docs/source/_static/style.css | 165 ++++++++++
docs/source/conf.py | 55 +---
docs/source/index.rst | 304 +++++++++++++++---
30 files changed, 418 insertions(+), 106 deletions(-)
rename docs/source/{images/user_logos => _static/logos}/Beihang_University.png (100%)
rename docs/source/{images/user_logos => _static/logos}/Commonwealth_Fusion_Systems Devens_MA_USA.png (100%)
rename docs/source/{images/user_logos => _static/logos}/Cranfield_University_UK.png (100%)
rename docs/source/{images/user_logos => _static/logos}/ENEA.png (100%)
rename docs/source/{images/user_logos => _static/logos}/ENI.png (100%)
rename docs/source/{images/user_logos => _static/logos}/Exeter_University_UK.png (100%)
rename docs/source/{images/user_logos => _static/logos}/Frazer_Nash.png (100%)
rename docs/source/{images/user_logos => _static/logos}/IRFM_cadarache_France.png (100%)
rename docs/source/{images/user_logos => _static/logos}/ITER_organization_France.png (100%)
rename "docs/source/images/user_logos/Institut_Jo\305\276ef_Stefan.png" => "docs/source/_static/logos/Institut_Jo\305\276ef_Stefan.png" (100%)
rename docs/source/{images/user_logos => _static/logos}/Institute_of_plasma_physics_Chinese_academy_of_sciences.png (100%)
rename docs/source/{images/user_logos => _static/logos}/Kyoto_Fusioneering.png (100%)
rename docs/source/{images/user_logos => _static/logos}/LSPM_Villetaneuse_France.png (100%)
rename docs/source/{images/user_logos => _static/logos}/Logo_of_University_of_Tsukuba.png (100%)
rename docs/source/{images/user_logos => _static/logos}/MEPhI_moscow_Russia.png (100%)
rename docs/source/{images/user_logos => _static/logos}/MIT_Cambridge_MA_USA.png (100%)
rename docs/source/{images/user_logos => _static/logos}/Marathon_Fusion_USA.png (100%)
rename docs/source/{images/user_logos => _static/logos}/Oak_Ridge_National_Laboratory.png (100%)
rename docs/source/{images/user_logos => _static/logos}/Politecnico_di_Torino.png (100%)
rename docs/source/{images/user_logos => _static/logos}/Thea_Energy_USA.png (100%)
rename docs/source/{images/user_logos => _static/logos}/UKAEA_UK.png (100%)
rename docs/source/{images/user_logos => _static/logos}/University_San_Diego.png (100%)
rename docs/source/{images/user_logos => _static/logos}/University_Wisconsin_Madison_USA.png (100%)
rename docs/source/{images/user_logos => _static/logos}/University_of_Surrey.png (100%)
rename docs/source/{images/user_logos => _static/logos}/University_of_Tsukuba.png (100%)
rename docs/source/{images/user_logos => _static/logos}/Zap_Energy.png (100%)
rename docs/source/{images/user_logos => _static/logos}/digiLab_UK.png (100%)
diff --git a/docs/source/images/user_logos/Beihang_University.png b/docs/source/_static/logos/Beihang_University.png
similarity index 100%
rename from docs/source/images/user_logos/Beihang_University.png
rename to docs/source/_static/logos/Beihang_University.png
diff --git a/docs/source/images/user_logos/Commonwealth_Fusion_Systems Devens_MA_USA.png b/docs/source/_static/logos/Commonwealth_Fusion_Systems Devens_MA_USA.png
similarity index 100%
rename from docs/source/images/user_logos/Commonwealth_Fusion_Systems Devens_MA_USA.png
rename to docs/source/_static/logos/Commonwealth_Fusion_Systems Devens_MA_USA.png
diff --git a/docs/source/images/user_logos/Cranfield_University_UK.png b/docs/source/_static/logos/Cranfield_University_UK.png
similarity index 100%
rename from docs/source/images/user_logos/Cranfield_University_UK.png
rename to docs/source/_static/logos/Cranfield_University_UK.png
diff --git a/docs/source/images/user_logos/ENEA.png b/docs/source/_static/logos/ENEA.png
similarity index 100%
rename from docs/source/images/user_logos/ENEA.png
rename to docs/source/_static/logos/ENEA.png
diff --git a/docs/source/images/user_logos/ENI.png b/docs/source/_static/logos/ENI.png
similarity index 100%
rename from docs/source/images/user_logos/ENI.png
rename to docs/source/_static/logos/ENI.png
diff --git a/docs/source/images/user_logos/Exeter_University_UK.png b/docs/source/_static/logos/Exeter_University_UK.png
similarity index 100%
rename from docs/source/images/user_logos/Exeter_University_UK.png
rename to docs/source/_static/logos/Exeter_University_UK.png
diff --git a/docs/source/images/user_logos/Frazer_Nash.png b/docs/source/_static/logos/Frazer_Nash.png
similarity index 100%
rename from docs/source/images/user_logos/Frazer_Nash.png
rename to docs/source/_static/logos/Frazer_Nash.png
diff --git a/docs/source/images/user_logos/IRFM_cadarache_France.png b/docs/source/_static/logos/IRFM_cadarache_France.png
similarity index 100%
rename from docs/source/images/user_logos/IRFM_cadarache_France.png
rename to docs/source/_static/logos/IRFM_cadarache_France.png
diff --git a/docs/source/images/user_logos/ITER_organization_France.png b/docs/source/_static/logos/ITER_organization_France.png
similarity index 100%
rename from docs/source/images/user_logos/ITER_organization_France.png
rename to docs/source/_static/logos/ITER_organization_France.png
diff --git "a/docs/source/images/user_logos/Institut_Jo\305\276ef_Stefan.png" "b/docs/source/_static/logos/Institut_Jo\305\276ef_Stefan.png"
similarity index 100%
rename from "docs/source/images/user_logos/Institut_Jo\305\276ef_Stefan.png"
rename to "docs/source/_static/logos/Institut_Jo\305\276ef_Stefan.png"
diff --git a/docs/source/images/user_logos/Institute_of_plasma_physics_Chinese_academy_of_sciences.png b/docs/source/_static/logos/Institute_of_plasma_physics_Chinese_academy_of_sciences.png
similarity index 100%
rename from docs/source/images/user_logos/Institute_of_plasma_physics_Chinese_academy_of_sciences.png
rename to docs/source/_static/logos/Institute_of_plasma_physics_Chinese_academy_of_sciences.png
diff --git a/docs/source/images/user_logos/Kyoto_Fusioneering.png b/docs/source/_static/logos/Kyoto_Fusioneering.png
similarity index 100%
rename from docs/source/images/user_logos/Kyoto_Fusioneering.png
rename to docs/source/_static/logos/Kyoto_Fusioneering.png
diff --git a/docs/source/images/user_logos/LSPM_Villetaneuse_France.png b/docs/source/_static/logos/LSPM_Villetaneuse_France.png
similarity index 100%
rename from docs/source/images/user_logos/LSPM_Villetaneuse_France.png
rename to docs/source/_static/logos/LSPM_Villetaneuse_France.png
diff --git a/docs/source/images/user_logos/Logo_of_University_of_Tsukuba.png b/docs/source/_static/logos/Logo_of_University_of_Tsukuba.png
similarity index 100%
rename from docs/source/images/user_logos/Logo_of_University_of_Tsukuba.png
rename to docs/source/_static/logos/Logo_of_University_of_Tsukuba.png
diff --git a/docs/source/images/user_logos/MEPhI_moscow_Russia.png b/docs/source/_static/logos/MEPhI_moscow_Russia.png
similarity index 100%
rename from docs/source/images/user_logos/MEPhI_moscow_Russia.png
rename to docs/source/_static/logos/MEPhI_moscow_Russia.png
diff --git a/docs/source/images/user_logos/MIT_Cambridge_MA_USA.png b/docs/source/_static/logos/MIT_Cambridge_MA_USA.png
similarity index 100%
rename from docs/source/images/user_logos/MIT_Cambridge_MA_USA.png
rename to docs/source/_static/logos/MIT_Cambridge_MA_USA.png
diff --git a/docs/source/images/user_logos/Marathon_Fusion_USA.png b/docs/source/_static/logos/Marathon_Fusion_USA.png
similarity index 100%
rename from docs/source/images/user_logos/Marathon_Fusion_USA.png
rename to docs/source/_static/logos/Marathon_Fusion_USA.png
diff --git a/docs/source/images/user_logos/Oak_Ridge_National_Laboratory.png b/docs/source/_static/logos/Oak_Ridge_National_Laboratory.png
similarity index 100%
rename from docs/source/images/user_logos/Oak_Ridge_National_Laboratory.png
rename to docs/source/_static/logos/Oak_Ridge_National_Laboratory.png
diff --git a/docs/source/images/user_logos/Politecnico_di_Torino.png b/docs/source/_static/logos/Politecnico_di_Torino.png
similarity index 100%
rename from docs/source/images/user_logos/Politecnico_di_Torino.png
rename to docs/source/_static/logos/Politecnico_di_Torino.png
diff --git a/docs/source/images/user_logos/Thea_Energy_USA.png b/docs/source/_static/logos/Thea_Energy_USA.png
similarity index 100%
rename from docs/source/images/user_logos/Thea_Energy_USA.png
rename to docs/source/_static/logos/Thea_Energy_USA.png
diff --git a/docs/source/images/user_logos/UKAEA_UK.png b/docs/source/_static/logos/UKAEA_UK.png
similarity index 100%
rename from docs/source/images/user_logos/UKAEA_UK.png
rename to docs/source/_static/logos/UKAEA_UK.png
diff --git a/docs/source/images/user_logos/University_San_Diego.png b/docs/source/_static/logos/University_San_Diego.png
similarity index 100%
rename from docs/source/images/user_logos/University_San_Diego.png
rename to docs/source/_static/logos/University_San_Diego.png
diff --git a/docs/source/images/user_logos/University_Wisconsin_Madison_USA.png b/docs/source/_static/logos/University_Wisconsin_Madison_USA.png
similarity index 100%
rename from docs/source/images/user_logos/University_Wisconsin_Madison_USA.png
rename to docs/source/_static/logos/University_Wisconsin_Madison_USA.png
diff --git a/docs/source/images/user_logos/University_of_Surrey.png b/docs/source/_static/logos/University_of_Surrey.png
similarity index 100%
rename from docs/source/images/user_logos/University_of_Surrey.png
rename to docs/source/_static/logos/University_of_Surrey.png
diff --git a/docs/source/images/user_logos/University_of_Tsukuba.png b/docs/source/_static/logos/University_of_Tsukuba.png
similarity index 100%
rename from docs/source/images/user_logos/University_of_Tsukuba.png
rename to docs/source/_static/logos/University_of_Tsukuba.png
diff --git a/docs/source/images/user_logos/Zap_Energy.png b/docs/source/_static/logos/Zap_Energy.png
similarity index 100%
rename from docs/source/images/user_logos/Zap_Energy.png
rename to docs/source/_static/logos/Zap_Energy.png
diff --git a/docs/source/images/user_logos/digiLab_UK.png b/docs/source/_static/logos/digiLab_UK.png
similarity index 100%
rename from docs/source/images/user_logos/digiLab_UK.png
rename to docs/source/_static/logos/digiLab_UK.png
diff --git a/docs/source/_static/style.css b/docs/source/_static/style.css
index ba64e9e20..257c23386 100644
--- a/docs/source/_static/style.css
+++ b/docs/source/_static/style.css
@@ -75,4 +75,169 @@ https://github.com/executablebooks/sphinx-book-theme/issues/879
h3 {
font-size: 125%;
font-weight: normal;
+}
+
+
+/* =============================================================
+ FESTIM LANDING PAGE STYLES
+ ============================================================= */
+
+/* ---- Section headings ---- */
+.festim-section-heading {
+ text-align: center;
+ margin-top: 3rem;
+ margin-bottom: 1.5rem;
+}
+
+/* =============================================================
+ HERO
+ ============================================================= */
+.festim-hero {
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ gap: 3rem;
+ padding: 3rem 1rem 2rem;
+ flex-wrap: wrap;
+}
+
+.festim-hero-text {
+ flex: 1 1 360px;
+ max-width: 500px;
+}
+
+.festim-hero-text h1 {
+ font-size: 3rem;
+ margin-bottom: 0.5rem;
+}
+
+.festim-hero-subtitle {
+ font-size: 1.25rem;
+ color: var(--pst-color-text-muted);
+ margin-bottom: 1.5rem;
+ line-height: 1.5;
+}
+
+.festim-hero-subtitle a {
+ font-weight: 600;
+}
+
+.festim-hero-buttons {
+ display: flex;
+ gap: 0.75rem;
+ flex-wrap: wrap;
+}
+
+/* ---- Carousel in hero ---- */
+.festim-hero-carousel {
+ flex: 1 1 400px;
+ max-width: 520px;
+}
+
+.festim-hero-carousel .carousel {
+ border-radius: 0.5rem;
+ overflow: hidden;
+ background-color: var(--pst-color-surface);
+ border: 1px solid var(--pst-color-border);
+}
+
+.festim-hero-carousel .carousel-item img {
+ width: 100%;
+ height: 320px;
+ object-fit: contain;
+ padding: 1rem;
+}
+
+.festim-carousel-caption {
+ text-align: center;
+ padding: 0.5rem 1rem 1rem;
+ color: var(--pst-color-text-muted);
+ font-size: 0.9rem;
+ margin: 0;
+}
+
+.festim-hero-carousel .carousel-control-prev-icon,
+.festim-hero-carousel .carousel-control-next-icon {
+ filter: drop-shadow(0 0 2px var(--pst-color-text-base));
+}
+
+/* responsive: stack on small screens */
+@media (max-width: 768px) {
+ .festim-hero {
+ flex-direction: column;
+ text-align: center;
+ }
+ .festim-hero-buttons {
+ justify-content: center;
+ }
+ .festim-hero-carousel {
+ max-width: 100%;
+ }
+}
+
+/* =============================================================
+ LOGO RIBBON
+ ============================================================= */
+.festim-ribbon-wrapper {
+ overflow: hidden;
+ position: relative;
+ width: 100%;
+ padding: 1rem 0;
+}
+
+/* Fade edges */
+.festim-ribbon-wrapper::before,
+.festim-ribbon-wrapper::after {
+ content: "";
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ width: 60px;
+ z-index: 2;
+ pointer-events: none;
+}
+
+.festim-ribbon-wrapper::before {
+ left: 0;
+ background: linear-gradient(to right, var(--pst-color-background), transparent);
+}
+
+.festim-ribbon-wrapper::after {
+ right: 0;
+ background: linear-gradient(to left, var(--pst-color-background), transparent);
+}
+
+.festim-ribbon-track {
+ display: flex;
+ align-items: center;
+ gap: 2.5rem;
+ width: max-content;
+ animation: festim-scroll 60s linear infinite;
+}
+
+.festim-ribbon-track:hover {
+ animation-play-state: paused;
+}
+
+.festim-ribbon-track img {
+ height: 50px;
+ width: auto;
+ object-fit: contain;
+ filter: grayscale(100%);
+ opacity: 0.7;
+ transition: filter 0.3s ease, opacity 0.3s ease;
+}
+
+.festim-ribbon-track img:hover {
+ filter: grayscale(0%);
+ opacity: 1.0;
+}
+
+@keyframes festim-scroll {
+ 0% {
+ transform: translateX(0);
+ }
+ 100% {
+ transform: translateX(-50%);
+ }
}
\ No newline at end of file
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 2016a27ea..ecc2bd740 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -5,48 +5,11 @@
# -- Path setup --------------------------------------------------------------
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
import os
import sys
sys.path.insert(0, os.path.abspath("../../src"))
-
-# Generate the map
-
-# Add the directory containing your Python script to the Python path
-sys.path.insert(0, os.path.abspath("."))
-
-import map
-
-m = map.generate_map()
-current_dir = os.path.dirname(__file__)
-html_path = os.path.join(current_dir, "_static", "map.html")
-
-# create _static directory if it doesn't exist
-os.makedirs(os.path.dirname(html_path), exist_ok=True)
-
-m.save(html_path)
-
-
-# Generate the map
-
-# Add the directory containing your Python script to the Python path
-sys.path.insert(0, os.path.abspath("."))
-
-
-m = map.generate_map()
-current_dir = os.path.dirname(__file__)
-html_path = os.path.join(current_dir, "_static", "map.html")
-
-# create _static directory if it doesn't exist
-os.makedirs(os.path.dirname(html_path), exist_ok=True)
-
-m.save(html_path)
-
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -59,9 +22,6 @@
# -- General configuration ---------------------------------------------------
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
@@ -79,37 +39,24 @@
suppress_warnings = ["autosectionlabel.*"]
-napoleon_use_ivar = True # needed to correctly format class attributes
+napoleon_use_ivar = True
-# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
-
source_suffix = ".rst"
-# The master toctree document.
master_doc = "index"
-# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
-
-# shorten module names in readme
add_module_names = False
-# bibliography file
bibtex_bibfiles = ["bibliography/references.bib"]
# -- Options for HTML output -------------------------------------------------
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-#
html_theme = "pydata_sphinx_theme"
html_static_path = ["_static"]
html_css_files = ["style.css"]
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 3170d4911..144cb2220 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,85 +1,285 @@
-FESTIM
-======
+:html_theme.sidebar_secondary.remove:
-FESTIM is a FEniCS-based application for solving coupled hydrogen transport - heat transfer simulations.
-The tool is based on the finite element methods to solve the McNabb & Foster transport equations and the heat equation.
-It is capable of solving 1D/2D/3D multimaterial simulations and provides support for a wide-range of boundary conditions, which makes it a very versatile tool that can be adapted to many use cases.
-Moreover, users can rapidly get started with FESTIM thanks to its python API.
+.. raw:: html
+
+
+
+
+
FESTIM
+
+ Simulate hydrogen transport in materials with Python, powered by
+ FEniCS
+
+
+
+
+
+
+
+
+
+
+
Tritium retention in a monoblock
+
+
+
+
+
Permeation through a multi-layer membrane
+
+
+
+
+
Thermo-desorption spectrum analysis
+
+
+
+
+
2D hydrogen transport in a breeding blanket
+
+
+
+
+
Multi-material 3D simulation
+
+
+
+
+
+
+ Previous
+
+
+
+ Next
+
+
+
+
+
+
+.. raw:: html
+
+
+ Why FESTIM?
+
+.. grid:: 5
+ :gutter: 3
+
+ .. grid-item-card:: Multi-dimensional
+ :text-align: center
+
+ Run simulations in 1D, 2D, or 3D to match your problem geometry.
+
+ .. grid-item-card:: Multi-material
+ :text-align: center
+
+ Model complex assemblies with multiple materials and hydrogen isotopes.
+
+ .. grid-item-card:: Flexible BCs
+ :text-align: center
+
+ Choose from a wide range of boundary conditions adaptable to many use cases.
-.. All the logos are from this collection https://www.svgrepo.com/collection/solar-linear-icons/
+ .. grid-item-card:: Python API
+ :text-align: center
+
+ Get started quickly with a clean, minimal Python interface.
+
+ .. grid-item-card:: Built on FEniCS
+ :text-align: center
+
+ Leverages the mature FEniCS finite element framework for robust, scalable simulations.
+
+
+.. raw:: html
+
+
+ Explore the documentation
.. grid:: 3
- :gutter: 2
+ :gutter: 2
+
+ .. grid-item::
+
+ .. card:: Installation
+ :img-top: images/icons/running-2-svgrepo-com.svg
+ :link: installation
+ :link-type: doc
- .. grid-item::
+ .. grid-item::
- .. card:: Installation
- :img-top: images/icons/running-2-svgrepo-com.svg
- :link: installation
- :link-type: doc
+ .. card:: User guide
+ :img-top: images/icons/book-2-svgrepo-com.svg
+ :link: userguide/index
+ :link-type: doc
- .. grid-item::
+ .. grid-item::
- .. card:: User guide
- :img-top: images/icons/book-2-svgrepo-com.svg
- :link: userguide/index
- :link-type: doc
+ .. card:: Tutorials
+ :img-top: images/icons/clapperboard-play-svgrepo-com.svg
+ :link: https://festim-workshop.readthedocs.io/
- .. grid-item::
+ .. grid-item::
- .. card:: Tutorials
- :img-top: images/icons/clapperboard-play-svgrepo-com.svg
- :link: https://festim-workshop.readthedocs.io/
+ .. card:: Developer guide
+ :img-top: images/icons/code-square-svgrepo-com.svg
+ :link: devguide/index
+ :link-type: doc
- .. grid-item::
+ .. grid-item::
- .. card:: Developer guide
- :img-top: images/icons/code-square-svgrepo-com.svg
- :link: devguide/index
- :link-type: doc
+ .. card:: V&V
+ :img-top: images/icons/check-square-svgrepo-com.svg
+ :link: https://festim-vv-report.readthedocs.io/en/latest/
- .. grid-item::
- .. card:: V&V
- :img-top: images/icons/check-square-svgrepo-com.svg
- :link: https://festim-vv-report.readthedocs.io/en/latest/
+ .. grid-item::
- .. grid-item::
- .. card:: Fellowship
- :img-top: images/icons/graph-up-svgrepo-com.svg
- :link: fellowship
- :link-type: doc
+ .. card:: Fellowship
+ :img-top: images/icons/graph-up-svgrepo-com.svg
+ :link: fellowship
+ :link-type: doc
-FESTIM was originally developed at the `Institute for Magnetic Fusion Research (IRFM) `_ and the `Process and Materials Sciences Laboratory (LSPM) `_.
-Various research institutions and private companies now contribute actively to FESTIM's development.
-For more information, feel free to ask questions on the `FESTIM Discourse Page `_.
+.. raw:: html
+
+
+ Trusted by researchers worldwide
-.. admonition:: Recommended publication for citing
- :class: tip
+
+
+
+ Want your institution listed?
+ Open an issue .
+
-Map of FESTIM users
--------------------
.. raw:: html
-
+
+ Citing FESTIM
+
+If you use FESTIM in your research, please cite the following publication:
+
+.. image:: https://img.shields.io/badge/DOI-10.1016%2Fj.ijhydene.2024.03.184-blue
+ :target: https://doi.org/10.1016/j.ijhydene.2024.03.184
+ :alt: DOI badge
+.. dropdown:: BibTeX
+
+ .. code-block:: bibtex
+
+ @article{delaporte2024festim,
+ title = {{FESTIM}: An open-source code for hydrogen transport simulations},
+ author = {Delaporte-Mathurin, R{\'e}mi and Dark, James and Ferrero, Gabriele
+ and Hodille, Etienne A. and Kulagin, Vladimir and Meschini, Samuele},
+ journal = {International Journal of Hydrogen Energy},
+ volume = {63},
+ pages = {786--802},
+ year = {2024},
+ doi = {10.1016/j.ijhydene.2024.03.184}
+ }
+
+
+.. raw:: html
-.. admonition:: Add your institution
+
+ Join the community
- If you would like your institution to be added to this map, please `open an issue `_.
+
+ Have a question, found a bug, or want to contribute?
+ Connect with the FESTIM community.
+
+
---------
-Contents
---------
.. toctree::
:maxdepth: 1
+ :hidden:
installation
userguide/index
From dedff13b569943d323e45375453b9d0260cd1770 Mon Sep 17 00:00:00 2001
From: RemDelaporteMathurin
Date: Tue, 28 Apr 2026 20:40:25 -0400
Subject: [PATCH 02/12] update CSS
---
.gitignore | 2 +-
docs/source/_static/style.css | 58 +++++++++++++++++++++++++++++++++++
docs/source/index.rst | 2 +-
3 files changed, 60 insertions(+), 2 deletions(-)
diff --git a/.gitignore b/.gitignore
index 4d354b9df..ebd4bee22 100644
--- a/.gitignore
+++ b/.gitignore
@@ -65,7 +65,7 @@ instance/
# Sphinx documentation
docs/*/_build/
-docs/*/_static/
+# docs/*/_static/
docs/*/_templates/
# PyBuilder
diff --git a/docs/source/_static/style.css b/docs/source/_static/style.css
index 257c23386..8712db3d1 100644
--- a/docs/source/_static/style.css
+++ b/docs/source/_static/style.css
@@ -1,5 +1,13 @@
@import url('https://fonts.googleapis.com/css2?family=Lato:ital,wght@0,400;0,700;0,900;1,400;1,700;1,900&family=Open+Sans:ital,wght@0,400;0,600;1,400;1,600&display=swap');
+/* =============================================================
+ FESTIM BRAND COLOURS
+ ============================================================= */
+:root {
+ --festim-primary: #1a4848;
+ --festim-primary-hover: #f7b000;
+}
+
body {
font-family: 'Open Sans', sans-serif;
}
@@ -128,6 +136,56 @@ h3 {
flex-wrap: wrap;
}
+/* ---- Override button colours on landing page ---- */
+.festim-hero-buttons .btn-primary,
+.festim-hero-buttons .btn-primary:visited {
+ background-color: var(--festim-primary);
+ border-color: var(--festim-primary);
+ color: #fff;
+}
+
+.festim-hero-buttons .btn-primary:hover,
+.festim-hero-buttons .btn-primary:focus,
+.festim-hero-buttons .btn-primary:active {
+ background-color: var(--festim-primary-hover);
+ border-color: var(--festim-primary-hover);
+ color: #fff;
+ text-decoration: none;
+}
+
+.festim-hero-buttons .btn-outline-primary,
+.festim-hero-buttons .btn-outline-primary:visited {
+ color: var(--festim-primary);
+ border-color: var(--festim-primary);
+ background-color: transparent;
+}
+
+.festim-hero-buttons .btn-outline-primary:hover,
+.festim-hero-buttons .btn-outline-primary:focus,
+.festim-hero-buttons .btn-outline-primary:active {
+ background-color: var(--festim-primary-hover);
+ border-color: var(--festim-primary-hover);
+ color: #fff;
+ text-decoration: none;
+}
+
+/* ---- Community section buttons ---- */
+.festim-community-buttons .btn-outline-primary,
+.festim-community-buttons .btn-outline-primary:visited {
+ color: var(--festim-primary);
+ border-color: var(--festim-primary);
+ background-color: transparent;
+}
+
+.festim-community-buttons .btn-outline-primary:hover,
+.festim-community-buttons .btn-outline-primary:focus,
+.festim-community-buttons .btn-outline-primary:active {
+ background-color: var(--festim-primary);
+ border-color: var(--festim-primary);
+ color: #fff;
+ text-decoration: none;
+}
+
/* ---- Carousel in hero ---- */
.festim-hero-carousel {
flex: 1 1 400px;
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 144cb2220..0fd6f3dc8 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -264,7 +264,7 @@ If you use FESTIM in your research, please cite the following publication:
Connect with the FESTIM community.
-
+