Documentation


This page provides links to XRISM documentation, including instrument hardware and analysis software documentation. Currently, only preliminary documentation is provided for XRISM. Hitomi archival documentation is also provided for reference.

Instrument Hardware Documentation

XRISM Software Documentation

  • XRISM simulation information, including HEASIM for detailed simulation as well as response and background files for point-source simulations, can be found on the JAXA website.
  • XRISM proposal tools are useful to all proposers and include information on the General Observer (GO) Program and how to submit proposals to NASA, ESA and JAXA.
  • XRISM Software Doxygen Docs (v001): Users will find a browsable, hyperlinked collection of HTML software documentation automatically generated directly from XRISM software source code. Every aspect of XRISM software is presented via highly readable markup, including intuitive presentation of functional groupings and relationships among components. For users who wish to examine source code, every component is intuitively linked to its relevant source code.

Hitomi Software Documentation

We refer to Hitomi software here since the XRISM software was developed from a Hitomi software basis. XRISM, essentially being a re-fly of the Hitomi mission, uses much of the same software algorithms. Upgrades and updates have been made from Hitomi for XRISM at the instrument level, which have been implemented (or will be implemented before launch) for the XRISM software. The Hitomi software will continue to be available, as will the archive, but the Hitomi software will not work for XRISM data. Additionally, some known bugs have been fixed while updating the Hitomi to XRISM software.