From 932f753df2449ebb4eafac95e2e06772b7b89f3b Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Tue, 8 Oct 2024 10:24:25 -0400 Subject: [PATCH 1/5] added cards on the front page --- docs/source/_static/style.css | 45 ++++++++++++++++ .../check-mark-ok-accept-svgrepo-com.svg | 10 ++++ docs/source/images/index_api.svg | 26 ++++++++++ docs/source/images/index_contribute.svg | 21 ++++++++ docs/source/images/index_getting_started.svg | 18 +++++++ docs/source/images/index_user_guide.svg | 18 +++++++ docs/source/images/learn-svgrepo-com.svg | 2 + docs/source/index.rst | 52 +++++++++++++++++++ 8 files changed, 192 insertions(+) create mode 100644 docs/source/_static/style.css create mode 100644 docs/source/images/check-mark-ok-accept-svgrepo-com.svg create mode 100644 docs/source/images/index_api.svg create mode 100644 docs/source/images/index_contribute.svg create mode 100644 docs/source/images/index_getting_started.svg create mode 100644 docs/source/images/index_user_guide.svg create mode 100644 docs/source/images/learn-svgrepo-com.svg diff --git a/docs/source/_static/style.css b/docs/source/_static/style.css new file mode 100644 index 000000000..9fe1a6a26 --- /dev/null +++ b/docs/source/_static/style.css @@ -0,0 +1,45 @@ +@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'); + +body { + font-family: 'Open Sans', sans-serif; +} + +h1 { + font-family: "Lato", sans-serif; +} + +pre, +code { + font-size: 100%; + line-height: 155%; +} + +/* Main page overview cards */ + +.sd-card { + border-radius: 0; + padding: 30px 10px 20px 10px; + margin: 10px 0px; +} + +.sd-card .sd-card-header { + text-align: center; +} + +.sd-card .sd-card-header .sd-card-text { + margin: 0px; +} + +.sd-card .sd-card-img-top { + height: 52px; + width: 52px; + margin-left: auto; + margin-right: auto; +} + +.sd-card .sd-card-header { + border: none; + font-size: var(--pst-font-size-h5); + font-weight: bold; + padding: 2.5rem 0rem 0.5rem 0rem; +} \ No newline at end of file diff --git a/docs/source/images/check-mark-ok-accept-svgrepo-com.svg b/docs/source/images/check-mark-ok-accept-svgrepo-com.svg new file mode 100644 index 000000000..a80a39dd9 --- /dev/null +++ b/docs/source/images/check-mark-ok-accept-svgrepo-com.svg @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/images/index_api.svg b/docs/source/images/index_api.svg new file mode 100644 index 000000000..ceb5be6af --- /dev/null +++ b/docs/source/images/index_api.svg @@ -0,0 +1,26 @@ + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + diff --git a/docs/source/images/index_contribute.svg b/docs/source/images/index_contribute.svg new file mode 100644 index 000000000..24a29f328 --- /dev/null +++ b/docs/source/images/index_contribute.svg @@ -0,0 +1,21 @@ + + + + + + + + + image/svg+xml + + + + + + + + + + + + diff --git a/docs/source/images/index_getting_started.svg b/docs/source/images/index_getting_started.svg new file mode 100644 index 000000000..2afbbe1de --- /dev/null +++ b/docs/source/images/index_getting_started.svg @@ -0,0 +1,18 @@ + + + + + + + + + image/svg+xml + + + + + + + + + diff --git a/docs/source/images/index_user_guide.svg b/docs/source/images/index_user_guide.svg new file mode 100644 index 000000000..d70b3d73d --- /dev/null +++ b/docs/source/images/index_user_guide.svg @@ -0,0 +1,18 @@ + + + + + + + + + image/svg+xml + + + + + + + + + diff --git a/docs/source/images/learn-svgrepo-com.svg b/docs/source/images/learn-svgrepo-com.svg new file mode 100644 index 000000000..d7b577704 --- /dev/null +++ b/docs/source/images/learn-svgrepo-com.svg @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 423e5240a..05a4385d3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,6 +23,58 @@ For more information, feel free to ask questions on the `FESTIM Discourse Page < "`FESTIM: An open-source code for hydrogen transport simulations. International Journal of Hydrogen Energy 63 (2024): 786-802. `_", +.. grid:: 1 1 3 3 + :gutter: 2 + + .. grid-item-card:: + :img-top: images/index_getting_started.svg + :link: installation + :link-type: doc + + Installation + ^^^^^^^^^^^^^ + + .. grid-item-card:: + :img-top: images/index_user_guide.svg + :link: userguide/index + :link-type: doc + + User guide + ^^^^^^^^^^^ + + .. grid-item-card:: + :img-top: images/learn-svgrepo-com.svg + :link: https://github.com/festim-dev/FESTIM-workshop + + Tutorials + ^^^^^^^^^ + Learn how to use FESTIM + + .. grid-item-card:: + :img-top: images/index_contribute.svg + :link: devguide/index + :link-type: doc + + Developer guide + ^^^^^^^^^^^^^^^^^^ + Learn how to contribute to FESTIM + + .. grid-item-card:: + :img-top: images/check-mark-ok-accept-svgrepo-com.svg + :link: https://festim-vv-report.readthedocs.io/en/latest/ + + V&V + ^^^ + Check out the Verification and Validation online book + + .. grid-item-card:: + :img-top: images/index_api.svg + :link: api/festim + :link-type: doc + + API reference + ^^^^^^^^^^^^^^ + Map of FESTIM users ------------------- From 0c164de2e313ce0c85cab494975a5225c7c4a266 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Tue, 8 Oct 2024 12:33:29 -0400 Subject: [PATCH 2/5] removed description --- docs/source/_static/style.css | 4 ++ docs/source/index.rst | 69 +++++++++++++++-------------------- 2 files changed, 33 insertions(+), 40 deletions(-) diff --git a/docs/source/_static/style.css b/docs/source/_static/style.css index 9fe1a6a26..04091a98a 100644 --- a/docs/source/_static/style.css +++ b/docs/source/_static/style.css @@ -26,6 +26,10 @@ code { text-align: center; } +.sd-card .sd-card-title { + text-align: center; +} + .sd-card .sd-card-header .sd-card-text { margin: 0px; } diff --git a/docs/source/index.rst b/docs/source/index.rst index 05a4385d3..653ae8876 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -24,56 +24,45 @@ For more information, feel free to ask questions on the `FESTIM Discourse Page < International Journal of Hydrogen Energy 63 (2024): 786-802. `_", .. grid:: 1 1 3 3 - :gutter: 2 + :gutter: 2 - .. grid-item-card:: - :img-top: images/index_getting_started.svg - :link: installation - :link-type: doc + .. grid-item:: - Installation - ^^^^^^^^^^^^^ + .. card:: Installation + :img-top: images/index_getting_started.svg + :link: installation + :link-type: doc - .. grid-item-card:: - :img-top: images/index_user_guide.svg - :link: userguide/index - :link-type: doc + .. grid-item:: - User guide - ^^^^^^^^^^^ + .. card:: User guide + :img-top: images/index_user_guide.svg + :link: userguide/index + :link-type: doc - .. grid-item-card:: - :img-top: images/learn-svgrepo-com.svg - :link: https://github.com/festim-dev/FESTIM-workshop + .. grid-item:: - Tutorials - ^^^^^^^^^ - Learn how to use FESTIM + .. card:: Tutorials + :img-top: images/learn-svgrepo-com.svg + :link: https://github.com/festim-dev/FESTIM-workshop - .. grid-item-card:: - :img-top: images/index_contribute.svg - :link: devguide/index - :link-type: doc + .. grid-item:: - Developer guide - ^^^^^^^^^^^^^^^^^^ - Learn how to contribute to FESTIM + .. card:: Developer guide + :img-top: images/index_contribute.svg + :link: devguide/index + :link-type: doc - .. grid-item-card:: - :img-top: images/check-mark-ok-accept-svgrepo-com.svg - :link: https://festim-vv-report.readthedocs.io/en/latest/ + .. grid-item:: + .. card:: V&V + :img-top: images/check-mark-ok-accept-svgrepo-com.svg + :link: https://festim-vv-report.readthedocs.io/en/latest/ - V&V - ^^^ - Check out the Verification and Validation online book - - .. grid-item-card:: - :img-top: images/index_api.svg - :link: api/festim - :link-type: doc - - API reference - ^^^^^^^^^^^^^^ + .. grid-item:: + .. card:: API reference + :img-top: images/index_api.svg + :link: api/festim + :link-type: doc Map of FESTIM users ------------------- From 95995268f6fa0b3752f3caff6ae01a6f8ba8e8f9 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Tue, 8 Oct 2024 12:41:36 -0400 Subject: [PATCH 3/5] changed logos --- .../check-mark-ok-accept-svgrepo-com.svg | 10 ------- .../images/icons/book-2-svgrepo-com.svg | 8 ++++++ .../images/icons/check-square-svgrepo-com.svg | 5 ++++ .../icons/clapperboard-play-svgrepo-com.svg | 8 ++++++ .../images/icons/code-square-svgrepo-com.svg | 7 +++++ .../images/icons/keyboard-svgrepo-com.svg | 15 +++++++++++ .../images/icons/running-2-svgrepo-com.svg | 7 +++++ docs/source/images/index_api.svg | 26 ------------------- docs/source/images/index_contribute.svg | 21 --------------- docs/source/images/index_getting_started.svg | 18 ------------- docs/source/images/index_user_guide.svg | 18 ------------- docs/source/images/learn-svgrepo-com.svg | 2 -- docs/source/index.rst | 14 +++++----- 13 files changed, 58 insertions(+), 101 deletions(-) delete mode 100644 docs/source/images/check-mark-ok-accept-svgrepo-com.svg create mode 100644 docs/source/images/icons/book-2-svgrepo-com.svg create mode 100644 docs/source/images/icons/check-square-svgrepo-com.svg create mode 100644 docs/source/images/icons/clapperboard-play-svgrepo-com.svg create mode 100644 docs/source/images/icons/code-square-svgrepo-com.svg create mode 100644 docs/source/images/icons/keyboard-svgrepo-com.svg create mode 100644 docs/source/images/icons/running-2-svgrepo-com.svg delete mode 100644 docs/source/images/index_api.svg delete mode 100644 docs/source/images/index_contribute.svg delete mode 100644 docs/source/images/index_getting_started.svg delete mode 100644 docs/source/images/index_user_guide.svg delete mode 100644 docs/source/images/learn-svgrepo-com.svg diff --git a/docs/source/images/check-mark-ok-accept-svgrepo-com.svg b/docs/source/images/check-mark-ok-accept-svgrepo-com.svg deleted file mode 100644 index a80a39dd9..000000000 --- a/docs/source/images/check-mark-ok-accept-svgrepo-com.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - \ No newline at end of file diff --git a/docs/source/images/icons/book-2-svgrepo-com.svg b/docs/source/images/icons/book-2-svgrepo-com.svg new file mode 100644 index 000000000..b24aa3976 --- /dev/null +++ b/docs/source/images/icons/book-2-svgrepo-com.svg @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/docs/source/images/icons/check-square-svgrepo-com.svg b/docs/source/images/icons/check-square-svgrepo-com.svg new file mode 100644 index 000000000..fbdfb91c6 --- /dev/null +++ b/docs/source/images/icons/check-square-svgrepo-com.svg @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/docs/source/images/icons/clapperboard-play-svgrepo-com.svg b/docs/source/images/icons/clapperboard-play-svgrepo-com.svg new file mode 100644 index 000000000..3d68ad02d --- /dev/null +++ b/docs/source/images/icons/clapperboard-play-svgrepo-com.svg @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/docs/source/images/icons/code-square-svgrepo-com.svg b/docs/source/images/icons/code-square-svgrepo-com.svg new file mode 100644 index 000000000..142d36bf7 --- /dev/null +++ b/docs/source/images/icons/code-square-svgrepo-com.svg @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/docs/source/images/icons/keyboard-svgrepo-com.svg b/docs/source/images/icons/keyboard-svgrepo-com.svg new file mode 100644 index 000000000..027f70f42 --- /dev/null +++ b/docs/source/images/icons/keyboard-svgrepo-com.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/images/icons/running-2-svgrepo-com.svg b/docs/source/images/icons/running-2-svgrepo-com.svg new file mode 100644 index 000000000..f0699589a --- /dev/null +++ b/docs/source/images/icons/running-2-svgrepo-com.svg @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/docs/source/images/index_api.svg b/docs/source/images/index_api.svg deleted file mode 100644 index ceb5be6af..000000000 --- a/docs/source/images/index_api.svg +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - diff --git a/docs/source/images/index_contribute.svg b/docs/source/images/index_contribute.svg deleted file mode 100644 index 24a29f328..000000000 --- a/docs/source/images/index_contribute.svg +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - - - image/svg+xml - - - - - - - - - - - - diff --git a/docs/source/images/index_getting_started.svg b/docs/source/images/index_getting_started.svg deleted file mode 100644 index 2afbbe1de..000000000 --- a/docs/source/images/index_getting_started.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - image/svg+xml - - - - - - - - - diff --git a/docs/source/images/index_user_guide.svg b/docs/source/images/index_user_guide.svg deleted file mode 100644 index d70b3d73d..000000000 --- a/docs/source/images/index_user_guide.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - image/svg+xml - - - - - - - - - diff --git a/docs/source/images/learn-svgrepo-com.svg b/docs/source/images/learn-svgrepo-com.svg deleted file mode 100644 index d7b577704..000000000 --- a/docs/source/images/learn-svgrepo-com.svg +++ /dev/null @@ -1,2 +0,0 @@ - - \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 653ae8876..1892de8af 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,44 +23,46 @@ For more information, feel free to ask questions on the `FESTIM Discourse Page < "`FESTIM: An open-source code for hydrogen transport simulations. International Journal of Hydrogen Energy 63 (2024): 786-802. `_", +.. All the logos are from this collection https://www.svgrepo.com/collection/solar-linear-icons/ + .. grid:: 1 1 3 3 :gutter: 2 .. grid-item:: .. card:: Installation - :img-top: images/index_getting_started.svg + :img-top: images/icons/running-2-svgrepo-com.svg :link: installation :link-type: doc .. grid-item:: .. card:: User guide - :img-top: images/index_user_guide.svg + :img-top: images/icons/book-2-svgrepo-com.svg :link: userguide/index :link-type: doc .. grid-item:: .. card:: Tutorials - :img-top: images/learn-svgrepo-com.svg + :img-top: images/icons/clapperboard-play-svgrepo-com.svg :link: https://github.com/festim-dev/FESTIM-workshop .. grid-item:: .. card:: Developer guide - :img-top: images/index_contribute.svg + :img-top: images/icons/code-square-svgrepo-com.svg :link: devguide/index :link-type: doc .. grid-item:: .. card:: V&V - :img-top: images/check-mark-ok-accept-svgrepo-com.svg + :img-top: images/icons/check-square-svgrepo-com.svg :link: https://festim-vv-report.readthedocs.io/en/latest/ .. grid-item:: .. card:: API reference - :img-top: images/index_api.svg + :img-top: images/icons/keyboard-svgrepo-com.svg :link: api/festim :link-type: doc From f03a0e4b048c111ea876f5e9f1095f1e136ca2b6 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Tue, 8 Oct 2024 12:44:10 -0400 Subject: [PATCH 4/5] moved text --- docs/source/index.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 1892de8af..523d2e189 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,18 +11,6 @@ The tool is based on the finite element methods to solve the McNabb & Foster tra 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. -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 `_. - - -.. admonition:: Recommended publication for citing - :class: tip - - Rémi Delaporte-Mathurin, James Dark, Gabriele Ferrero, Etienne A. Hodille, Vladimir Kulagin, Samuele Meschini, - "`FESTIM: An open-source code for hydrogen transport simulations. - International Journal of Hydrogen Energy 63 (2024): 786-802. `_", - .. All the logos are from this collection https://www.svgrepo.com/collection/solar-linear-icons/ .. grid:: 1 1 3 3 @@ -66,6 +54,18 @@ For more information, feel free to ask questions on the `FESTIM Discourse Page < :link: api/festim :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 `_. + + +.. admonition:: Recommended publication for citing + :class: tip + + Rémi Delaporte-Mathurin, James Dark, Gabriele Ferrero, Etienne A. Hodille, Vladimir Kulagin, Samuele Meschini, + "`FESTIM: An open-source code for hydrogen transport simulations. + International Journal of Hydrogen Energy 63 (2024): 786-802. `_", + Map of FESTIM users ------------------- From c551da30201acabf98108957f6bbd6bf77c1f836 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Sun, 13 Oct 2024 06:06:27 +0800 Subject: [PATCH 5/5] 3 colums for all screen sizes --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 523d2e189..2ca1c9324 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -13,7 +13,7 @@ Moreover, users can rapidly get started with FESTIM thanks to its python API. .. All the logos are from this collection https://www.svgrepo.com/collection/solar-linear-icons/ -.. grid:: 1 1 3 3 +.. grid:: 3 :gutter: 2 .. grid-item::