Skip to content

Commit f9ed704

Browse files
authored
remove mentions of JEventProcessorSequentialRoot, deprecate external plugins (#1995)
### Briefly, what does this PR introduce? JEventProcessorSequentialRoot was never used and removed in the latest JANA2 release JeffersonLab/JANA2#456 Let's remove the references to it. Those come from unmaintained documentation and deprecated benchmark, so my proposal is to remove those pieces. **This deprecates support for external plugins**. ### What kind of change does this PR introduce? - [ ] Bug fix (issue #__) - [ ] New feature (issue #__) - [ ] Documentation update - [ ] Other: __ ### Please check if this PR fulfills the following: - [ ] Tests for the changes have been added - [ ] Documentation has been added / updated - [ ] Changes have been communicated to collaborators ### Does this PR introduce breaking changes? What changes might users need to make to their code? No ### Does this PR change default behavior? No
1 parent 6626efa commit f9ed704

File tree

21 files changed

+6
-1219
lines changed

21 files changed

+6
-1219
lines changed

.github/workflows/linux-eic-shell.yml

Lines changed: 0 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -549,45 +549,6 @@ jobs:
549549
path: two_stage_rec_${{ matrix.particle }}_1GeV_20GeV_${{ matrix.detector_config }}.edm4eic.root
550550
if-no-files-found: error
551551

552-
eicrecon-eicmkplugin:
553-
runs-on: ubuntu-24.04
554-
needs:
555-
- build
556-
- npsim-gun
557-
strategy:
558-
matrix:
559-
CXX: [g++]
560-
particle: [e]
561-
detector_config: [craterlake]
562-
steps:
563-
- name: Checkout .github
564-
uses: actions/checkout@v4
565-
with:
566-
sparse-checkout: .github
567-
- name: Download install directory
568-
uses: actions/download-artifact@v4
569-
with:
570-
name: install-${{ matrix.CXX }}-eic-shell-Release-${{ env.platform }}-${{ env.release }}-ASAN
571-
- name: Unarchive install directory
572-
run: tar -xaf install.tar.zst
573-
- uses: actions/download-artifact@v4
574-
with:
575-
name: sim_${{ matrix.particle }}_1GeV_20GeV_${{ matrix.detector_config }}.edm4hep.root
576-
- uses: cvmfs-contrib/github-action-cvmfs@v5
577-
- name: Run EICrecon
578-
uses: eic/run-cvmfs-osg-eic-shell@main
579-
with:
580-
platform-release: "${{ env.platform }}:${{ env.release }}"
581-
setup: "/opt/detector/epic-${{ env.detector-version }}/bin/thisepic.sh"
582-
run: |
583-
export DETECTOR_CONFIG=${DETECTOR}_${{ matrix.detector_config }}
584-
export LD_LIBRARY_PATH=$PWD/install/lib:$LD_LIBRARY_PATH
585-
export JANA_PLUGIN_PATH=$PWD/install/lib/EICrecon/plugins${JANA_PLUGIN_PATH:+:${JANA_PLUGIN_PATH}}
586-
$PWD/install/bin/eicmkplugin.py MyCustomPlugin
587-
cmake -S MyCustomPlugin -B MyCustomPlugin/build -DEICrecon_ROOT=$PWD/install -DUSER_PLUGIN_OUTPUT_DIRECTORY=$PWD/install/lib/EICrecon/plugins
588-
cmake --build MyCustomPlugin/build -j $(getconf _NPROCESSORS_ONLN) --target install
589-
$PWD/install/bin/eicrecon ${{env.JANA_OPTIONS}} ${{env.JANA_OPTIONS_GUN}} -Pplugins=MyCustomPlugin -Ppodio:output_file=rec_${{ matrix.particle }}_1GeV_20GeV_${{ matrix.detector_config }}.edm4eic.root sim_${{ matrix.particle }}_1GeV_20GeV_${{ matrix.detector_config }}.edm4hep.root
590-
591552
eicrecon-test-plugins:
592553
runs-on: ubuntu-24.04
593554
needs:
@@ -644,10 +605,8 @@ jobs:
644605
particle: [e]
645606
detector_config: [craterlake]
646607
benchmark_plugins:
647-
- EcalBarrelScFiCheck
648608
- femc_studies
649609
- lfhcal_studies
650-
- TRACKINGcheck
651610
- tracking_efficiency
652611
- tracking_occupancy
653612
steps:

docs/_sidebar.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
* [Run DD4Hep simulation](howto/run_dd4hep_simulation.md)
77
* [Use docker](howto/use_docker.md)
88
* [Use singularity](howto/use_singularity.md)
9-
* [Make Plugin](howto/make_plugin.md)
109
* [Add Factory](howto/add_factory.md)
1110
* [Visualize Callgraph](howto/visualize_callgraph.md)
1211
* Design
@@ -23,9 +22,8 @@
2322
* Tutorials
2423
* [Introduction](tutorial/01-introduction.md)
2524
* [Work environment](tutorial/02-work-environment.md)
26-
* [End user plugin](tutorial/03-end-user-plugin.md)
27-
* [Factory](tutorial/04-factory.md)
28-
* [Contributing](tutorial/05-contributing.md)
25+
* [Factory](tutorial/03-factory.md)
26+
* [Contributing](tutorial/04-contributing.md)
2927
* Misc
3028
* [References](misc/references.md)
3129
* Flags

docs/get-started/eic-shell.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,4 @@ Example:
7272
eicrecon -Pplugins=plugin1,plugin2,plugin3 -Pnthreads=8 inputfile1.txt
7373
~~~
7474

75-
At this point, you can [create your own user plugin](/howto/make_plugin.md) or
76-
[add a new factory (i.e. algorithm)](/howto/add_factory.md).
75+
At this point, you can [add a new factory (i.e. algorithm)](/howto/add_factory.md).

docs/howto/add_factory.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,7 @@ extern "C" {
160160

161161
## Testing the new factory
162162

163-
Please follow the instructions on [creating a user plugin](HowTo_make_plugin.md)
164-
to get a working plugin. Then add these lines in the inidacted places:
163+
Add these lines in your plugin:
165164

166165
```cpp
167166
// Place this at the top of the processor header file (e.g. DaveTestProcessor.h)

docs/howto/make_plugin.md

Lines changed: 0 additions & 413 deletions
This file was deleted.

docs/tutorial/03-end-user-plugin.md

Lines changed: 0 additions & 154 deletions
This file was deleted.

docs/tutorial/04-factory.md renamed to docs/tutorial/03-factory.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
## Introduction
1111

1212

13-
Now that you've learned about JANA plugins and JEventProcessors, let's talk about JFactories. JFactories are another essential JANA component just like JEventProcessors and JEventSources. While JEventProcessors are used for _aggregating_ results from each event into a structured output such as a histogram or a file, JFactories are used for computing those results in an organized way.
13+
Let's talk about JFactories. JFactories are another essential JANA component just like JEventProcessors and JEventSources. While JEventProcessors are used for _aggregating_ results from each event into a structured output such as a histogram or a file, JFactories are used for computing those results in an organized way.
1414

1515

1616
### When do I use a JFactory?
@@ -31,14 +31,6 @@ Now that you've learned about JANA plugins and JEventProcessors, let's talk abou
3131
4. You can simply ask for the results you need and the JFactory will provide it. If nobody needs the results from the JFactory, it won't be run. If the results were already in the input file, it won't be run. If there are multiple consumers, the results are only computed once and then cached. If the JFactory relies on results from other JFactories, it will call them transparently and recursively.
3232

3333

34-
### When do I create my own plugin?
35-
36-
- If you are doing a one-off prototype, it's fine to just use a ROOT macro.
37-
- If you are writing code you'll probably return to, we recommend putting the code in a standalone (i.e. outside of the EICrecon source tree) plugin.
38-
- If you are writing code other people will probably want to run, we recommend adding your plugin to the EICrecon source tree.
39-
- If you are writing a JFactory, we recommend adding it to the EICrecon source tree, either to an existing plugin or to a new one.
40-
41-
4234
## Algorithms vs Factories
4335

4436
In general, a Factory is a programming pattern for constructing objects in an abstract way. Oftentimes, the Factory is calling an algorithm under the hood.
File renamed without changes.

src/benchmarks/CMakeLists.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
add_subdirectory(detectors/EcalBarrelScFiCheck)
2-
add_subdirectory(reconstruction/TRACKINGcheck)
31
add_subdirectory(reconstruction/tracking_occupancy)
42
add_subdirectory(reconstruction/tracking_efficiency)
53
add_subdirectory(reconstruction/lfhcal_studies)

src/benchmarks/detectors/EcalBarrelScFiCheck/CMakeLists.txt

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)