Merge branch 'doc/CommonSpace' into 'master'

Describe common place for test data

See merge request detectors/pycalibration!39

docs/source/conf.py

@@ -438,7 +438,7 @@ with open("available_notebooks.rst", "w") as f:
             f.write("\n\n")
 
 # add test results
-test_artifact_dir = os.path.realpath("../../tests/artifacts")
+test_artefact_dir = os.path.realpath("../../tests/artefacts")
 
 from datetime import datetime
 from dateutil.parser import parse
@@ -559,7 +559,7 @@ def sorted_dir(folder):
 
 header = """
 Test Results
-************
+++++++++++++
 
 Results are organized by git commit, and sorted descending by date.
 
@@ -575,7 +575,7 @@ if not os.path.exists("./test_rsts"):
     
 with open("test_results.rst", "w") as f:
     f.write(header)
-    for commit, modtime in sorted_dir(test_artifact_dir):
+    for commit, modtime in sorted_dir(test_artefact_dir):
         with open("./test_rsts/{}.rst".format(commit), "w") as fr:
             rst = [".. include:: roles.rst"]
             rst += [""]
@@ -585,7 +585,7 @@ with open("test_results.rst", "w") as f:
             fr.write("\n".join(rst))
             
             # copy reports
-            pdfs = glob.glob("{}/{}/*/*.pdf".format(test_artifact_dir, commit))
+            pdfs = glob.glob("{}/{}/*/*.pdf".format(test_artefact_dir, commit))
             if not os.path.exists("./_static/reports/{}".format(commit)):
                 os.makedirs("./_static/reports/{}".format(commit))
             reports = {}
@@ -598,7 +598,7 @@ with open("test_results.rst", "w") as f:
                 rlist.append((rname, "../_static/reports/{}".format(ppath)))
                 reports[rloc] = rlist
             
-            xmls = glob.glob("{}/{}/*/TEST*.xml".format(test_artifact_dir, commit))
+            xmls = glob.glob("{}/{}/*/TEST*.xml".format(test_artefact_dir, commit))
             for xml in xmls:
                 rloc = xml.split("/")[-2]
                 with open(xml, "r") as xf:
@@ -608,4 +608,4 @@ with open("test_results.rst", "w") as f:
             f.write("   test_rsts/{}\n".format(commit))
 
 def setup(app):
-    app.add_stylesheet('css/test_decorators.css')
+    app.add_stylesheet('css/test_decorators.css')
\ No newline at end of file

docs/source/index.rst

@@ -20,13 +20,3 @@ Contents:
    tutorial
    _notebooks/index
    testing
-   test_results
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-

docs/source/testing.rst

-Testing
-*******
+Reproducibility
+***************
 
 The `test` directory contains tests which can ensure that updates to
 notebooks and libraries do not result in unintended changes to
@@ -98,3 +98,20 @@ directory.
     `test_rsts subfolder` of this documentation. Also, do not commit
     `test_results.rst`. It is autogenerated.
 
+Test Data
++++++++++
+
+In order to perform described test a detector data as well as calibration constants are required. Detector data for use in testing as well as calibration constants can be found in::
+
+    /gpfs/exfel/exp/XMPL/201750/p700001/raw/
+
+Tests should be configured to output into a common location::
+
+    /gpfs/exfel/exp/XMPL/201750/p700001/scratch/
+
+Repositories of calibration constants used in testing can be found at::
+
+    /gpfs/exfel/exp/XMPL/201750/p700001/usr
+
+.. include:: test_results.rst
+