Skip to content

Latest commit

 

History

History
103 lines (85 loc) · 4.55 KB

README.md

File metadata and controls

103 lines (85 loc) · 4.55 KB
Raw

Dependencies

Dependencies are maintained in subdirectories of this directory. Many of them are mirrored here, using git subrepo, while the others must be downloaded separately.

Separate Download

  • delphes, from delphes/delphes: Fast simulation framework; run deps/install_delphes.sh to download and build

Mirrors (subrepo, unless otherwise indicated)

  • delphes_EIC, from eic/delphes_EIC: Delphes configuration cards for the EIC
  • mstwpdf, interpolation for MSTW PDFs, not a subrepo
  • adage, from c-dilks/adage: analysis framework for multi-dimensional binning

Notice

These dependencies (subdirectories) may have a different license than epic-analysis itself. The license and copyright used by epic-analysis does not apply to these subdirectories. Since they are git subrepos, they have been copied as is from their original source. Changes to any code in these dependencies must be accepted in the corresponding public Git repositories before being mirrored here.

Subrepo Maintenance

Each subrepo directory contains the file .gitrepo, which contains details about the subrepo configuration. Use git subrepo commands when making changes to any subrepos; run them from the top-level directory (../).

Subrepo Updates

Pull subrepo updates, and push them to epic-analysis remote:

git checkout -b <new-branch-name>  # make a new epic-analysis branch

# pull subrepo updates with either of:
git subrepo pull deps/<subrepo>  # pull updates from a particular <subrepo>
git subrepo pull --all           # pull updates from all subrepos

git push -u origin <new-branch-name>  # push the new epic-analysis branch (which already has the subrepo pull commit(s))

Then open a pull request for <new-branch-name> -> main

Subrepo Contributions

If you have push access to a subrepo remote, you can make your changes here. If you do not have push access, you will need to fork and make your changes separately (or reconfigure subrepo remotes here).

At any time, use git subrepo status to print the configuration of each subrepo. Actions such as git subrepo push or git subrepo pull will create commits on epic-analysis, be sure to push them to remote.

Assuming you have push access to the subrepo <subrepo>, and you have already made your changes to <subrepo> and you're ready to push them to the <subrepo> remote:

# check `epic-analysis` git status
git status

Commit and push all changes to epic-analysis (preferably in a new branch, and new PR); the changes can be both local to epic-analysis or local to <subrepo>, they do not have to be separate commits.

Create a new branch (e.g., <my-feature>) for <subrepo> remote, and push the changes we made to it:

git subrepo push deps/<subrepo> -b <my-feature> -u   # NOTE: if this fails, see troubleshooting section below
git push   # to push changes to `deps/<subrepo>/.gitrepo

The commit that you made above will be "copied" and pushed, in the sense that only the changes relevant to <subrepo> will be pushed to <subrepo> remote.

  • The -b option sets the branch name
  • The -u option updates the .gitrepo file, telling it to track <my-feature>

Make more changes as needed; push them to both epic-analysis and subrepo remotes:

git commit ...
git push ... # to `epic-analysis`
git subrepo push deps/<subrepo>  # no need for -b or -u, we are tracking `<my-feature>` already
git push  # (for .gitrepo)

When <my-feature> is merged to the <subrepo> main branch, we can revert the subrepo tracking branch and pull the update. Assuming the <subrepo> main branch is main:

git subrepo fetch deps/<subrepo> -b main            # fetch changes from <subrepo> remote
git subrepo pull deps/<subrepo> -b main -u --force  # pull changes (--force is needed if remote deleted <my-feature>)
git push

Finally, merge the feature branch in the main repository (do NOT squash merge!)

Troubleshooting

If a branch which included subrepo changes was squash merged in the primary repository, the parent commit of the subrepo push commit will not be in the commit history; therefore git subrepo push will fail with a cryptic error:

fatal: Not a valid object name: ''

Workaround: edit the .gitrepo file, changing parent to a recent, relevant parent commit in the primary repository (epic-analysis in this case), then try to subrepo push again