removed PDF version of Documentation

.gitlab-ci.yml

@@ -114,13 +114,9 @@ compile_pdf:
     - mkdir documentation
     - cd docs
     - make html
-    - make latex
-    - make latexpdf
-    - mv _build/latex/doc.pdf ../../doc.pdf
     - cp -r _build/html/ ../../documentation/
   artifacts:
     paths:
-    - doc.pdf
     - documentation
   only:
     - master

README.md

-# gums1-rejection-sampler
+# License
 
-This project contains the implementation and examples of the publication `MM/GW, CE, "A rejection Sampler extending GUM-S1", Metrologia, 2021` [TODO].
+ copyright Manuel Marschall (PTB) 2021
+
+ This software is licensed under the BSD-like license:
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+ 2. Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the distribution.
+
+# DISCLAIMER
+
+ This software was developed at Physikalisch-Technische Bundesanstalt
+ (PTB). The software is made available "as is" free of cost. PTB assumes
+ no responsibility whatsoever for its use by other parties, and makes no
+ guarantees, expressed or implied, about its quality, reliability, safety,
+ suitability or any other characteristic. In no event will PTB be liable
+ for any direct, indirect or consequential damage arising in connection
+
+# A Rejection sampler extending GUM-S1 uncertainty evaluation
+
+This project contains the implementation and examples of the publication `MM/GW, CE, "A rejection Sampler extending GUM-S1", Metrologia, 2021` [TODO]
+
+The general aim is to provide a simple to implement sampling scheme that potentially extends the GUM-S1 uncertainty evaluation to allow for informative prior incorporation regarding the measurand and variance of the data.
 
 ---
 
@@ -12,4 +38,19 @@ The library is written and tested using the following Python packages and versio
 - numpy == 1.20.2
 - scipy == 1.6.2
 - matplotlib == 3.3.4
-- emcee == 3.1.0
+- emcee == 3.1.0
\ No newline at end of file
+
+For the examples under `code/Notebooks` a Jupyter Notebook environment is required.
+
+# Contact and troubleshooting
+
+For direct contact, please write a quick mail to `manuel.marschall@ptb.de`.
+Alternatively, for problems regarding the code, its functionality oder bug-reports, please create an issue. 
+
+## Documentation
+
+A a compiled html directory of the documentation can be downloaded here: 
+
+https://gitlab1.ptb.de/marsch02/mcutility/-/jobs/5801/artifacts/download?file_type=archive
+
+Alternatively, a html version of the documentation can be built from source.
\ No newline at end of file

code/docs/conf.py

@@ -93,7 +93,7 @@ latex_elements = {
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ("index", "doc.tex", u"RejectionSampling", author, "manual"),
+  ("index", "doc.tex", u"Rejection Sampling extension to GUM-S1", author, "manual"),
 ]
 
 #Sphinx does not autodocument class __init__ methods, by default.  I tried