You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/developing/Contributing-to-ldmx-sw.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ If you don't already have SSH keys configured, look at the [GitHub directions](h
16
16
17
17
We prefer that any code contributions are submitted via [pull requests](https://help.github.com/articles/creating-a-pull-request/) so that they can be reviewed before changes are merged into the master.
18
18
19
-
Before you start, an [issue should be added to the ldmx-sw issue tracker](https://github.com/LDMXAnalysis/ldmx-sw/issues/new).
19
+
Before you start, an [issue should be added to the ldmx-sw issue tracker](https://github.com/LDMX-Software/ldmx-sw/issues/new).
20
20
21
21
### Branch Name Convention
22
22
Then you should make a local branch from `trunk` using a command like `git checkout -b iss1234-short-desc` where _1234_ is the issue number from the issue tracker and `short-desc` is a short description (using `-` as spaces) of what the branch is working one.
@@ -29,7 +29,7 @@ If you plan on starting a major (sub)project within the repository like adding a
29
29
30
30
### Coding rules and conventions
31
31
32
-
Please read the [Coding rules](developing/coding-rules.md)
32
+
Please read the [Coding rules](coding-rules.md)
33
33
34
34
### After Opening a PR
35
35
After opening a PR, several different tests are run using [our GitHub Actions](https://github.com/LDMX-Software/ldmx-sw/actions). One of these tests, the "Recon Validation" takes about three hours to run, so it shouldn't be run on every commit pushed to a pull request. Instead, it is run when the PR is created or when marked "Ready for Review". This enables the following workflow for validating PRs.
If the above does not work on your operating system, you can see system specific instructions [on the just website](https://just.systems/man/en/packages.htm)
62
+
If the above does not work on your operating system, you can see system specific instructions [on the just website](https://just.systems/man/en/packages.html)
63
63
64
64
You probably want to enable [shell tab-completion](https://just.systems/man/en/shell-completion-scripts.html) with `just`
65
65
which only needs to be done once per installation but will help save typing.
Copy file name to clipboardExpand all lines: src/using/dark-brem/intro.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Following conventions done by collider experiments, I usually call stage one "ge
10
10
To make this even more complicated, LDMX has two different methods to perform the DB simulation. This has led to some confusion within the collaboration and so this document explains both (even though only one is suggested for future use).
11
11
12
12
### Historical Method
13
-
The "historical" method is the one that was first done and is a valid approximation for the O(90%) of electrons that arrive at the target undisturbed by the upstream detector components (tagger tracker and trigger scintillator). Generation is done by using MadGraph at a _single_ beam energy such that a _single_ LHE file is output. This LHE file is then given to the [LHEPrimaryGenerator](Configuring-the-Simulation.md) to setup the electron and A' as primaries. The vertex of the primaries imported from the LHE files would be smeared around the target, but the electron's energy would stay fixed at the energy simulated for the LHE files.
13
+
The "historical" method is the one that was first done and is a valid approximation for the O(90%) of electrons that arrive at the target undisturbed by the upstream detector components (tagger tracker and trigger scintillator). Generation is done by using MadGraph at a _single_ beam energy such that a _single_ LHE file is output. This LHE file is then given to the [LHEPrimaryGenerator](../sim/configuring.md) to setup the electron and A' as primaries. The vertex of the primaries imported from the LHE files would be smeared around the target, but the electron's energy would stay fixed at the energy simulated for the LHE files.
14
14
15
15
As mentioned, this is a good approximation for a vast majority of electrons when looking a DB _in the target_. It is not a helpful method if we wish to include the complexities of the tagger tracker and trigger scintilator or if we wish to look for DB in other parts of the LDMX detector (like in the ECal).
Copy file name to clipboardExpand all lines: src/using/sim/generating.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Generating Simulation Samples
2
2
3
-
The generation of simulation samples is done mainly by the Geant4 package with several additions stored in the `SimCore` module of ldmx-sw. However, you do not need to know the simulation to this level of depth. The `Simulator` producer in the `SimCore` module is your messenger to run the simulation. Here, I will go through its basic usage. For more information about _all_ of the available parameters, please see the documentation on [Configuring the Simulation](Configuring-the-Simulation.md).
3
+
The generation of simulation samples is done mainly by the Geant4 package with several additions stored in the `SimCore` module of ldmx-sw. However, you do not need to know the simulation to this level of depth. The `Simulator` producer in the `SimCore` module is your messenger to run the simulation. Here, I will go through its basic usage. For more information about _all_ of the available parameters, please see the documentation on [Configuring the Simulation](configuring.md).
4
4
5
5
### Basic Usage
6
6
Running the simulation is just like any other producer in ldmx-sw. In your python configuration script, it is _required_ that you have the following lines (or equivalent):
@@ -13,7 +13,7 @@ You can write your own detector description in the gdml format (if you want), bu
13
13
mySimulator.setDetector( 'ldmx-det-v12' )
14
14
```
15
15
Okay, `mySimulator` now is created and has been given a path to an LDMX detector description.
16
-
What else is needed? Well, we need _at least_ one more thing. We need to tell the simulation _how_ to start the simulation. In Geant4 speak, this is called a "Primary Generator". In ldmx-sw, we already have several generators defined (more details on [Configuring the Simulation](Configuring-the-Simulation.md)), but for this simple example, we will just import a standard generator.
16
+
What else is needed? Well, we need _at least_ one more thing. We need to tell the simulation _how_ to start the simulation. In Geant4 speak, this is called a "Primary Generator". In ldmx-sw, we already have several generators defined (more details on [Configuring the Simulation](configuring.md)), but for this simple example, we will just import a standard generator.
(or some [other prefix](http://127.0.0.1:3000/users/config/intro.html#admonition-other-prefixes-besides-denv) running `fire` within the ldmx-sw environment)
36
+
(or some [other prefix](../config/intro.html#admonition-other-prefixes-besides-denv) running `fire` within the ldmx-sw environment)
37
37
38
38
### Other Available Templates
39
39
There are a lot of commonly used aspects of the simulation, so we have incorporated these common "templates" into the python interface for the simulation.
@@ -42,7 +42,7 @@ This section is focused on listing these available templates and how to access t
This module contains functions that produce each of the generators. You should _always_ use these helper functions because sometimes the underlying naming conventions may change in future developments. More detail about the generators is in the Generators section of [Configuring the Simulation](Configuring-the-Simulation.md).
45
+
This module contains functions that produce each of the generators. You should _always_ use these helper functions because sometimes the underlying naming conventions may change in future developments. More detail about the generators is in the Generators section of [Configuring the Simulation](configuring.md).
46
46
47
47
#### Biased Simulations
48
48
Several simulations with biased processes have been used frequently in the past, so we have written templates for using simulations with reasonably-defined defaults.
@@ -59,7 +59,7 @@ Function | Description
59
59
---|---
60
60
`photo_nuclear(detector,generator)` | PN process biased up and filtered for in (ecal or target)
61
61
`electro_nuclear(detector,generator)` | EN process biased up and filtered for in target
62
-
`dark_brem(massAPrime,lheFile,detector)` | Sets A' mass to massAPrime (in MeV) and uses the input LHE file as vertices for the dark brem simulation [more detail here](Dark-Brem-Signal-Process.md)
62
+
`dark_brem(massAPrime,lheFile,detector)` | Sets A' mass to massAPrime (in MeV) and uses the input LHE file as vertices for the dark brem simulation [more detail here](../dark-brem/intro.md)
63
63
64
64
### More Advanced Details
65
65
As I said earlier, you can definitely see all of the capabilities of `Simulator` by looking at the parameters that are available in the documentation (linked above). Two parameters that I would like to point out is `preInitCommands` and `postInitCommands`. These parameters are given directly to the Geant4 UI as a string, so you can still access Geant4 directly using these commands.
0 commit comments