How to report NICER software and calibration versions
It is important to document which versions of NICER software and calibrations you use. This page describes how to do this.
Read this thread if you want to: Report which versions of NICER software and calibration are being used
Last update: 2022-04-25
Obtaining useful scientific results from NICER observations is a combination of NICER observational data with software and calibration products. Over time, NICER improves its software and calibration products so that scientists can get the most out of their data.
Thus, it is important for scientists to know which version of software and calibration are being used for their analysis. In addition, it is important to report this information in publications. Since repeatability of experiments is a vital aspect of the scientific method, this information is needed so that other analysts can repeat the analysis.
This page describes how to report the relevant NICER version information, namely:
Before starting, be sure that you have NICER software and calibration data bases installed and up to date. Please see the Setting Up a NICER Analysis Environment thread for more information
Reporting HEASoft / NICER Software Versions
NICER software is distributed as a part of HEASoft. HEASoft has a reported version number, but NICERDAS does as well. Since they are distributed together, both versions should increase in lockstep.
The correct way to report the HEASoft version number is with the
'ftversion' task ('fversion' is equivalent).
The correct way to report the NICERDAS software version is with the
Reporting NICER Calibration Database Version
NICER also distributes separately calibration products via the
Database (CALDB) system. The way to report the calibration
version is with the 'nicaldbver' task.