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

Proposal: uniform naming of Macros #689

Open
ajedele opened this issue Nov 4, 2022 · 2 comments
Open

Proposal: uniform naming of Macros #689

ajedele opened this issue Nov 4, 2022 · 2 comments

Comments

@ajedele
Copy link
Contributor

ajedele commented Nov 4, 2022

The source code we use follows a very clear pattern:
Mapped2Cal
Cal2Hit
If there are other steps in between, they still mostly follow the scheme (Mapped2Precal or Mapped2Histo).

The macros used to execute the code have been renamed several times and are therefore much harder to find. For example, common naming convention was {detector name}+{step of calibration}.C. For example, TofdMapped2Cal.C. Recently, they have been renamed.

I would suggest, given the high overhead of R3BRoot and root, in general, for new students, we agree on a common naming convention for the macros.

@klenze
Copy link
Contributor

klenze commented Nov 8, 2022

Further ideas:
Last time I checked, R3BRoot seems to be mainly for the R3B experiment. So why do we have R3BRoot/macros/r3b/?
(Of course, nowadays, the relevant macros are stashed away in the invisible R3BParams repositories so that outsiders can't quickly use our self-explanatory code base to analyze our experiments and beat us to the Nobel or something.)

Otherwise, I can only comment on the S522 repository. (It makes perfect sense to compartmentalize access to the params on a need to know basis. Limit the damage a single person getting turned can do. Can we try to get the params classified as VS-NfD?)

Without commenting on the specifics (and thus violating StGB § 353b), I think I can safely mention that the numbers of macros in S522 whose name matches the regular expression .*[mM]apped2.* is rather limited, so you probably had another params repository in mind?

@jose-luis-rs
Copy link
Contributor

@ajedele for the macros there is not common naming convention, but somehow the convention is to use names that explain the use of the macro, for instance:

  • TofdMapped2Cal.C
  • finder_tofd_calpar.C
    What do you expect from these macros? obviously the parameters to reach the CAL level. For me the names are very clear.

@klenze please, check our wiki for details:
https://wiki.r3b-nustar.de/analysis/parameters/overview
this was also explained in several analysis meetings by Gabriel, Valerii, Hector, ...

@klenze Last time I checked, R3BRoot seems to be mainly for the R3B experiment. So why do we have R3BRoot/macros/r3b/?
In the past (~2011) FairRoot and R3BRoot were one and the idea was to have a folder with the macros for all the experiments. Later, the base code was moved into the FairRoot repository and the specific R3B folders/detectors were moved into the R3BRoot repository. But some old macros are still in the repository macros, I guess we should remove them to avoid misunderstandings.

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

No branches or pull requests

3 participants