Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split XENON-specific algorithms to straxen #107

Merged
merged 9 commits into from
Oct 9, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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&utm_medium=referral&utm_content=AxFoundation/strax&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).
1 change: 0 additions & 1 deletion docs/source/basics/tutorial.ipynb

This file was deleted.

162 changes: 0 additions & 162 deletions docs/source/build_datastructure_doc.py

This file was deleted.

10 changes: 0 additions & 10 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()
8 changes: 1 addition & 7 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -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
======
Expand All @@ -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
Expand All @@ -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`
Expand Down
1 change: 0 additions & 1 deletion docs/source/reference/strax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Subpackages

strax.processing
strax.storage
strax.xenon

Submodules
----------
Expand Down
54 changes: 0 additions & 54 deletions docs/source/reference/strax.xenon.rst

This file was deleted.