just adopt a task runner

[tomeichlersmith]

I am updating ldmx-sw by including a justfile and rewriting the README to point folks to denv and just. The ldmx-env.sh script is left in place and is only changed to include a deprecation notice if a user sources it and does not have both denv and just installed. (If both are available, then ldmx is just an alias for just and the justfile recipes are used instead of the ldmx-env.sh bash functions.)

The best way to show why I chose this workflow is probably to show some examples assuming denv and just are installed.

New Clone

git clone --recursive [email protected]:LDMX-Software/ldmx-sw.git
cd ldmx-sw
just init

Default Build

just configure build

From somewhere else

just path/to/ldmx-sw/build test

Pretty Output

What are the issues that this addresses?

This resolves #1377 directly and resolves #1248 indirectly (via denv).

Check List

• I successfully compiled ldmx-sw with my developments
• I ran my developments and the following shows that they are successful.
• Add rootbrowse recipe and root
• Update doc website Separate users from developers ldmx-software.github.io#35
  • As the re-written README points out, I think using denv and the production images allows many folks who are just using ldmx-sw to do studies to avoid compiling ldmx-sw themselves. I think this is a nice workflow since it both pins the version of ldmx-sw of the study and allows users to jump right in to a physics study without needing to run the compilation. This is a workflow change though and so I'd want to update the doc website to reflect this suggestion.
• Stabilize denv and create LDMX-Software fork
  • Before wide adoption, I'd like to make sure denv has GUI support on MacOS (Unsure on GUI connection for non-Linux hosts tomeichlersmith/denv#80 -> Enable MacOS GUI Connection tomeichlersmith/denv#120), create a major stable version (v1), and create an LDMX-Software fork of denv so that it can hang around with the collaboration separate from my personal account.

After @tvami 's first review...

• Have an ldmx symlink to denv to allow folks used to the ldmx program to continue using it after transition
• Flesh out README (and doc website) with example snippets of installing and enabling tab complete
• Connect tab complete of just to ldmx alias within ldmx-env.sh
• Undo chmod on TrigScint script

🛑 Won't Do 🛑

• support /cvmfs/unpacked.cern.ch in environment script #1252 could be done within these recipes but I think it is too complicated to try to do on this first pass
• implement a from-ldmx-env recipe. Thought about it, but denv pretty much requires the ldmx/dev image to be one of the newest available and other updates to ldmx-sw deprecate non-v4 images, so encouraging updating is a good way to go.
• put in python formatting right now. This is a bigger discussion that we can add later.
• fully test all command orderings. Further bugs can be patched as we encounter them, going to focus on making sure new developers can understand how to get started.

[tvami]

Another feature I'm missing is the autocomplete, with earlier ldmx comp<tab> autocomplete to ldmx compile, now that's gone, can we add it?

[tvami]

I tested most of the features, both on Linux and Mac. My most important ask is the autocomplete, the rest I could imagine life w/o....

[tomeichlersmith]

You can enable just's autocomplete https://just.systems/man/en/chapter_70.html

and then you need to attach these autocomplete functions to the ldmx alias as well https://just.systems/man/en/chapter_69.html?highlight=.j#shell-alias

I can put the second one into the ldmx-env.sh but, similar to the installation of just itself, tab-completion depends on the shell being used and where the user would like to install things. (What I do on my clusters which I could put into the README as an example as well is

just --completions bash >> ~/.local/share/bash-completion/completions/just

so that they are auto-loaded by bash when needed.)

[tvami]

What I do on my clusters which I could put into the README as an example as well is

OK this works for me, I'm happy now!

[tvami]

Major changes requested are done (TS config file is still there, but I guess that's ok)

Edit: All good now! Thanks Tom!