Skip to content

Latest commit

 

History

History
312 lines (256 loc) · 25.7 KB

RELEASENOTES.md

File metadata and controls

312 lines (256 loc) · 25.7 KB

This file contains the release notes for each version of WCSim. Release notes can also be found at https://github.com/WCSim/WCSim/tags.

02/06/2023: Notes for v1.11.0

This is the first full merge between WCSim/WCSim:develop and nuPRISM/WCSim:nuPRISM/develop for ~7 years.
There are therefore many changes, and it is inevitable that some will not be fully recognised in this list.
I have not looked at all at PRs before 2019.
For that I am sorry

The main feature of this release is the addition of mPMTs (multiple 3" PMTs in a 20"-PMT-like vessel), and the creation of associated geometries for IWCD and the HK FD.

Note that with this release, the recommended version of Geant4 is now 10.3.3

Default output .root file changes

  • fTriggerInfo in WCSimRootTrigger is now a std::vector<Double_t> (previously was a std::vector<Float_t>)
  • Addition of fParentId to WCSimRootTrack
  • Addition of fmPMTID and fmPMT_PMTID to all of WCSimRootCherenkovHit, WCSimRootCherenkovDigiHit, and WCSimRootPMT
  • Addition of fPhotonStartTime, fPhotonStartPos[3], fPhotonEndPos[3], fPhotonStartDir[3], and fPhotonEndDir[3]toWCSimRootCherenkovHitTime`
  • Addition of TClonesArray of WCSimRootCapture (a new class) to WCSimRootEvent
    • WCSimRootCaptureGamma is another new class stored within WCSimRootCapture
  • Addition of two new TClonesArray of WCSimRootPMT in WCSimRootGeom
    1. fPMTArray2 stores the second ID PMT type information (i.e. mPMT information in HK hybrid FD geometries)
    2. fODPMTArray stores the OD PMT information (this used to be stored at the end of fPMTArray)

New features

  • New script plot_pmts.C to plot the PMT distribution
  • Pull Request WCTE/WCSim#10 @kmtsui: Automatically switch Geant4 function arguments between G4.10.1 & 4.10.3
  • Pull Request tdealtry/#2 @spradlin: Restore interactive running mode of WCSim
  • Commit 7663873 @spradlin: Add -DWCSim_Geometry_Overlaps_CHECK cmake options
  • Pull Request nuPRISM/#63 @akutsuR: Adding parent G4 track id
  • Pull Request nuPRISM/#61 @bquilain: Merge of HK FD hybrid ID branch with nuPRISM code. Provides new HK ID-only hybrid FD geometry
  • Pull Request nuPRISM/#57 @nickwp: Add tracking of photon start and end directions for true hits
  • Pull Request nuPRISM/#54 @nickwp: Add git hash to output settings tree. See also nuPRISM/#55
  • Pull Request nuPRISM/#52 @nickwp: Add particle tracking options
  • Pull Request nuPRISM/#48 @mshinoki: Add WCTE Geometry
  • Addition of light injector simulation for primary particle generation
  • Addition of nRooTracker input file reading for generating physics events
  • Addition of extra _flat.root output file format. Note that this has not been validated during the merge, and could contain incorrect or incomplete information - this file is currently an unofficial solution in WCSim/WCSim

Updates

  • The default QE application method is now SensitiveDetector_Only (i.e. apply at PMT). It was previously Stacking_Only (i.e. apply at optical photon creation). Thank you to @spradlin for finding inconsistencies between the methods
  • The default values of PMTs in the HK geometries have been modified such that the extra tower is not built. This seems to greatly suppress the number of killed tracks
  • Deactivation of some old HK geometries. These can be reactivated if they are really required for studies, but they are no longer supported
  • Pull Request tdealtry/#1 @spradlin: Correct/suppress most compiler warnings
  • Pull Request #338 @guiguem: Upgrades to cmake installation. See all #341 #342 #344
  • Pull Request bquilain/#17 @JacekHoleczek: Various small building improvements
  • Pull Request bquilain/#14 @gpronost: Change holder of the PMT to E61 design
  • Pull Request bquilain/#12 @pdeperio: Merging of nuPRISM code with HK hybrid code. See also bquilain/#11
  • Pull Request nuPRISM/#49 @nickwp: Update IWCD geometry to match solidworks mechanical design

Bug fixes

10/26/2021: Notes for v1.10.0

The main feature of this release is the OD geometry including WLS plates Note that with this release, WCSim now requires a C++11 (or C++0x) compatible compiler

Update

  • Pull Request #218: Solve deprecated ext/hash_map header warning (now using C++11’s unordered_map)
  • Pull Request #266: Expand MakeKin.py to allow random uniform distributions of particle energies & times
  • Pull Request #292: Updated radon model
  • Pull Request #307: Make cmake compilation work with ROOT6 (+ scripts to compile on sukap)
  • Pull Request #212: Modify indices saved to WCSimRootCherenkovDigiHit::GetPhotonIds()
  • Pull Request #313: Use G4cout instead of printf

New feature

  • Pull Request #304: hadd scripts for combining WCSim files
  • Pull Request #297: Event generator based on cosmic muon flux
  • Pull Request #297: OD geometry including wavelength shifting plates
  • github actions version of CI build and run validation

Bug Fix

  • Pull Request #247: Use map features, instead of array-style access/iteration, in WCSimWCDigi
  • Pull Request #298: Make NoTrigger trigger work for OD
  • Pull Request #312: ROOT TRandom3 randomizer initialisation

04/12/2021: Notes for v1.9.4

This release includes an update to allow WCSimRootTriggers with more than 150 entries, as well as updates to the Travis automatic validation system execution tests

Update

  • Pull Request #308: Update validation tests
  • Pull Request #309: Dynamically expand WCSimRootTriggers TObjArray

12/02/2020: Notes for v1.9.3

This release includes a bug fix in the recently committed update.

Update

  • Pull Request #302: Typo in inFile command in src/WCSimPrimaryGeneratorAction.cc

11/26/2020: Notes for v1.9.2

This release includes an update to allow for longer headers in kin files - NOTE: A bug prevents this release from compiling

Update

  • Pull Request #299: Increase buffer size for reading in lines of kin file

10/02/2020: Notes for v1.9.1

This release includes a bug fix in a python helper script and support for Python3.

Bug Fix

  • Pull Request #293: Fix missing events when using kin_converter.py and upgrade to support Python 3

08/10/2020: Notes for v1.9.0

This release includes changes that allow for supernova neutrinos to be more easily simulated. The ability for tools to work in ROOT6 has also been included.

New Features

  • Pull Request #285: Include compatibilities for ROOT6
  • Pull Request #284: Include compatibilities for Singularity
  • Pull Request #275: Add the ability to simulate a radon background

Bug Fixes

  • Pull Request #286, #287: Fix a memory leak when running on large (>1000) event files.

Updates

  • Pull Request #289, #277: Allow for multiple vertices to have different information.
  • Pull Request #288: Allow kinsplitter to create multiple kin files for the same event.
  • Pull Request #279, #283: Updates for Docker
  • Pull Request #288: Changes required for supernova simulations (including an increase in the stored time precision - this results in a 20% increase in file size).
  • Pull Request #272: Added a different (more direct) way to compare digits

01/29/2019: Notes for v1.8.0

The main updates included in this release include an outer detector volume in the Hyper-Kamiokande detector, an option to include light cones, and updates to accommodate our new trigger simulations.

New Features

  • Pull Request #210, #251, #242, #252, #253, #233: Hyper-K configuration with an outer detector is implemented.
  • Pull Request #206: New macro folder now contains all the macros.
  • Pull Request #229: Digitization of the OD.
  • Pull Request #205: Add option in macro to switch off QE completely.
  • Pull Request #220: Add a no-trigger trigger option
  • Pull Request #223, #227, #238: Changes to allow for Travis validation suite
  • Pull Request #236: Changing travis source docker file
  • Pull Request #228: Allow simulation of multiple primary vertices in an event
  • Pull Request #249: Support OGLSQT visualization
  • Pull Request #246: Allow multiple instances of dark noise options to be stored
  • Pull Request #231: Add 3" and 5" PMT options
  • Pull Request #263: Light cone option is now included

Bug Fixes

  • Pull Request #145: Fix 0 hits report when running hits/verbose 1
  • Pull Request #193: Digitized hits were being floored to an int (introduced in v1.4.0). This pull request makes digit times a float.
  • Pull Request #194: Moves hit time smearing back to the PMT hit, rather than to the digitized hits.
  • Pull Request #216: Fix typo in WCSimRootOptions::Print()
  • Pull Request #217: Fix floating point exception error caused by non-optical photons with a total energy of 0 in ProcessHits for which the wavelength calculation didn't make sense. Moved the wavelength calculation down to be only for optical photons.
  • Pull Request #225: A nuance-formatted input file created on Windows will usually have \r\n line endings instead of the Unix default \n. Let’s add \r to the list of ignored characters so those files get parsed correctly.
  • Pull Request #255: Add some statements to the LinkDef
  • Pull Request #265: WCSim files generated using muline option have the vertex incorrectly set to (0,0,0). This fixes it.

Updates

  • Pull Request #166, #254: Updates related to the verification scripts.
  • Pull Request #199: Can now check changes to output file sizes and running time in verification scripts.
  • Pull Request #193: Users can now specify the precision with which to store digitized hits.
  • Pull Request #204: New RootOptions included in the CMake build options.
  • Pull Request #207: Change the colour of mu- and mu+ in visualization and add background colour
  • Pull Request #258, #256: Allow the addition and deletion of Cherenkov digits in WCSimWCTrigger
  • Pull Request #257: Add assignment operators to WCSimRootEvent & WCSimRootTrigger
  • Pull Request #264: Add how to run WCSim to the README
  • Pull Request #259: WCSimWCDigit::SortArrayByHitTime() to sort times_presmear too
  • Pull Request #260: Allow the addition and deletion of tracks in WCSimWCTrigger
  • Pull Request #262, #267: Changes to the trigger to make it more realistic

04/27/2017: Notes for v1.7.0

New Features

  • Pull Request #198: Run options (such as dark noise rate, electronics configuration, detector configuration, etc) is now saved in the output ROOT file.
  • Pull Request #212 (forked from Pull Request #202): WCSim now runs with Geant 4.10.1. Extensive validation was done to ensure the physics output matches what we expect. The custom physics list option was removed and the FTFP_BERT physics list is now the default.

Bug Fixes

  • Pull Request #191: Digits were being saved multiple times if they were in overlapping trigger windows. This is now fixed.

Updates

  • Pull Request #135: G4 General Particle Source now documented in WCSim.mac.
  • Pull Request #176: Clean up read_PMT.C by removing duplicate line and unifying output.
  • Pull Request #180: .gitignore file was extended to ignore output and compiled files.

07/04/2016: Notes for v1.6.0

New Features

  • Pull Request #125: Update code to compile with cmake. Information is included in the README.md file.
  • Pull Request #151: HyperK detector configuration now reflects the design report specifications (a cylinder with a height of 54.8 m, a diameter of 70.8 m).
  • Pull Request #151: The egg-shaped Hyper-K design is still available, but is now renamed EggShapedHyperK.
  • Pull Request #163: Error message is now output if vector file specified in the macro does not exist.
  • Pull Request #170: Some improvements to verification_HitsChargeTime.C, including a check for the same number of events in the two files being compared.

Bug Fixes

  • Pull Request #165: The raw (undigitized) hit times in the output ROOT file were smeared since v1.5.0. This release returns the raw (undigitized) hit times back to their unsmeared times.
  • Pull Request #165: There was a related bug that arose from matching the collection of unsmeared hit times to the smeared times, resulting in some wrong times & parent IDs being saved. This release fixes that bug.

Updates

  • Pull Requests #164 and #183: Swap the remaining instances of cout, cerr, endl for G4cout, G4cerr, G4endl and remove the iostream includes, except in WCSimEnumerations, which is used to analyze the WCSim ROOT files.
  • Pull Request #174: Updated references to documentation of root file structure. The defunct link included in some of the sample ROOT macros was changed to refer users to the WCSim DetectorDocumentation.pdf.

04/11/2016: Notes for v1.5.1

Bug Fixes:

  • In v1.5.0, the dark rate was not being set correctly in the case where the default detector was not used (unless the dark rate was explicitly specified in the macro). This release now correctly implements the dark rate based on the photodetector type used in the detector configuration, even when the non-default detector configuration is called.

02/01/2016: Notes for v1.5.0

New Features

  • Dark rate can now be added either in a defined time window around each hit, or in a set window of a constant time.
  • Digits with negative times are now saved (this doesn't affect the current default digitizer, but could have implications for future digitizers that get added in).
  • MakeKin.py can now make vector files with random vertices for the SuperK and HyperK cylinders.
  • New DAQ-related features can now be controlled via macro files. The digitizer and trigger you want to use can be specified (in WCSim.mac), as well as properties of the digitzer and trigger (in daq.mac).

Bug Fixes

  • Hit PMTs were not being visualized after a change made in the last release. This was fixed.
  • If you built the same detector configuration twice (for example, if you rebuilt the default configuration) then the program would seg fault. This has now been fixed.
  • The smearing of the hit time is now applied in WCSimWCPMT, rather than in the digitizer after the trigger decisions have already been made.
  • The Enumerations files (WCSimEnumerations.cc and WCSimEnumerations.hh) are now compiled with WCSim to allow for ROOT scripts run in non-compiled mode to access that information.

Structural Changes

  • The digitizer, trigger, and dark noise are now separate pieces of code. Furthermore, the digitizer and trigger now inherit from base classes similar to how the PMTs were implemented in v1.2.0. As a result, users can add their own electronics easily.
  • novis.mac has been renamed WCSim.mac and now contains an option to call the visualization commands (visOGLSX.mac for the OGLSX visualization that vis.mac used or visRayTracer.mac for the RayTracer visualization). vis.mac has been removed and visRaytracer.mac is no longer a stand alone macro.
  • All of the digitizer and trigger options are now included in a separate daq.mac file. This file gets called by WCSim.mac. The choice of digitizer and trigger is made in WCSim.mac.
  • Dark rate is now a property of the PMT and is automatically changed when a new PMT is used (rather than having to manually set it in the macro).

Updates

  • doc/DetectorDocumentation.pdf was updated to reflect new DAQ options and the changes made to the default macros.

08/03/2015: Notes for v1.4.0

New Features

  • Multiple sensitive detectors can now be instantiated
  • Different sensitive detectors can have unique hit collections
  • WCSim executable will exit if jobOptions.mac, jobOptions2.mac, or tuning_parameters.mac are not found
  • Two cylindrical detectors with a height of 60 m and a diameter of 74 m are now available: one with 14% photocoverage and one with 40% photocoverage.
  • Raytracer visualiser is now available. A new macro, visRayTracer.mac, is now available to visualize configurations with Raytracer.

Deleted Features

  • Old DUSEL configurations removed

Structural Changes

  • User now instantiates a PMT using CreatePMT("PMTType", "CollectionName")
  • Glass thickness in ConstructPMT
  • Collection efficiency can be set in the macro files
  • HPD parameters to reflect the results from new measurements

Bug Fixes

  • The function used for the timing resolution was different from the fitted function for the >20 p.e. region. The correct timing resolution function has now been implemented.
  • PMTCollEff is now on by default
  • A correction factor of 1/0.73 has been implemented for the Box and Line photosensors. Based on Hamamatsu simulations, the collection efficiency for the R3600 is 73%. We have factors in WCSim that suppress the pe output and so this makes the R3600 simulations correct, but since we now include other photosensors (ex. box and line), we need to correct by the new photosensors by the 1/0.73 factor. The new ratio we expect for the digitized output (Quantum efficiency x Collection efficiency x Hit Efficiency) of B&L to R3600 is: (0.315x0.95x0.856/0.73)/(0.211x1.0x0.717)=2.32. This is a temporary solution until we can properly incorporate the R3600 collection efficiency and retune the factors in WCSim.

04/08/2015: Notes for v1.3.0

New Features

  • Added in 12" HPD photosensor option (same as 20" HPD but with a different geometry)
  • New detector configurations added for the Hyper-K design study: SuperK_20inchPMT_20perCent, SuperK_20inchBandL_20perCent, SuperK_12inchBandL_15perCent, SuperK_20inchBandL_14perCent, Cylinder_12inchHPD_15perCent
  • Added 12" and 20" Box and Line photosensor option
  • Implemented a collection efficiency parameter to deal with the angular efficiency dependence for Box and Line photosensors. By default, the collection efficiency option is turned off (so the collection efficiency is 100%). To enable the collection efficiency parameter, the user must set /WCSim/PMTCollEff on in the macro. If the collection efficiency parameter is enabled, the default collection efficiency in the base class is 100%. To use a different collection efficiency, GetCollectionEfficiencyArray() must be specified when defining a PMTObject in WCSimPMTObject.cc.
  • Added link to the NUANCE format documentation in the comments of WCSimPrimaryActionGenerator.cc

01/21/2015: Notes for v1.2.0

Bug Fixes

  • Missing HK variables added so that the HK geometry could be specified as the default and the code won't crash.
  • HasSubEvents() function now returns the proper Boolean value.
  • Dark noise is now added between the start of the trigger window and the start of the signal.

Structural Changes

  • All of the different detector setups were moved into a file called WCSimDetectorConfigs.cc.
  • WCSimPMTQE.cc was created and all quantum efficiency info was put there.
  • WCSimWCDigitizer was split into a PMT collection (in the newly created WCSimWCPMT file) and a digitizer collection.
  • The PMT information was put into a single file called WCSimPMTObject.cc. PMTs now inherit from the newly created WCSimPMTObject class.
  • WCSimWCConstructWC is now named WCSimConstructCylinder to explicitly show that this function builds cylindrical geometries and should not be used to construct the HK geometry.

New Features

  • Python script was added to generate kinematics files for simple particles.
  • A (very) basic validation script was added in a new directory called verification-test-scripts. The verification_HitsChargeTime.C script checks the hits, charge, and timing of events against a clean copy of the WCSim code.
  • HPDs were added to the list of possible tubes allowed in WCSim.
  • Hyper-K with HPDs was added as a new detector configuration.
  • Updated the dark rate parameters for normal PMTs.
  • Added the dark rate commands to novis.mac. Uncommented out the dark rate commands in novis.mac and vis.mac.
  • Included the dark rate parameters for the HPDs in vis.mac and novis.mac.