reboost hpges

.github/workflows/main.yml

@@ -31,6 +31,10 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+      - name: Install non-python (homebrew) dependencies
+        if: ${{ matrix.os == 'macOS-latest' }}
+        run: |
+          brew install opencascade cgal gmp mpfr boost
       - name: Get dependencies and install reboost
         run: |
           python -m pip install --upgrade pip wheel setuptools

.pre-commit-config.yaml

@@ -57,6 +57,17 @@ repos:
         additional_dependencies:
           - pytest
 
+  - repo: https://github.com/kynan/nbstripout
+    rev: "0.7.1"
+    hooks:
+      - id: nbstripout
+        args:
+          [
+            "--drop-empty-cells",
+            "--extra-keys",
+            "metadata.kernelspec metadata.language_info",
+          ]
+
   - repo: https://github.com/codespell-project/codespell
     rev: "v2.3.0"
     hooks:

docs/source/conf.py

@@ -22,12 +22,13 @@
     "myst_parser",
 ]
 
+
 source_suffix = {
     ".rst": "restructuredtext",
     ".md": "markdown",
 }
 master_doc = "index"
-language = "python"
+# language = "python"
 
 # Furo theme
 html_theme = "furo"
@@ -53,8 +54,17 @@
     "scipy": ("http://docs.scipy.org/doc/scipy/reference", None),
     "pandas": ("https://pandas.pydata.org/docs", None),
     "matplotlib": ("http://matplotlib.org/stable", None),
+    "pygama": ("https://pygama.readthedocs.io/en/stable/", None),
+    "legendhpges": ("https://legend-pygeom-hpges.readthedocs.io/en/latest/", None),
 }  # add new intersphinx mappings here
 
+
+suppress_warnings = [
+    # "histogram" is defined both in pygama.dsp.processors.histogram.histogram
+    # and in pygama.math.histogram, leading to a Sphinx cross-referencing
+    # warning.  I don't know how to fix this properly
+    "ref.python",
+]
 # sphinx-autodoc
 # Include __init__() docstring in class docstring
 autoclass_content = "both"

docs/source/index.rst

@@ -1,10 +1,54 @@
 Welcome to reboost's documentation!
 ==========================================
 
-Table of Contents
------------------
+*reboost* is a python package for the post-processing of `remage <https://remage.readthedocs.io/en/stable/>`_ monte-carlo Simulations.
+
+Getting started
+---------------
+
+*reboost* can be installed with *pip*:
+
+.. code-block:: console
+
+   $ git clone [email protected]:legend-exp/reboost.git
+   $ cd reboost
+   $ pip install .
+
+*reboost* is currently divided into two programs:
+ - *reboost-optical* for processing optical simulations,
+ - *reboost-hpge* for processing HPGe detector simulations.
+
+Both can be run on the command line with:
+
+.. code-block:: console
+
+   $ reboost-optical -h
+   $ reboost-hpge -h
+
+Next steps
+----------
+
+.. toctree::
+   :maxdepth: 2
+
+   User Manual <manual/index>
+
+.. toctree::
+   :maxdepth: 1
+
+   tutorial
 
 .. toctree::
    :maxdepth: 1
 
    Package API reference <api/modules>
+
+
+See also
+--------
+ - `remage <https://remage.readthedocs.io/en/stable/>`_: Modern *Geant4* application for HPGe and LAr experiments,
+ - `legend-pygeom-hpges <https://legend-pygeom-hpges.readthedocs.io/en/latest/>`_: Package for handling HPGe detector geometry in python,
+ - `pyg4ometry <https://pyg4ometry.readthedocs.io/en/stable/>`_: Package to create simulation geometry in python,
+ - `legend-pygeom-optics <https://legend-pygeom-optics.readthedocs.io/en/stable/>`_: Package to handle optical properties in python,
+ - `legend-pygeom-l200 <https://github.com/legend-exp/legend-pygeom-l200>`_: Implementation of the LEGEND-200 experiment (**private**),
+ - `pyvertexgen <https://github.com/tdixon97/pyvertexgen/>`_: Generation of vertices for simulations.