Welcome page of documentation: added README.md contents (#81)

* README contents to Welcome Page * Fix 1 README contents to Documentation * Fix 2 README contents to Welcome Page * Fix 3 README contents to Welcome Page * Fix 3 README contents to Welcome Page * Fix 4 README contents to Welcome Page * Fix 4 README contents to Welcome Page * Fix 4 README contents to Welcome Page * removed duplicate image * removed duplicate image and contents from welcome page * Removal of Contents * Restored Contents and Search * test toctree depth 1 * test toctree maxdepth 0 * toctree maxdepth recovered to 4 * hidden toctree, deleted search Page * includehidden * test toctree * hidden * hidden2 * hidden3 * hidden4 * Link to SC * Link to SC 2 * Link to SC 3 * Update wording around Kasper components Co-authored-by: 2xB <[email protected]> * Added toctree dropdown and link to Docker/README.md * Fix 1 Added toctree dropdown and link to Docker/README.md * Fix 2 Added toctree dropdown and link to Docker/README.md * Fix 3 Added toctree dropdown and link to Docker/README.md * Added sphinx_design for dropdown-menu support * Added sphinx_design for dropdown-menu support * Proper cropdown code, moved to top of page * Dropdown test --------- Co-authored-by: 2xB <[email protected]>
KATRIN-Experiment · Nov 14, 2023 · c7388ed · c7388ed
1 parent 54e25bb
commit c7388ed
Show file tree

Hide file tree

Showing 4 changed files with 89 additions and 12 deletions.
diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml
@@ -11,7 +11,7 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Install dependencies
-      run: pip install sphinx_rtd_theme
+      run: pip install sphinx_rtd_theme sphinx_design
 
     - name: Build target "build"
       run: cd Documentation/gh-pages && make github

diff --git a/Documentation/gh-pages/source/conf.py b/Documentation/gh-pages/source/conf.py
@@ -42,6 +42,7 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.graphviz',
     'sphinx_rtd_theme',
+    'sphinx_design'
 ]
 
 extlinks = {

diff --git a/Documentation/gh-pages/source/index.rst b/Documentation/gh-pages/source/index.rst
@@ -3,16 +3,41 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Kassiopeia's documentation!
-**************************************
 
-.. image:: _images/KassiopeiaLogo_1_bb.png
-    :width: 250pt
+|Release github| |Code Size| |Issues github| |Pull Requests github| 
+|Last Commit github| |Contributors github| |Gitter github| |Binder github|
+
+.. |Release github| image:: https://img.shields.io/github/v/release/KATRIN-Experiment/Kassiopeia
+   :target: https://github.com/KATRIN-Experiment/Kassiopeia/releases
+
+.. |Code Size| image:: https://img.shields.io/github/languages/code-size/KATRIN-Experiment/Kassiopeia
+   :target: https://github.com/KATRIN-Experiment/Kassiopeia
+
+.. |Issues github| image:: https://img.shields.io/github/issues/KATRIN-Experiment/Kassiopeia
+   :target: https://github.com/KATRIN-Experiment/Kassiopeia/issues
+
+.. |Pull Requests github| image:: https://img.shields.io/github/issues-pr/KATRIN-Experiment/Kassiopeia
+   :target: https://github.com/KATRIN-Experiment/Kassiopeia/pulls
+
+.. |Last Commit github| image:: https://img.shields.io/github/last-commit/KATRIN-Experiment/Kassiopeia
+   :target: https://github.com/KATRIN-Experiment/Kassiopeia/commits
+
+.. |Contributors github| image:: https://img.shields.io/github/contributors/KATRIN-Experiment/Kassiopeia
+   :target: https://github.com/KATRIN-Experiment/Kassiopeia/graphs/contributors
+
+.. |Gitter github| image:: https://badges.gitter.im/kassiopeia-simulation/community.svg
+   :target: https://gitter.im/kassiopeia-simulation/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
+
+.. |Binder github| image:: https://mybinder.org/badge_logo.svg
+   :target: https://mybinder.org/v2/gh/KATRIN-Experiment/KassiopeiaBinder/HEAD
+
 
-Contents
-========
+Welcome to Kassiopeia's documentation!
+**************************************
 
-.. toctree::
+.. dropdown:: **Documentation Contents**
+
+ .. toctree::
     :maxdepth: 4
 
     Introduction <introduction.rst>
@@ -28,8 +53,59 @@ Contents
     XML Bindings <bindings.rst>
     License <license.rst>
     Authors <authors.rst>
+
+
+
+
+
+
+
+
+This simulation package by `the KATRIN collaboration`_ allows to run highly customizable particle tracking simulations
+along with calculations of electric and magnetic fields.
+
+.. _`the KATRIN collaboration`: https://katrin.kit.edu
+
+**Source Code:** https://github.com/KATRIN-Experiment/Kassiopeia
+
+
+**Quick start:** |Try it out online|_
+in an interactive Binder session. Open a "VNC (Desktop)" tab and a terminal tab and run
+
+
+.. |Try it out online| replace:: **Try it out online**
+.. _Try it out online: https://mybinder.org/v2/gh/KATRIN-Experiment/KassiopeiaBinder/HEAD
+
+
+.. code-block:: bash
+
+    Kassiopeia $KASPERSYS/config/Kassiopeia/Examples/DipoleTrapSimulation.xml
+
+
+to run your first simulation! *Note: A VTK error indicates that the "VNC (Desktop)" tab is not open yet.*
+
+**Cite** |our paper|_\ **:**
+
+.. |our paper| replace:: **our paper**
+.. _our paper: https://iopscience.iop.org/article/10.1088/1367-2630/aa6950
+
+.. code-block:: bash
+
+    D. Furse et al. (2017) New J. Phys. 19 053012: “Kassiopeia: A Modern, Extensible C++ Particle Tracking Package” (doi:10.1088/1367-2630/aa6950)
+
+
+**Docker images**
+--------------
+
+**All images:** https://github.com/orgs/KATRIN-Experiment/packages
+
+The `kassiopeia/full` image comes with a JupyterLab installation, can run on Kubernetes based JupyterHubs and is also used for the "try it out online" link above.
+
+
+|More information|_
+
+.. |More information| replace:: **More information**
+.. _More information: https://github.com/KATRIN-Experiment/Kassiopeia/blob/main/Docker/README.md
+
 
-Indices and tables
-==================
 
-* :ref:`search`
diff --git a/Documentation/gh-pages/source/introduction.rst b/Documentation/gh-pages/source/introduction.rst
@@ -17,7 +17,7 @@ The Kasper framework
 ====================
 
 The *Kassiopeia* software relies upon three separate, but concurrently distributed libraries. These are *Kommon*,
-*KGeoBag*, and *KEMField* and part of the **Kasper** framework.
+*KGeoBag* and *KEMField*.
 
 * *Kommon* contains a collection of commonly used and very basic utilities which are used by the other three
   packages. It also contains a unique system for parsing and constructing objects from an XML file.