Update HISTORY.md and docs

AxFoundation · Oct 9, 2018 · 0637022 · 0637022
1 parent e428bda
commit 0637022
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 22 deletions.
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,4 +1,12 @@
 
+0.6.0 / 2018-10-09
+------------------
+- strax / straxen split (#107)
+- Support incomplete data loading (#99)
+- Fix for loading data made by ParallelSourcePlugin (#104)
+- Runs DB frontend (#100) (moved to straxen)
+- Fix MANIFEST.in
+
 0.5.0 / 2018-09-02
 ------------------
 - Directory name delimiter changed from `_` to `-` (#76)

diff --git a/docs/source/basics/setup.rst b/docs/source/basics/setup.rst
@@ -1,29 +1,17 @@
 Setting up strax
 ================
 
-Installation
-------------
 To install the latest stable version (from pypi), run `pip install strax`.
 Dependencies should install automatically:
 numpy, pandas, numba, two compression libraries (blosc and zstd)
-and a few miscellaneous pure-python packages.
+and a few miscellaneous pure-python packages. Strax requires python >= 3.6.
 
-If you also want to run tests with XENON1T data, run ``pip install strax[xenon]``.
-This will also install keras and tensorflow, which are needed for the XENON1T neural net.
-You might want to install these via conda rather than pip, but it's up to you.
+If you want to try out strax on XENON1T data, you're probably better off installing strax's XENON bindings at `<https://github.com/XENONnT/straxen>`_. Strax will be automatically installed along with straxen.
+
+You might want to install some dependencies (such as numpy and numba) via conda rather than pip, but it's up to you.
 
 You can also clone the repository, then setup a developer installation with `python setup.py develop`.
 
 If you experience problems during installation, try installing
 exactly the same version of the dependencies as used on the Travis build test server.
 Clone the repository, then do `pip install -r requirements.txt`.
-
-Downloading test data
-----------------------
-The provided demonstration notebooks require test data that is not included in the repository. Eventually we will provide simulated data for this purpose.
-
-For now, only XENON collaboration members can find test data at:
-   * `Processed only <https://xe1t-wiki.lngs.infn.it/lib/exe/fetch.php?media=xenon:xenon1t:aalbers:processed.zip>`_ (for strax demo notebook)
-   * Raw (for fake_daq.py and eb.py) at midway: `/scratch/midway2/aalbers/test_input_data.zip`
-
-To use these, unzip them in the same directory as the notebooks. The 'processed' zipfile will just make one directory with a single zipfile inside.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -12,15 +12,13 @@ and does not require a preprocessing stage ('eventbuilder').
 It achieves this due to using `numpy <https://docs.scipy.org/doc/numpy/>`_ `structured arrays <https://docs.scipy.org/doc/numpy/user/basics.rec.html>`_ internally,
 which are supported by the amazing just-in-time compiler `numba <http://numba.pydata.org/>`_.
 
-Strax is initially developed for the XENONnT experiment. However, the configuration
-and specific algorithms for XENONnT will eventually be hosted separately.
+Strax is primarily developed for the XENONnT experiment, although the configuration and specific algorithms for XENONnT are hosted at `<https://github.com/XENONnT/straxen>`_. You can find its documentation at `straxen <https://strax.readthedocs.io/en/latest/?badge=latest>`_.
 
-Besides the documentation below, you might find these presentations useful:
+You might also 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

diff --git a/setup.py b/setup.py
@@ -13,9 +13,8 @@
 
 setuptools.setup(name='strax',
                  version='0.5.0',
-                 description='Streaming analysis for XENON',
+                 description='Streaming analysis for xenon TPCs',
                  author='Jelle Aalbers',
-                 author_email='j.aalbers@uva.nl',
                  url='https://github.com/AxFoundation/strax',
                  setup_requires=['pytest-runner'],
                  install_requires=requires,