Warning, /jana2/docs/Download.md is written in an unsupported language. File is not indexed.
0001 # Download
0002
0003 ### Latest master (unstable)
0004
0005 - `git clone https://github.com/JeffersonLab/JANA2/`
0006
0007 ### Latest release
0008
0009 - `git clone --branch latest_release https://github.com/JeffersonLab/JANA2`
0010 - [See release on GitHub](https://github.com/JeffersonLab/JANA2/tree/latest_release)
0011 - [See online documentation](https://jeffersonlab.github.io/JANA2/)
0012 - [See online doxygen documentation](https://jeffersonlab.github.io/JANA2/refcpp/)
0013
0014 ### 2026.03.00
0015
0016 #### Dependencies
0017 - Now builds with ROOT v6.40 (#498)
0018 - Adds optional bindings for Perfetto (#497)
0019 - Swaps out optional dependency libzmq for cppzmq (#507, #509)
0020 - Building/installing examples is now optional (#505, 501)
0021
0022 #### Bugfixes
0023 - Parameter parsing conflict: JLogger::Level vs spdlog level (#509)
0024 - Test cases run in the build directory without pulling in artifacts from the install directory (#505, #504, #503)
0025
0026 #### Refactoring
0027 - Redesign of the TopologyBuilder interface (#495)
0028 - Topologies which include an Unfolder no longer also pull in a no-op Folder (#499)
0029 - Improve engine performance with ultra fine grain parallelism (#508)
0030
0031 #### Ergonomics
0032 - Improve logging of swallowed exceptions (#509)
0033
0034 ### 2026.02.00
0035
0036 This release redesigns the `JFactory` state machine, changing `JFactory`'s behavior so that it now handles certain
0037 edge cases correctly. The new design enforces the guarantees for the `Init()` callback, making sure that it is run
0038 exactly once before `Process()` gets called, and doesn't get run if data is always `Insert()`ed instead. If `Init()` excepts, `Process()` is never run, and an empty collection is written instead. If `Process()` excepts, a partial collection may be written. This release also changes behavior such that if an exception is encountered in `Init()` or `Process()`, JANA2 will store the exception and re-throw it, rather than re-running the excepting callback.
0039
0040 The `JFactory::Status` enum now precisely describes the contents of the factory cache, i.e. `{Empty, Processed, Inserted, Excepted}`. Whether or not the factory has been initialized has been factored out into the `JFactory::InitStatus` enum, i.e. `{InitNotRun, InitRun, InitExcepted}`. The `JFactory::CreationStatus` has been deprecated but is still around because GlueX
0041 uses it. It has been shrunk so that it only describes whether or not the factory has been activated, i.e. `{NotCreatedYet, Created}`, which is how it was used in practice.
0042
0043 This release primarily addresses issue #490. There are several additional bugfixes included:
0044
0045 - Adds CMake flags for disabling examples and tests, addressing issue #489
0046 - JWiringService wasn't loading plugins listed in the wiring file
0047 - JComponent::Input<T> wasn't calling JFactory::Create
0048 - Adding a JEventUnfolder but no JEventProcessors triggered an error in the JEventQueue ordering logic
0049
0050
0051 ### 2026.01.00
0052
0053 This release brings a couple of exciting new features along with some important bugfixes. The big JFactory/JDatabundle refactoring is
0054 finally complete, and the bugs that it introduced in v2.4.3 are fixed. We are hoping that this release will be sufficient for merging
0055 EICrecon's timeframe splitter. This release is also notable for being our first release that uses calendar versioning, which hopefully
0056 matches our workflow better.
0057
0058 #### Bugfixes
0059
0060 - Fix problems with `Input` and `Output` tags introduced in v2.4.3 (PR #464)
0061 - Use of deprecated `operator->()` on podio collections (PR #477)
0062 - Template instantation error with podio LinkCollections (PR #462)
0063 - Stringify array and vector parameters consistently with primitives (PR #457)
0064
0065 #### Features
0066
0067 - Extend support for external wiring to include non-JFactory components (PR #476, #473)
0068 - Add support for preserving the original event ordering with multithreading enabled (PR #472)
0069 - Add support for multilevel event sources (PR #467)
0070
0071 #### Refactoring
0072
0073 - Podio-collection-producing factories no longer inherit from JFactoryT (PR #460, #479)
0074 - Removed obsolete `Streaming/` code (PR #468)
0075
0076 #### Examples
0077
0078 - Example: Hit reconstruction (PR #470)
0079 - Example: Protoclustering (PR #469)
0080
0081 ### 2.4.3
0082
0083 #### Behavior changes
0084
0085 - JHasOutputs represents variadic output names as `std::vector<std::vector<std::string>>`, which now allows for multiple variadic outputs with arbitrary lengths (Pull request #458)
0086
0087 - Removed the never-used JEventProcessorSequential and JEventProcessorSequentialRoot. All their functionality has been backported to JEventProcessor. (Pull request #456)
0088
0089 - JInspector is now launched using the parameter `jana:inspect=true` instead of the command-line argument `--interactive`, which works regardless of which executable runs JANA. (Pull request 459)
0090
0091 #### Bugfixes
0092
0093 - Relax JFactory::Create cycle detector for the sake of JEventSourceEVIOpp (Pull request #461)
0094
0095 - Fix JFactoryPodioT template error when using Podio LinkCollections (Pull request #462)
0096
0097 - JEventUnfolder erroneously inserted outputs even though KeepChildNextParent was returned (Pull request #458)
0098
0099 - JEventUnfolder supports parent events with zero children (Pull request #456)
0100
0101 - JTopologyBuilder creates a chain of TapArrows so that independent JEventProcessors can be pipelined, allowing new-style JEventProcessors to have comparable performance to the old-style ones. (Pull request 456)
0102
0103 #### Features
0104
0105 - Variadic inputs now support an EmptyInputPolicy, which allows components to optionally retrieve all databundles/collections for a given type and EventLevel, analogous to JEvent::GetFactoryAll(). (Pull request #454)
0106
0107 #### Usability improvements and refactoring
0108
0109 - Improve the JANA tutorial and examples by creating a new paradigm, in which a toy reconstruction codebase is systematically built up piece-by-piece. Two versions exist, one using a lightweight (GlueX-style) datamodel, and the other using a Podio datamodel. Apart from the datamodel choice, the two versions are functionally identical. (Pull request #453)
0110
0111 - Improve debugging by having the JANA1-style JEvent::GetSingle directly throw a JException instead of a size_t, thereby producing a full stack trace (Pull request #461)
0112
0113 - Renamed JEventProcessor::Process(const JEvent&) to ProcessSequential to reduce user confusion (Note that this feature was experimental and unused up until now) (Pull request #456)
0114
0115 - JTopologyBuilder::connect() wires arrows using port id instead of port index, reducing confusion while manually configuring topologies. (Pull request #456)
0116
0117 - JFactoryT uses JDatabundle under the hood, as part of a deeper long-term refactoring. (Pull request #458, Issues #254, #276)
0118
0119 ### 2.4.2
0120
0121 #### Behavior changes
0122 - `jana:max_inflight_events` now defaults `nthreads` regardless of whether `nthreads` was explicitly set. Previously it defaulted to 4 when `nthreads` was unset, and otherwise defaulted to `nthreads`. (Issue #443)
0123 - `JEventSource::GetEventCount()` is deprecated and replaced by `GetSkippedCount()`, `GetEmittedEventCount()`, and `GetProcessedEventCount()`. These behave intuitively when `nskip` is used. (Issue #428)
0124
0125 #### Features
0126 - Added `jana:output_processed_event_numbers` parameter to assist with debugging (Issue #425)
0127 - Ported `janaroot` plugin from JANA1
0128 - JFactory detects and excepts on cycles (Issue #423)
0129 - Improved scale test visualizations, including plotting multiple scaling tests on the same plot and supporting log scaled axes.
0130
0131 #### Bugfixes
0132 - Missing template argument in VariadicPodioOutput
0133 - JEvent was being marked as warmed up prematurely
0134 - JAutoactivator was being called last instead of first (Issue #440)
0135 - If the user attempted to run without providing a JEventSource, processing would crash with an ArithmeticException instead of a helpful error message (Issue #437)
0136 - `JEventSource::FinishEvent()` was being called spuriously (Issue #424)
0137
0138 #### Refactoring
0139 - Preliminary support for random-access JEventSources is provided via `JEventSource::Skip()`. This feature should be considered experimental for now because it doesn't work with barrier events yet. (Issue #422)
0140
0141 ### 2.4.1
0142
0143 This release enables CCDB caching, significantly improving performance and reducing memory usage for applications that frequently access calibration constants.
0144
0145 ### 2.4.0
0146
0147 #### Features
0148
0149 - Externally wired factories using `JWiredFactoryGenerator` (#399, #400)
0150
0151 #### Bugfixes
0152
0153 - Fix parameter strictness check (#394)
0154 - Fix Podio deprecation warnings (#389)
0155 - Fix ODR violation (#396)
0156 - Fix `JFactory::Create()` logic (#383)
0157 - Fix `JEventProcessor` deletion order (#391)
0158 - Fix double-free in `JLockService` destructor (#388)
0159
0160 #### Refactoring
0161
0162 - Migrate `JStreamLog` uses to `JLogger` (#390, #395, #398)
0163 - Reorganize and deprecate `Compatibility/` headers (#392, #397)
0164 - Refactor arrow execution machinery (#385, #387, #393)
0165
0166 ### 2.3.3
0167
0168 #### Bugfixes
0169 * Fix problem with user-defined factory generators (#366)
0170 * JEventProcessor::Process() called before BeginRun() (#367)
0171 * Lock overwrite in RootFillLock() (#369)
0172 * JFactory::Finish() is called (#377)
0173
0174 #### Features
0175 * JTopologyBuilder supports topologies with arbitrarily nested levels (#346)
0176 * Barrier events are back (#371)
0177
0178 #### Refactoring
0179 * Improved log output (#368)
0180 * JTest uses new-style component interfaces (#374)
0181 * JArrows now fire on individual events (#375, #378)
0182
0183 - [See release on GitHub](https://github.com/JeffersonLab/JANA2/releases/tag/v2.3.3)
0184
0185 ### 2.3.2
0186 This release includes the following:
0187
0188 #### Features
0189 - Added a simple `JWiringService` which can be used to wire `JOmniFactories` via a TOML file. (#353, #363)
0190 - Added `add_jana_plugin`, `add_jana_library`, and `add_jana_test` CMake macros (#364)
0191
0192 #### Bugfixes
0193 - A multithreading bug in `JEventProcessor` has been fixed.
0194 - `JFactory::Create` now checks `JEventSource::GetObjects` (#361)
0195 - `JPluginLoader` no longer loads plugins twice in certain cases (#343)
0196 - `JParameterManager::FilterParameters` marks parameters as 'used', thereby avoiding spurious 'unused parameter' warnings. (#331)
0197 - `JTypeInfo::to_string_with_si_prefix` generates the correct SI prefix in certain cases (#348)
0198
0199 #### Refactoring
0200 - Plugins and their headers are now installed to a directory that doesn't conflict with a system install (#330)
0201 - `JPluginLoader` has been extensively rewritten (#339)
0202 - `JCsvWriter` has been moved into `examples` (#350)
0203 - JANA's internal performance testing RNG has been refactored to be more reproducible, and to avoid ASAN violations. (#315)
0204 - `JPodioExample` has been split into several reusable examples. (#352)
0205 - Code was moved from `Omni` and `Status` into `Components`, making the layered architecture clearer (#351)
0206 - Documentation has been overhauled, including adding an extensive JANA1-to-JANA2 migration guide (#334, #336, #342, #354, #357, #359)
0207 - CI testing has been extended (#332, #341)
0208
0209 #### Behavior changes:
0210 - JANA now has one internal logger, configurable via the `jana:loglevel` parameter. External loggers are now configurable via the `jana:global_loglevel` parameter.
0211 - Log output has been streamlined: oversized tables are now YAML, and essential information is now logged at `WARN` level. (#362)
0212 - `JPluginLoader` now stops when a plugin fails to load, rather than continuing searching for another plugin with the same name.
0213 - `JPluginLoader` no longer accepts paths as part of a valid plugin name
0214 - `JFactorySet` is no longer silent when the user attempts to include duplicates of the same factory (#343)
0215 - `JMetadata` is deprecated, to be replaced with `JMultifactory`. (#345)
0216 - All `JFactories` now call `JEventSource::GetObjects`, not just `JGetObjectsFactory`. (#361)
0217
0218 - [See release on GitHub](https://github.com/JeffersonLab/JANA2/releases/tag/v2.3.2)
0219 - [See online doxygen documentation](http://www.jlab.org/JANA/jana_doc_2.3.1/index.html)
0220 - [Download doxygen documentation](http://www.jlab.org/JANA/jana_doc_2.3.1.tar.gz)
0221
0222 ### 2.3.1
0223 This release fixes a bug which caused the `janadot` plugin to stop producing output. It also drops support for Podio <= 00-17 by replacing the user-provided `PodioTypeMap` with the built-in `PodioT::collection_type`.
0224
0225 - [See release on GitHub](https://github.com/JeffersonLab/JANA2/releases/tag/v2.3.1)
0226 - [See online doxygen documentation](http://www.jlab.org/JANA/jana_doc_2.3.1/index.html)
0227 - [Download doxygen documentation](http://www.jlab.org/JANA/jana_doc_2.3.1.tar.gz)
0228
0229 ### 2.3.0
0230 - [See release on GitHub](https://github.com/JeffersonLab/JANA2/releases/tag/v2.3.0)
0231 - [See online doxygen documentation](http://www.jlab.org/JANA/jana_doc_2.3.0/index.html)
0232 - [Download doxygen documentation](http://www.jlab.org/JANA/jana_doc_2.3.0.tar.gz)
0233
0234 ### JANA 1
0235
0236 - JANA 1 is deprecated but still in use with projects such as GlueX.
0237 - [JANA 1 homepage](https://www.jlab.org/JANA/)
0238 - [JANA 1 repo](https://github.com/JeffersonLab/JANA)
0239
0240
