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.02.00
0015
0016 This release redesigns the `JFactory` state machine, changing `JFactory`'s behavior so that it now handles certain
0017 edge cases correctly. The new design enforces the guarantees for the `Init()` callback, making sure that it is run
0018 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.
0019
0020 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
0021 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.
0022
0023 This release primarily addresses issue #490. There are several additional bugfixes included:
0024
0025 - Adds CMake flags for disabling examples and tests, addressing issue #489
0026 - JWiringService wasn't loading plugins listed in the wiring file
0027 - JComponent::Input<T> wasn't calling JFactory::Create
0028 - Adding a JEventUnfolder but no JEventProcessors triggered an error in the JEventQueue ordering logic
0029
0030
0031 ### 2026.01.00
0032
0033 This release brings a couple of exciting new features along with some important bugfixes. The big JFactory/JDatabundle refactoring is
0034 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
0035 EICrecon's timeframe splitter. This release is also notable for being our first release that uses calendar versioning, which hopefully
0036 matches our workflow better.
0037
0038 #### Bugfixes
0039
0040 - Fix problems with `Input` and `Output` tags introduced in v2.4.3 (PR #464)
0041 - Use of deprecated `operator->()` on podio collections (PR #477)
0042 - Template instantation error with podio LinkCollections (PR #462)
0043 - Stringify array and vector parameters consistently with primitives (PR #457)
0044
0045 #### Features
0046
0047 - Extend support for external wiring to include non-JFactory components (PR #476, #473)
0048 - Add support for preserving the original event ordering with multithreading enabled (PR #472)
0049 - Add support for multilevel event sources (PR #467)
0050
0051 #### Refactoring
0052
0053 - Podio-collection-producing factories no longer inherit from JFactoryT (PR #460, #479)
0054 - Removed obsolete `Streaming/` code (PR #468)
0055
0056 #### Examples
0057
0058 - Example: Hit reconstruction (PR #470)
0059 - Example: Protoclustering (PR #469)
0060
0061 ### 2.4.3
0062
0063 #### Behavior changes
0064
0065 - 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)
0066
0067 - Removed the never-used JEventProcessorSequential and JEventProcessorSequentialRoot. All their functionality has been backported to JEventProcessor. (Pull request #456)
0068
0069 - 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)
0070
0071 #### Bugfixes
0072
0073 - Relax JFactory::Create cycle detector for the sake of JEventSourceEVIOpp (Pull request #461)
0074
0075 - Fix JFactoryPodioT template error when using Podio LinkCollections (Pull request #462)
0076
0077 - JEventUnfolder erroneously inserted outputs even though KeepChildNextParent was returned (Pull request #458)
0078
0079 - JEventUnfolder supports parent events with zero children (Pull request #456)
0080
0081 - 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)
0082
0083 #### Features
0084
0085 - 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)
0086
0087 #### Usability improvements and refactoring
0088
0089 - 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)
0090
0091 - 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)
0092
0093 - 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)
0094
0095 - JTopologyBuilder::connect() wires arrows using port id instead of port index, reducing confusion while manually configuring topologies. (Pull request #456)
0096
0097 - JFactoryT uses JDatabundle under the hood, as part of a deeper long-term refactoring. (Pull request #458, Issues #254, #276)
0098
0099 ### 2.4.2
0100
0101 #### Behavior changes
0102 - `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)
0103 - `JEventSource::GetEventCount()` is deprecated and replaced by `GetSkippedCount()`, `GetEmittedEventCount()`, and `GetProcessedEventCount()`. These behave intuitively when `nskip` is used. (Issue #428)
0104
0105 #### Features
0106 - Added `jana:output_processed_event_numbers` parameter to assist with debugging (Issue #425)
0107 - Ported `janaroot` plugin from JANA1
0108 - JFactory detects and excepts on cycles (Issue #423)
0109 - Improved scale test visualizations, including plotting multiple scaling tests on the same plot and supporting log scaled axes.
0110
0111 #### Bugfixes
0112 - Missing template argument in VariadicPodioOutput
0113 - JEvent was being marked as warmed up prematurely
0114 - JAutoactivator was being called last instead of first (Issue #440)
0115 - If the user attempted to run without providing a JEventSource, processing would crash with an ArithmeticException instead of a helpful error message (Issue #437)
0116 - `JEventSource::FinishEvent()` was being called spuriously (Issue #424)
0117
0118 #### Refactoring
0119 - 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)
0120
0121 ### 2.4.1
0122
0123 This release enables CCDB caching, significantly improving performance and reducing memory usage for applications that frequently access calibration constants.
0124
0125 ### 2.4.0
0126
0127 #### Features
0128
0129 - Externally wired factories using `JWiredFactoryGenerator` (#399, #400)
0130
0131 #### Bugfixes
0132
0133 - Fix parameter strictness check (#394)
0134 - Fix Podio deprecation warnings (#389)
0135 - Fix ODR violation (#396)
0136 - Fix `JFactory::Create()` logic (#383)
0137 - Fix `JEventProcessor` deletion order (#391)
0138 - Fix double-free in `JLockService` destructor (#388)
0139
0140 #### Refactoring
0141
0142 - Migrate `JStreamLog` uses to `JLogger` (#390, #395, #398)
0143 - Reorganize and deprecate `Compatibility/` headers (#392, #397)
0144 - Refactor arrow execution machinery (#385, #387, #393)
0145
0146 ### 2.3.3
0147
0148 #### Bugfixes
0149 * Fix problem with user-defined factory generators (#366)
0150 * JEventProcessor::Process() called before BeginRun() (#367)
0151 * Lock overwrite in RootFillLock() (#369)
0152 * JFactory::Finish() is called (#377)
0153
0154 #### Features
0155 * JTopologyBuilder supports topologies with arbitrarily nested levels (#346)
0156 * Barrier events are back (#371)
0157
0158 #### Refactoring
0159 * Improved log output (#368)
0160 * JTest uses new-style component interfaces (#374)
0161 * JArrows now fire on individual events (#375, #378)
0162
0163 - [See release on GitHub](https://github.com/JeffersonLab/JANA2/releases/tag/v2.3.3)
0164
0165 ### 2.3.2
0166 This release includes the following:
0167
0168 #### Features
0169 - Added a simple `JWiringService` which can be used to wire `JOmniFactories` via a TOML file. (#353, #363)
0170 - Added `add_jana_plugin`, `add_jana_library`, and `add_jana_test` CMake macros (#364)
0171
0172 #### Bugfixes
0173 - A multithreading bug in `JEventProcessor` has been fixed.
0174 - `JFactory::Create` now checks `JEventSource::GetObjects` (#361)
0175 - `JPluginLoader` no longer loads plugins twice in certain cases (#343)
0176 - `JParameterManager::FilterParameters` marks parameters as 'used', thereby avoiding spurious 'unused parameter' warnings. (#331)
0177 - `JTypeInfo::to_string_with_si_prefix` generates the correct SI prefix in certain cases (#348)
0178
0179 #### Refactoring
0180 - Plugins and their headers are now installed to a directory that doesn't conflict with a system install (#330)
0181 - `JPluginLoader` has been extensively rewritten (#339)
0182 - `JCsvWriter` has been moved into `examples` (#350)
0183 - JANA's internal performance testing RNG has been refactored to be more reproducible, and to avoid ASAN violations. (#315)
0184 - `JPodioExample` has been split into several reusable examples. (#352)
0185 - Code was moved from `Omni` and `Status` into `Components`, making the layered architecture clearer (#351)
0186 - Documentation has been overhauled, including adding an extensive JANA1-to-JANA2 migration guide (#334, #336, #342, #354, #357, #359)
0187 - CI testing has been extended (#332, #341)
0188
0189 #### Behavior changes:
0190 - JANA now has one internal logger, configurable via the `jana:loglevel` parameter. External loggers are now configurable via the `jana:global_loglevel` parameter.
0191 - Log output has been streamlined: oversized tables are now YAML, and essential information is now logged at `WARN` level. (#362)
0192 - `JPluginLoader` now stops when a plugin fails to load, rather than continuing searching for another plugin with the same name.
0193 - `JPluginLoader` no longer accepts paths as part of a valid plugin name
0194 - `JFactorySet` is no longer silent when the user attempts to include duplicates of the same factory (#343)
0195 - `JMetadata` is deprecated, to be replaced with `JMultifactory`. (#345)
0196 - All `JFactories` now call `JEventSource::GetObjects`, not just `JGetObjectsFactory`. (#361)
0197
0198 - [See release on GitHub](https://github.com/JeffersonLab/JANA2/releases/tag/v2.3.2)
0199 - [See online doxygen documentation](http://www.jlab.org/JANA/jana_doc_2.3.1/index.html)
0200 - [Download doxygen documentation](http://www.jlab.org/JANA/jana_doc_2.3.1.tar.gz)
0201
0202 ### 2.3.1
0203 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`.
0204
0205 - [See release on GitHub](https://github.com/JeffersonLab/JANA2/releases/tag/v2.3.1)
0206 - [See online doxygen documentation](http://www.jlab.org/JANA/jana_doc_2.3.1/index.html)
0207 - [Download doxygen documentation](http://www.jlab.org/JANA/jana_doc_2.3.1.tar.gz)
0208
0209 ### 2.3.0
0210 - [See release on GitHub](https://github.com/JeffersonLab/JANA2/releases/tag/v2.3.0)
0211 - [See online doxygen documentation](http://www.jlab.org/JANA/jana_doc_2.3.0/index.html)
0212 - [Download doxygen documentation](http://www.jlab.org/JANA/jana_doc_2.3.0.tar.gz)
0213
0214 ### JANA 1
0215
0216 - JANA 1 is deprecated but still in use with projects such as GlueX.
0217 - [JANA 1 homepage](https://www.jlab.org/JANA/)
0218 - [JANA 1 repo](https://github.com/JeffersonLab/JANA)
0219
0220
