Merge pull request #107 from JelleAalbers/delete_xenon

Split XENON-specific algorithms to straxen
AxFoundation · Oct 9, 2018 · 919d988 · 919d988
2 parents f06793b + 904a145
commit 919d988
Show file tree

Hide file tree

Showing 33 changed files with 204 additions and 4,670 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ Streaming analysis for xenon experiments
 [![Join the chat at https://gitter.im/AxFoundation/strax](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/AxFoundation/strax?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/cc159474f2764d43b445d562a24ca245)](https://www.codacy.com/app/tunnell/strax?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=AxFoundation/strax&amp;utm_campaign=Badge_Grade)
 
-Strax is an analysis framework for pulse-only digitization data, specialized for live data reduction at speeds of 50-100 MB(raw) / core / sec. 
-It's primary aim is to support noble liquid TPC dark matter searches, such as XENONnT.
+Strax is an analysis framework for pulse-only digitization data, specialized for live data reduction at speeds of 50-100 MB(raw) / core / sec. For more information, please see the [strax documentation](https://strax.readthedocs.io).
+
+Strax' primary aim is to support noble liquid TPC dark matter searches, such as XENONnT. The XENON-specific algorithms live in the separate package [straxen](https://github.com/XENONnT/straxen). If you want to try out strax, you probably want to start there. This package only contains the core framework and basic algorithms any TPCs would want to use.
 
-For more information, please see the [strax documentation](https://strax.readthedocs.io).
diff --git a/docs/source/basics/tutorial.ipynb b/docs/source/basics/tutorial.ipynb
diff --git a/docs/source/build_datastructure_doc.py b/docs/source/build_datastructure_doc.py
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -297,13 +297,3 @@
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'https://docs.python.org/': None}
 
-
-def setup(app):
-    # Hack to import something from this dir. Apparently we're in a weird
-    # situation where you get a __name__  is not in globals KeyError
-    # if you just try to do a relative import...
-    import os
-    import sys
-    sys.path.append(os.path.dirname(os.path.realpath(__file__)))
-    import build_datastructure_doc
-    build_datastructure_doc.build_datastructure_doc()
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,8 +1,3 @@
-.. strax documentation master file, created by
-   sphinx-quickstart on Sat May  5 22:35:12 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 ======
 Strax
 ======
@@ -25,13 +20,13 @@ Besides the documentation below, you might find these presentations useful:
 * `Talk on strax at the first XENONnT software telecon (May 2018) <https://docs.google.com/presentation/d/1khf-RNp6K-Q3TW1nQr5xUdrCUPGTJ8lDlDxnAh3s__U>`_
 * `Talk on strax for DAQ experts (May 2018) <https://docs.google.com/presentation/d/1qZmbAKJmzn7iTbBbkzhTvHmiBqdbYyxhgheRRrDhTeY>`_
 
+Please also see the documentation of `straxen <https://strax.readthedocs.io/en/latest/?badge=latest>`_, the package containing the XENON-specific software built on strax.
 
 .. toctree::
     :maxdepth: 1
     :caption: Setup and basics
 
     basics/setup
-    basics/tutorial.ipynb
 
 .. toctree::
     :maxdepth: 1
@@ -57,7 +52,6 @@ The above pages describe how strax's processing framework works under the hood,
     :caption: API Reference
 
     reference/strax
-    reference/datastructure
 
 
 * :ref:`genindex`

diff --git a/docs/source/reference/strax.rst b/docs/source/reference/strax.rst
@@ -8,7 +8,6 @@ Subpackages
 
     strax.processing
     strax.storage
-    strax.xenon
 
 Submodules
 ----------

diff --git a/docs/source/reference/strax.xenon.rst b/docs/source/reference/strax.xenon.rst