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

Add detsim city documentation #18

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add detsim city documentation #18

wants to merge 2 commits into from

Conversation

gondiaz
Copy link

@gondiaz gondiaz commented Jan 26, 2023

Documentation for detsim city

@gonzaponte
Copy link
Contributor

The link to the online version is missing.
https://github.com/next-exp/sw-docs/wiki#contribute-with-your-documentation

@gondiaz
Copy link
Author

gondiaz commented Jan 26, 2023

@gonzaponte
Copy link
Contributor

Let us know when it's ready for review.

@gondiaz
Copy link
Author

gondiaz commented Jan 31, 2023

Ready to review

Copy link
Collaborator

@halmamol halmamol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice first draft. Some structural comments to make the documentation match the guidelines.

**Detsim**, from **Detector Simulation**, is a the city that simulates the *detector response* for *fast-simulated* events.
A *fast-simulated* event consist of a collection of hits of position and energy desposition in the gaseous volume (right figure below). The *detector response* are the signals measured in the light-sensors in the form of time ordered waveforms (left figure below).

We can differenciate two simulation modes implemented in NEXUS: the
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the information related to fast/full simulations is on the nexus wiki. It can just be mentioned it here, adding a link to the wiki.

.. container::
:name: tab:detsim-parameters

.. table:: List of **detsim** parameters used at each stage of the algorithm.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add all the parameters used in detsim following the guidelines from the other cities, https://pr18-sw-docs.readthedocs.io/en/latest/irene.html#config. Including the parameter name that will be used in the config, plus the type of variable.


The city flow parts are shown in the diagram

.. image:: images/detsim/workflow.png
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add on top or below the diagram a list with the algorithms/parts that you describe below. Use :ref: to they can be linked below. You can check this to see how it is done: https://pr18-sw-docs.readthedocs.io/en/latest/irene.html#workflow

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also add a brief description here of the whole city and the connection between the different steps.

@gonzaponte
Copy link
Contributor

I've been asked where to find the LTs and PFF files for detsim. We should list them here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants