Skip to content

Commit

Permalink
docs: link additional AGC-related projects (#226)
Browse files Browse the repository at this point in the history
* link additional AGC-related projects

* update website

* exclude notebooks from ruff CI

* formatting
  • Loading branch information
alexander-held authored Sep 20, 2024
1 parent 9198eee commit 5c0e354
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 14 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,5 @@ jobs:
with:
fetch-depth: 0
- uses: jpetrucciani/ruff-check@main
with:
flags: '--exclude *ipynb'
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7274936.svg)](https://doi.org/10.5281/zenodo.7274936)
[![Documentation Status](https://readthedocs.org/projects/agc/badge/?version=latest)](https://agc.readthedocs.io/en/latest/?badge=latest)

**Interested in other AGC-related projects?** See [list below](#agc-implementations-and-related-projects).

The Analysis Grand Challenge (AGC) is about performing the last steps in an analysis pipeline at scale to test workflows envisioned for the HL-LHC.
This includes
Expand Down Expand Up @@ -45,16 +46,28 @@ We believe that the AGC can be useful in various contexts:
- realistic environment to prototype analysis workflows,
- functionality, integration & performance test for analysis facilities.

We are very interested in seeing (parts of) the AGC implemented in different ways!
Besides the implementation in this repository, have a look at

- a ROOT RDataFrame-based implementation: [root-project/analysis-grand-challenge](https://github.com/root-project/analysis-grand-challenge),
- a pure Julia implementation: [Moelf/LHC_AGC.jl](https://github.com/Moelf/LHC_AGC.jl).
- a columnflow implementation: [columnflow/agc_cms_ttbar](https://github.com/columnflow/agc_cms_ttbar).

We are very interested in seeing (parts of) the AGC implemented in different ways.
Please get in touch if you have investigated other approaches you would like to share!
There is no need to implement the full analysis task — it splits into pieces (for example the production of histograms) that can also be tackled individually.

## AGC implementations and related projects

Besides the implementation in this repository, have a look at the following implementations as well:

- ROOT RDataFrame-based implementation: [root-project/analysis-grand-challenge](https://github.com/root-project/analysis-grand-challenge)
- pure Julia implementation: [Moelf/LHC_AGC.jl](https://github.com/Moelf/LHC_AGC.jl)
- columnflow implementation: [columnflow/agc_cms_ttbar](https://github.com/columnflow/agc_cms_ttbar)

Additional related projects are listed below.
Are we missing some things in this list?
Please get in touch!

- AGC on REANA with Snakemake: [iris-hep/agc-reana](https://github.com/iris-hep/agc-reana)
- small demo of AGC with `dask-awkward` and `coffea` 2024: [iris-hep/calver-coffea-agc-demo](https://github.com/iris-hep/calver-coffea-agc-demo/)
- columnar analysis with ATLAS PHYSLITE Open Data: [iris-hep/agc-physlite](https://github.com/iris-hep/agc-physlite/)
- exploring automatic differentiation for physics analysis: [iris-hep/agc-autodiff](https://github.com/iris-hep/agc-autodiff/)
- AGC data processing with RNTuple files: [iris-hep/agc-rntuple](https://github.com/iris-hep/agc-rntuple)

## More details: what is being investigated in the AGC context

- New user interfaces: Complementary services that present the analyst with a notebook-based interface. Example software: Jupyter.
Expand Down
27 changes: 20 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,29 @@ We believe that the AGC can be useful in various contexts:
* realistic environment to prototype analysis workflows,
* functionality, integration & performance test for analysis facilities.

We are very interested in seeing (parts of) the AGC implemented in different ways!
Besides the implementation in this repository, have a look at

* a ROOT RDataFrame-based implementation: `root-project/analysis-grand-challenge <https://github.com/root-project/analysis-grand-challenge>`_
* a pure Julia implementation: `Moelf/LHC_AGC.jl <https://github.com/Moelf/LHC_AGC.jl>`_
* a columnflow implementation: `columnflow/agc_cms_ttbar <https://github.com/columnflow/agc_cms_ttbar>`_

We are very interested in seeing (parts of) the AGC implemented in different ways.
Please get in touch if you have investigated other approaches you would like to share!
There is no need to implement the full analysis task — it splits into pieces (for example the production of histograms) that can also be tackled individually.

AGC implementations and related projects
---------------------------------------------------------------

Besides the implementation in this repository, have a look at the following implementations as well:

* ROOT RDataFrame-based implementation: `root-project/analysis-grand-challenge <https://github.com/root-project/analysis-grand-challenge>`_
* pure Julia implementation: `Moelf/LHC_AGC.jl <https://github.com/Moelf/LHC_AGC.jl>`_
* columnflow implementation: `columnflow/agc_cms_ttbar <https://github.com/columnflow/agc_cms_ttbar>`_

Additional related projects are listed below.
Are we missing some things in this list?
Please get in touch!

- AGC on REANA with Snakemake: `iris-hep/agc-reana <https://github.com/iris-hep/agc-reana>`_
- small demo of AGC with `dask-awkward` and `coffea` 2024: `iris-hep/calver-coffea-agc-demo <https://github.com/iris-hep/calver-coffea-agc-demo/>`_
- columnar analysis with ATLAS PHYSLITE Open Data: `iris-hep/agc-physlite <https://github.com/iris-hep/agc-physlite>`_
- exploring automatic differentiation for physics analysis: `iris-hep/agc-autodiff <https://github.com/iris-hep/agc-autodiff>`_
- AGC data processing with RNTuple files: `iris-hep/agc-rntuple <https://github.com/iris-hep/agc-rntuple>`_

More details: what is being investigated in the AGC context
---------------------------------------------------------------

Expand Down

0 comments on commit 5c0e354

Please sign in to comment.