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.

Sign up for GitHub

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

Jump to bottom

add some more information to docs (DOI, Github links) #116

Merged
merged 1 commit into from
Aug 15, 2024
Merged

add some more information to docs (DOI, Github links) #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Simulation framework for germanium detector experiments
![GitHub pull requests](https://img.shields.io/github/issues-pr/legend-exp/remage?logo=github)
![License](https://img.shields.io/github/license/legend-exp/remage)
[![Read the Docs](https://img.shields.io/readthedocs/remage?logo=readthedocs)](https://remage.readthedocs.io)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11115662.svg)](https://doi.org/10.5281/zenodo.11115662)

<br/>

Expand Down
14 changes: 14 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Optional dependencies

- |root|_ 6.06 or higher
- |bxdecay0|_ 1.0.10 or higher
- |hdf5|_ C++ support for LH5 object persistency

.. note::

Expand Down Expand Up @@ -86,6 +87,9 @@ through the ``remage`` executable:
-o,--output-file FILE Output file for detector hits


Macro files can use all available upstream Geant4 macro commands, as well as the
:doc:`remage macro interface <rmg-commands>`.

Advanced applications can extend |remage| and link against ``libremage`` with the
usual CMake syntax:

Expand All @@ -105,8 +109,16 @@ Next steps

Geant4 command interface <rmg-commands>
Output structure & LH5 output <output>

.. toctree::
:maxdepth: 1
:caption: Development

api/index
Good ol' Doxygen <https://remage.readthedocs.io/en/latest/doxygen/annotated.html>
Source Code <https://github.com/legend-exp/remage>
License <https://github.com/legend-exp/remage/blob/main/LICENSE>
Citation <https://doi.org/10.5281/zenodo.11115662>

.. |remage| replace:: *remage*
.. |geant4| replace:: Geant4
Expand All @@ -115,3 +127,5 @@ Next steps
.. _root: https://root.cern.ch
.. |bxdecay0| replace:: BxDecay0
.. _bxdecay0: https://github.com/BxCppDev/bxdecay0
.. |hdf5| replace:: HDF5
.. _hdf5: https://www.hdfgroup.org/solutions/hdf5
Loading