From cf5c7ca1f1a5f38c9c34ecc6ddabf22956385e3a Mon Sep 17 00:00:00 2001 From: c-goen <105125661+Gon-na@users.noreply.github.com> Date: Thu, 7 Dec 2023 14:01:46 +0100 Subject: [PATCH 1/7] compiling.rst: change in title name --- Documentation/gh-pages/source/compiling.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/gh-pages/source/compiling.rst b/Documentation/gh-pages/source/compiling.rst index 68a56f2e9..91c9fa9bd 100644 --- a/Documentation/gh-pages/source/compiling.rst +++ b/Documentation/gh-pages/source/compiling.rst @@ -1,4 +1,4 @@ -Getting starting with Kassiopiea +Getting started with Kassiopiea ********************************** .. contents:: On this page From 9d899639ecaf22b5388050020f94e024a1b1b1be Mon Sep 17 00:00:00 2001 From: c-goen <105125661+Gon-na@users.noreply.github.com> Date: Thu, 14 Dec 2023 12:18:35 +0100 Subject: [PATCH 2/7] Documentation: Add section for discussion & help This adds the Discussion & Getting Help section from the README to the documentation --- Documentation/gh-pages/source/discussion.rst | 25 ++++++++++++++++++++ Documentation/gh-pages/source/index.rst | 1 + 2 files changed, 26 insertions(+) create mode 100644 Documentation/gh-pages/source/discussion.rst diff --git a/Documentation/gh-pages/source/discussion.rst b/Documentation/gh-pages/source/discussion.rst new file mode 100644 index 000000000..ec14728f4 --- /dev/null +++ b/Documentation/gh-pages/source/discussion.rst @@ -0,0 +1,25 @@ + +Discussion & Getting Help +************************* + +Join the Kassiopeia community on Gitter: https://gitter.im/kassiopeia-simulation/community + +You can `contribute changes `_, `report issues `_ and `join discussions `_ on Github. + +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. +It does not matter whether you are already an expert or a complete beginner. **Everyone is welcome!** + +The meeting is announced via email. +Please register for the `mailing list `_ 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 diff --git a/Documentation/gh-pages/source/index.rst b/Documentation/gh-pages/source/index.rst index b6a2dc17a..062021d4b 100644 --- a/Documentation/gh-pages/source/index.rst +++ b/Documentation/gh-pages/source/index.rst @@ -51,6 +51,7 @@ Welcome to Kassiopeia's documentation! Additional Simulation Tools Visualization Techniques XML Bindings + Discussion and Getting Help License Authors From 2857a5bca2553757f764613e6c39c6256e68dacc Mon Sep 17 00:00:00 2001 From: c-goen <105125661+Gon-na@users.noreply.github.com> Date: Thu, 16 Nov 2023 16:26:28 +0100 Subject: [PATCH 3/7] Documentation: README.md shortened & small change to getting help page This shortens the README.md, replacing most contents with links to the GH documentation. Small meeting and getting help fix --- Documentation/gh-pages/source/discussion.rst | 2 +- Documentation/gh-pages/source/index.rst | 2 +- README.md | 184 +------------------ 3 files changed, 11 insertions(+), 177 deletions(-) diff --git a/Documentation/gh-pages/source/discussion.rst b/Documentation/gh-pages/source/discussion.rst index ec14728f4..7039aaac2 100644 --- a/Documentation/gh-pages/source/discussion.rst +++ b/Documentation/gh-pages/source/discussion.rst @@ -1,5 +1,5 @@ -Discussion & Getting Help +Meeting and Getting Help ************************* Join the Kassiopeia community on Gitter: https://gitter.im/kassiopeia-simulation/community diff --git a/Documentation/gh-pages/source/index.rst b/Documentation/gh-pages/source/index.rst index 062021d4b..26c8457b4 100644 --- a/Documentation/gh-pages/source/index.rst +++ b/Documentation/gh-pages/source/index.rst @@ -51,7 +51,7 @@ Welcome to Kassiopeia's documentation! Additional Simulation Tools Visualization Techniques XML Bindings - Discussion and Getting Help + Meeting and Getting Help License Authors diff --git a/README.md b/README.md index a1bc6312d..ccea84df6 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,6 @@ This simulation package by [the KATRIN collaboration](https://katrin.kit.edu) allows to run highly customizable particle tracking simulations along with calculations of electric and magnetic fields. -**Full user guide:** http://katrin-experiment.github.io/Kassiopeia/index.html - **Quick start:** [**Try it out online**](https://mybinder.org/v2/gh/KATRIN-Experiment/KassiopeiaBinder/HEAD) in an interactive Binder session. Open a "VNC (Desktop)" tab and a terminal tab and run @@ -31,159 +29,15 @@ 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) ``` - 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:** [Docker README](Docker/README.md) - - System requirements: ----------------------- - -NOTE: Kasper requires Linux/MacOS. Windows+cygwin should work too, but has not been tested. - -Some dependencies are only required if certain module are compiled in. - -Dependencies: -* CMake (https://www.cmake.org) version 3.14 or higher -* G++ (https://gcc.gnu.org) version 6.1 or higher (if compiling with GCC) -* Clang++ (https://clang.llvm.org) version 3.4 or higher (if compiling with clang) -* Boost (https://www.boost.org) version 1.65 or higher -* GSL (https://www.gnu.org/software/gsl) -* ROOT (https://www.cern.ch/root) version 6.16 or higher - + --enable-minuit2 (if you want to use KaFit) - + --enable-fftw3 (if you want to use KEMField) - -Optional Dependencies: -* FFTW (https://fftw.org) version 3.3.4 or higher -* HDF5 (https://support.hdfgroup.org/HDF5/) -* Log4CXX (https://logging.apache.org/log4cxx) -* MPI (https://www.open-mpi.org or mpich.org) -* OpenCL (https://www.khronos.org/opencl), installation details depend on your system -* PETSc (https://mcs.anl.gov/petsc) -* VTK (https://www.vtk.org) version 6.1 or higher -* pdflatex (for making the documentation; minimum version not known) -* doxygen (for making the documentation; minimum version not known) - -### Ubuntu Linux 18.04 LTS (bionic) - -* Make sure to update CMake to version 3.13 or newer. See www.cmake.org or use this - [direct link](https://github.com/Kitware/CMake/releases/download/v3.13.4/cmake-3.13.4-Linux-x86_64.tar.gz). -* Download ROOT libraries from cern.root.ch or use this - [direct link](https://root.cern/download/root_v6.18.04.Linux-ubuntu18-x86_64-gcc7.4.tar.gz). - Another option is to build your own version from the source files. -* To install all build dependencies: - ``` - > apt-get update -y && apt-get install -y \ - build-essential cmake cmake-curses-gui \ - libqt4-dev libx11-dev libxext-dev libxft-dev libxpm-dev \ - libboost-all-dev libfftw3-dev libgsl0-dev libhdf5-dev liblog4cxx-dev libomp-dev libopenmpi-dev \ - libpcl-dev libsqlite3-dev libssl-dev libvtk6-dev libxml2-dev ocl-icd-opencl-dev zlib1g-dev - ``` - -### Fedora Linux 31 - -* The ROOT libraries can be installed easily with the package manager. -* To install all build dependencies: - ``` - > dnf install -y \ - @development-tools cmake cmake-gui \ - root-core root-io-xmlparser root-minuit2 root-spectrum \ - vtk vtk-qt vtk-java \ - boost-devel fftw-devel gsl-devel hdf5-devel libomp-devel libxml2-devel log4cxx-devel \ - ocl-icd-devel openmpi-devel openssl-devel pcl-devel sqlite-devel vtk-devel zlib-devel - ``` - - Installation --------------- - -1. Make a separate directory for the build tree, and enter that directory: - ``` - > mkdir build - > cd build - ``` - - * Consider setting important environmental variables now. - Selecting a specific compiler to be configured by CMake is done for example by - ``` - > export CXX=clang++ - > export CC=clang - ``` - to use the Clang/LLVM compiler, or - ``` - > export CXX=g++ - > export CC=gcc - ``` - to use the GNU compiler (GCC). - -2. Run cmake (or ccmake, or cmake-gui, if you prefer): - ``` - > cmake .. - > ccmake .. - ``` - - * If applicable, make any changes you need to the configuration, and - (re)generate the makefiles. e.g. You may want to change the install - prefix. (NOTE: Most users will probably want to do this.) - - The default is `/install`. If you're not doing - a general install for your system, or if you just want to use a - different location, you should change `CMAKE_INSTALL_PREFIX` to - your desired location. Also note the `CMAKE_BUILD_TYPE`. If you - do not plan to debug Kasper applications, 'Release' will give you - the best execution performance. - - If you use one of the GUI variants (ccmake or cmake-gui), you can - just go through a list of all the available build options. Most - options also have a short description. Note that some variables - have dependencies (e.g. `BUILD_KASSIOPEIA` will also enable - `BUILD_KEMFIELD`). - -3. Then type - ``` - > make - ``` - to start the build process. This can take some time, depending on the - modules you activated in CMake. If you have more than one CPU core on - your system, you can build several files in parallel: - ``` - > make -j2 - ``` - Make sure to keep the number passed to 'make' smaller than the number - of actual CPU cores. Instead of 'make' you could also use 'ninja' - or any other build tool that works with CMake. - -4. Install the executables and libraries with - ``` - > make install - ``` - Executables are installed in the `bin/` directory, and libraries are - installed in the `lib/` directory (or `lib64/` on some systems.) - -5. Include `kasperenv.sh` in your `~/.bashrc` (or similar, depending on - your shell) with - ``` - > source /path/to/Kasper/install/bin/kasperenv.sh - ``` - This script adds the `bin/` directory to your `$PATH` so you can call - any Kasper executables directly from the commandline. Furthermore this - sets the `$KASPERSYS` environment variable to the install directory. - - - Documentation ---------------- - -1. Documentation distributed with Kasper - 1. This `README.md` file - 2. The Kassiopeia documentation is an HTML page hosted on GitHub - that will guide you through the installation process and - explains how to get started with your first simulation: - http://katrin-experiment.github.io/Kassiopeia/index.html - - Open Source +**[Documentation](http://katrin-experiment.github.io/Kassiopeia/index.html)** +============================================================================================= + +* **[System requirements & installation](https://katrin-experiment.github.io/Kassiopeia/compiling.html)** +* **[Docker images](https://github.com/orgs/KATRIN-Experiment/packages), [more information](Docker/README.md)** +* **[Meeting & Getting help](https://katrin-experiment.github.io/Kassiopeia/discussion.html)** + + +Open source ------------- This software is distributed "as-is" under an open source license @@ -196,24 +50,4 @@ Kassiopeia includes the following open-source libraries: * stl_reader (https://github.com/sreiter/stl_reader) - Getting help --------------- - -Join the Kassiopeia community on Gitter: https://gitter.im/kassiopeia-simulation/community - -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 - -We also organize a regular meeting via Zoom. - -Kassiopeia **users as well as developers** can join, ask questions, raise issues and discuss development topics. -It does not matter whether you are already an expert or a complete beginner. **Everyone is welcome!** - -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 From 1d3f3b97df3e4b9376c2ad3b16b7f644b26ddb07 Mon Sep 17 00:00:00 2001 From: c-goen <105125661+Gon-na@users.noreply.github.com> Date: Tue, 19 Dec 2023 18:07:39 +0100 Subject: [PATCH 4/7] 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 --- .../source/{discussion.rst => contact.rst} | 41 ++++++++++++++----- .../source/external_documentation.rst | 29 ------------- Documentation/gh-pages/source/index.rst | 10 +++-- README.md | 11 +++++ 4 files changed, 48 insertions(+), 43 deletions(-) rename Documentation/gh-pages/source/{discussion.rst => contact.rst} (50%) delete mode 100644 Documentation/gh-pages/source/external_documentation.rst diff --git a/Documentation/gh-pages/source/discussion.rst b/Documentation/gh-pages/source/contact.rst similarity index 50% rename from Documentation/gh-pages/source/discussion.rst rename to Documentation/gh-pages/source/contact.rst index 7039aaac2..8417f0834 100644 --- a/Documentation/gh-pages/source/discussion.rst +++ b/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 `_, `report issues `_ and `join discussions `_ on Github. -Regular Meeting -=============== +Join the Kassiopeia community on `Gitter `_. + +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 `_ 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 \ No newline at end of file diff --git a/Documentation/gh-pages/source/external_documentation.rst b/Documentation/gh-pages/source/external_documentation.rst deleted file mode 100644 index abbb22fa3..000000000 --- a/Documentation/gh-pages/source/external_documentation.rst +++ /dev/null @@ -1,29 +0,0 @@ -References, Citation and Contact -******************************** - -.. contents:: On this page - :local: - :depth: 2 - -External references -=================== - -To cite the use of and/or data produced with the assistance of *Kassiopeia* or its associated libraries (*KGeoBag*, -*KEMField*, or *Kommon*). Please refer to the paper: - - 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_. - -Developer contact -================= - -To make bug reports, propose additional features and/or patches, please use the pull-request and issue tracker available -on the *Kassiopeia* GitHub repository here_. Additional unrelated inquiries may be directed towards: katrin-kasper (at) -lists (dot) kit (dot) edu. - -.. _publications: https://www.katrin.kit.edu/375.php -.. _here: https://github.com/KATRIN-Experiment/Kassiopeia diff --git a/Documentation/gh-pages/source/index.rst b/Documentation/gh-pages/source/index.rst index 26c8457b4..b9bd668ca 100644 --- 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 - References, Citation and Contact + Contact, Meeting and References + Introduction Getting Started Examples and Tests Configuring Your Own Simulation @@ -51,7 +51,6 @@ Welcome to Kassiopeia's documentation! Additional Simulation Tools Visualization Techniques XML Bindings - Meeting and Getting Help License Authors @@ -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 index ccea84df6..75f873b9a 100644 --- 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 + + + + + From 6391ffd3af37ce8d497eed555ef2c76cfa3a20e8 Mon Sep 17 00:00:00 2001 From: c-goen <105125661+Gon-na@users.noreply.github.com> Date: Wed, 10 Jan 2024 11:09:27 +0100 Subject: [PATCH 5/7] Documentation: Optain License & KEMField Manual Without Duplication This commit aims to replace the license chapter with the License.md and adds a chapter for KEMField, including the manual.pdf. To implement the changes, Sphinx-SimplePDF and m2r2 for inclusion of markdown in .rst files have been added. --- .github/workflows/github-pages.yml | 3 ++- Documentation/gh-pages/Makefile | 3 ++- Documentation/gh-pages/source/KEMField_manual_link.rst | 10 ++++++++++ Documentation/gh-pages/source/conf.py | 5 ++++- Documentation/gh-pages/source/index.rst | 5 +++-- Documentation/gh-pages/source/linktolicense.rst | 3 +++ 6 files changed, 24 insertions(+), 5 deletions(-) create mode 100644 Documentation/gh-pages/source/KEMField_manual_link.rst create mode 100644 Documentation/gh-pages/source/linktolicense.rst diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml index fc0eead39..5cb1aa8d9 100644 --- a/.github/workflows/github-pages.yml +++ b/.github/workflows/github-pages.yml @@ -11,7 +11,8 @@ jobs: - uses: actions/checkout@v3 - name: Install dependencies - run: pip install sphinx_rtd_theme sphinx_design + run: pip install sphinx_rtd_theme sphinx_design m2r2 sphinx-simplepdf + - name: Build target "build" run: cd Documentation/gh-pages && make github diff --git a/Documentation/gh-pages/Makefile b/Documentation/gh-pages/Makefile index c43c0be19..efb25f5a5 100644 --- a/Documentation/gh-pages/Makefile +++ b/Documentation/gh-pages/Makefile @@ -18,7 +18,8 @@ github: @rm -rf "$(HTMLDIR)" @mv "$(BUILDDIR)/html" "$(HTMLDIR)" @touch "$(HTMLDIR)/.nojekyll" - + @mkdir "$(HTMLDIR)/kemfield" + @cp ../../KEMField/Documentation/manual/manual.pdf "$(HTMLDIR)/kemfield" .PHONY: help github Makefile # Catch-all target: route all unknown targets to Sphinx using the new diff --git a/Documentation/gh-pages/source/KEMField_manual_link.rst b/Documentation/gh-pages/source/KEMField_manual_link.rst new file mode 100644 index 000000000..21b4ec161 --- /dev/null +++ b/Documentation/gh-pages/source/KEMField_manual_link.rst @@ -0,0 +1,10 @@ +KEMField +********** + +See :download:`KEMField manual <../../../KEMField/Documentation/manual/manual.pdf>`. + +With new pdf-include + +.. pdf-include:: ./kemfield/manual.pdf + +You can also download the manual :download:`here <../../../KEMField/Documentation/manual/manual.pdf>`. diff --git a/Documentation/gh-pages/source/conf.py b/Documentation/gh-pages/source/conf.py index 65d280f85..695709859 100644 --- a/Documentation/gh-pages/source/conf.py +++ b/Documentation/gh-pages/source/conf.py @@ -42,7 +42,10 @@ 'sphinx.ext.mathjax', 'sphinx.ext.graphviz', 'sphinx_rtd_theme', - 'sphinx_design' + 'sphinx_design', + 'm2r2', + 'sphinx_simplepdf', + ] extlinks = { diff --git a/Documentation/gh-pages/source/index.rst b/Documentation/gh-pages/source/index.rst index b9bd668ca..b806060cc 100644 --- a/Documentation/gh-pages/source/index.rst +++ b/Documentation/gh-pages/source/index.rst @@ -51,9 +51,10 @@ Welcome to Kassiopeia's documentation! Additional Simulation Tools Visualization Techniques XML Bindings - License + KEMField + License Authors - + diff --git a/Documentation/gh-pages/source/linktolicense.rst b/Documentation/gh-pages/source/linktolicense.rst new file mode 100644 index 000000000..ecbeef9cf --- /dev/null +++ b/Documentation/gh-pages/source/linktolicense.rst @@ -0,0 +1,3 @@ + +.. mdinclude:: ../../../LICENSE.md + From 4a5434b3860a07fb69e9b893d75c2e111b8b22cc Mon Sep 17 00:00:00 2001 From: c-goen <105125661+Gon-na@users.noreply.github.com> Date: Tue, 6 Feb 2024 12:34:55 +0100 Subject: [PATCH 6/7] Documentation: KEMField Documentation: KEMField Added short introduction and small changes to the presentation of the manual --- Documentation/gh-pages/source/KEMField_manual_link.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/Documentation/gh-pages/source/KEMField_manual_link.rst b/Documentation/gh-pages/source/KEMField_manual_link.rst index 21b4ec161..66faf08a2 100644 --- a/Documentation/gh-pages/source/KEMField_manual_link.rst +++ b/Documentation/gh-pages/source/KEMField_manual_link.rst @@ -1,10 +1,14 @@ KEMField ********** -See :download:`KEMField manual <../../../KEMField/Documentation/manual/manual.pdf>`. -With new pdf-include +**KEMField** is a toolkit that allows users to solve electrostatic and magnetostatic fields from user-defined inputs. +Detailed explanations on installation and implementation are available in the manual displayed below. +Alternatively the manual is available for download :download:`here <../../../KEMField/Documentation/manual/manual.pdf>` +and can also be found in the `Github repository `_. + .. pdf-include:: ./kemfield/manual.pdf + :width: 100% + :height: 800px -You can also download the manual :download:`here <../../../KEMField/Documentation/manual/manual.pdf>`. From 26129d6e2daef957c8943964af8154889737d3f5 Mon Sep 17 00:00:00 2001 From: c-goen <105125661+Gon-na@users.noreply.github.com> Date: Tue, 6 Feb 2024 16:17:01 +0100 Subject: [PATCH 7/7] Format changes in License.md for documentation These changes should allow proper presentation of the License.md using the .md parser for the sphinx documentation. Previously, the enumeration of segments failed in the .rst interpretation due to missing indentations. --- LICENSE.md | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index caa5e5c36..0fa508d81 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -7,26 +7,38 @@ All rights not expressly granted under this license are reserved. Installation, use, reproduction, display, modification and redistribution of this software, with or without modification, in source and binary forms, are permitted on a non-exclusive basis. Any exercise of rights by you under this license is subject to the following conditions: -1. Redistributions of this software, in whole or in part, with or without modification, shall reproduce the above copyright notice and these license conditions in this software, the user documentation and any other materials provided with the redistributed software. By using, copying, modifying or distributing the software (or any work based on the software) you agree to acknowledge its use in resulting scientific publications. +1. + Redistributions of this software, in whole or in part, with or without modification, shall reproduce the above copyright notice and these license conditions in this software, the user documentation and any other materials provided with the redistributed software. By using, copying, modifying or distributing the software (or any work based on the software) you agree to acknowledge its use in resulting scientific publications. -2. The user documentation, if any, included with a redistribution and derivatives, must include the following notice:: - This product includes software developed by Members of the KATRIN Collaboration ( http://www.katrin.kit.edu ) +2. + The user documentation, if any, included with a redistribution and derivatives, must include the following notice:: + + This product includes software developed by Members of the KATRIN Collaboration ( http://www.katrin.kit.edu ) + If that is where third-party acknowledgments normally appear, this acknowledgment must be reproduced in the modified version of this software itself. -If that is where third-party acknowledgments normally appear, this acknowledgment must be reproduced in the modified version of this software itself. -3. The names `KATRIN`, `Kassiopeia`, `KEMField`, and `KGeoBag` may not be used to endorse or promote software, or products derived therefrom, except with prior written permission by the Copyright Holders. If this software is redistributed in modified form, the name and reference of the modified version must be clearly distinguishable from that of this software. +3. + The names `KATRIN`, `Kassiopeia`, `KEMField`, and `KGeoBag` may not be used to endorse or promote software, or products derived therefrom, except with prior written permission by the Copyright Holders. If this software is redistributed in modified form, the name and reference of the modified version must be clearly distinguishable from that of this software. -4. You are under no obligation to provide anyone with any modifications of this software that you may develop, including but not limited to bug fixes, patches, upgrades or other enhancements or derivatives of the features, functionality or performance of this software. However, if you publish or distribute your modifications without contemporaneously requiring users to enter into a separate written license agreement, then you are deemed to have granted all of the Copyright Holders a license to your modifications, including modifications protected by any patent owned by you, under the conditions of this license. -5. You may not include this software in whole or in part in any patent or patent application in respect of any modification of this software developed by you. +4. + You are under no obligation to provide anyone with any modifications of this software that you may develop, including but not limited to bug fixes, patches, upgrades or other enhancements or derivatives of the features, functionality or performance of this software. However, if you publish or distribute your modifications without contemporaneously requiring users to enter into a separate written license agreement, then you are deemed to have granted all of the Copyright Holders a license to your modifications, including modifications protected by any patent owned by you, under the conditions of this license. + + +5. + You may not include this software in whole or in part in any patent or patent application in respect of any modification of this software developed by you. + 6. DISCLAIMER -THIS SOFTWARE IS PROVIDED BY THE MEMBERS AND COPYRIGHT HOLDERS OF KASSIOPEIA "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY, OF SATISFACTORY QUALITY, AND FITNESS FOR A PARTICULAR PURPOSE OR USE ARE DISCLAIMED. THE COPYRIGHT HOLDERS MAKE NO REPRESENTATION THAT THE SOFTWARE AND MODIFICATIONS THEREOF, WILL NOT INFRINGE ANY PATENT, COPYRIGHT, TRADE SECRET OR OTHER PROPRIETARY RIGHT. + THIS SOFTWARE IS PROVIDED BY THE MEMBERS AND COPYRIGHT HOLDERS OF KASSIOPEIA "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY, OF SATISFACTORY QUALITY, AND FITNESS FOR A PARTICULAR PURPOSE OR USE ARE DISCLAIMED. THE COPYRIGHT HOLDERS MAKE NO REPRESENTATION THAT THE SOFTWARE AND MODIFICATIONS THEREOF, WILL NOT INFRINGE ANY PATENT, COPYRIGHT, TRADE SECRET OR OTHER PROPRIETARY RIGHT. + 7. LIMITATION OF LIABILITY -THE COPYRIGHT HOLDERS SHALL HAVE NO LIABILITY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL, EXEMPLARY, OR PUNITIVE DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF USE, DATA OR PROFITS, OR BUSINESS INTERRUPTION, HOWEVER CAUSED AND ON ANY THEORY OF CONTRACT, WARRANTY, TORT (INCLUDING NEGLIGENCE), PRODUCT LIABILITY OR OTHERWISE, ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + THE COPYRIGHT HOLDERS SHALL HAVE NO LIABILITY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL, EXEMPLARY, OR PUNITIVE DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF USE, DATA OR PROFITS, OR BUSINESS INTERRUPTION, HOWEVER CAUSED AND ON ANY THEORY OF CONTRACT, WARRANTY, TORT (INCLUDING NEGLIGENCE), PRODUCT LIABILITY OR OTHERWISE, ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + -8. This license shall terminate with immediate effect and without notice if you fail to comply with any of the terms of this license, or if you institute litigation against any Copyright Holders or Members of the KATRIN Collaboration with regard to this software. +8. + This license shall terminate with immediate effect and without notice if you fail to comply with any of the terms of this license, or if you institute litigation against any Copyright Holders or Members of the KATRIN Collaboration with regard to this software.