Documentation: Combined Getting Help & Contact sections

This adds back the email contacts to the README.md and combines the newly added Getting help section with Contacts/References
KATRIN-Experiment · Dec 19, 2023 · a6dfe46 · a6dfe46
1 parent f29e76b
commit a6dfe46
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 43 deletions.
diff --git a/Documentation/gh-pages/source/discussion.rst → Documentation/gh-pages/source/contact.rst b/Documentation/gh-pages/source/discussion.rst → Documentation/gh-pages/source/contact.rst
@@ -1,15 +1,23 @@
 
-Meeting and Getting Help
-*************************
-
-Join the Kassiopeia community on Gitter: https://gitter.im/kassiopeia-simulation/community
+Contact, Meeting and References
+*********************************
 
 You can `contribute changes <https://github.com/KATRIN-Experiment/Kassiopeia/compare>`_, `report issues <https://github.com/KATRIN-Experiment/Kassiopeia/issues/new>`_ and `join discussions <https://github.com/KATRIN-Experiment/Kassiopeia/discussions>`_ on Github.
 
-Regular Meeting
-===============
+Join the Kassiopeia community on `Gitter <https://gitter.im/kassiopeia-simulation/community>`_.
+
+Contact
+=======
+
+*  Kasper development list: katrin-kasper@lists.kit.edu
+*  Richard Salomon: richardsalomon@uni-muenster.de
+*  Benedikt Bieringer: benedikt.b@uni-muenster.de
+
 
 
+Regular Meeting
+=======
+
 We also organize a regular meeting via Zoom. 
 
 Kassiopeia **users as well as developers** can join, ask questions, raise issues and discuss development topics. 
@@ -18,8 +26,21 @@ It does not matter whether you are already an expert or a complete beginner. **E
 The meeting is announced via email. 
 Please register for the `mailing list <https://www.lists.kit.edu/sympa/subscribe/kassiopeia-user>`_ if you are interested. 
 
-Primary email contacts: 
 
-*  Kasper development list: katrin-kasper@lists.kit.edu
-*  Richard Salomon: richardsalomon@uni-muenster.de
-*  Benedikt Bieringer: benedikt.b@uni-muenster.de
+References and Citation
+==========
+
+**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)
+
+
+In addition to this user guide, *Kassiopeia* and its associated libraries have been documented extensively in several
+PhD theses. Many of these can be found under the list of KATRIN publications_.
+
+.. _publications: https://www.katrin.kit.edu/375.php
diff --git a/Documentation/gh-pages/source/external_documentation.rst b/Documentation/gh-pages/source/external_documentation.rst
diff --git a/Documentation/gh-pages/source/index.rst b/Documentation/gh-pages/source/index.rst
@@ -40,8 +40,8 @@ Welcome to Kassiopeia's documentation!
  .. toctree::
     :maxdepth: 4
 
-    Introduction <introduction.rst>
-    References, Citation and Contact <external_documentation.rst>
+    Contact, Meeting and References <contact.rst>
+    Introduction <introduction.rst> 
     Getting Started <compiling.rst>
     Examples and Tests <examples.rst>
     Configuring Your Own Simulation <configuration.rst>
@@ -51,7 +51,6 @@ Welcome to Kassiopeia's documentation!
     Additional Simulation Tools <tools.rst>
     Visualization Techniques <visualization.rst>
     XML Bindings <bindings.rst>
-    Meeting and Getting Help <discussion.rst>
     License <license.rst>
     Authors <authors.rst>
 
@@ -95,6 +94,9 @@ to run your first simulation! *Note: A VTK error indicates that the "VNC (Deskto
     D. Furse et al. (2017) New J. Phys. 19 053012: “Kassiopeia: A Modern, Extensible C++ Particle Tracking Package” (doi:10.1088/1367-2630/aa6950)
 
 
+In addition to this user guide, *Kassiopeia* and its associated libraries have been documented extensively in several
+PhD theses. Many of these can be found under the list of KATRIN publications_.
+
 **Docker images**
 --------------
 
@@ -107,6 +109,6 @@ The `kassiopeia/full` image comes with a JupyterLab installation, can run on Kub
 
 .. |More information| replace:: **More information**
 .. _More information: https://github.com/KATRIN-Experiment/Kassiopeia/blob/main/Docker/README.md
-
+.. _publications: https://www.katrin.kit.edu/375.php
 
 
diff --git a/README.md b/README.md
@@ -50,4 +50,15 @@ Kassiopeia includes the following open-source libraries:
 * stl_reader (https://github.com/sreiter/stl_reader)
 
 
+Contact
+-----------------------
+
+*  Kasper development list: katrin-kasper@lists.kit.edu
+*  Richard Salomon: richardsalomon@uni-muenster.de
+*  Benedikt Bieringer: benedikt.b@uni-muenster.de
+
+
+
+
+