-
Notifications
You must be signed in to change notification settings - Fork 4
/
index.rst
61 lines (42 loc) · 1.62 KB
/
index.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
legend-daq2lh5
==============
Getting started
---------------
*legend-daq2lh5* is published on the `Python Package Index
<https://pypi.org/project/legend-daq2lh5>`_. Install on local systems with `pip
<https://pip.pypa.io/en/stable/getting-started>`_:
.. tab:: Stable release
.. code-block:: console
$ pip install legend-daq2lh5
.. tab:: Unstable (``main`` branch)
.. code-block:: console
$ pip install legend-daq2lh5@git+https://github.com/legend-exp/legend-daq2lh5@main
.. tab:: Linux Containers
Get a LEGEND container with *legend-daq2lh5* pre-installed on `Docker hub
<https://hub.docker.com/r/legendexp/legend-software>`_ or follow
instructions on the `LEGEND wiki
<https://legend-exp.atlassian.net/l/cp/nF1ww5KH>`_.
.. attention::
If installing in a user directory (typically when invoking pip as a normal
user), make sure ``~/.local/bin`` is appended to ``PATH``. The ``legend-daq2lh5``
executable is installed there.
Next steps
----------
.. toctree::
:maxdepth: 1
manuals/index
Package API reference <api/modules>
.. toctree::
:maxdepth: 1
:caption: Related projects
LEGEND Data Objects <https://legend-pydataobj.readthedocs.io>
Digital Signal Processing <https://dspeed.readthedocs.io>
pygama <https://pygama.readthedocs.io>
.. toctree::
:maxdepth: 1
:caption: Development
Source Code <https://github.com/legend-exp/legend-daq2lh5>
License <https://github.com/legend-exp/legend-daq2lh5/blob/main/LICENSE>
Citation <https://doi.org/10.5281/zenodo.10721223>
Changelog <https://github.com/legend-exp/legend-daq2lh5/releases>
developer