Installation

AutoNICER is designed to work on top of an existing local installation of HEASoft, and can be installed through pip.

Please see the following for further details on installing autoNICER.

Pre-requisite package required prior to installation

• HEASoft ** The most recent version is always recommended (current: 6.31.1)

Link: https://heasarc.gsfc.nasa.gov/docs/software/lheasoft/

A video tutorial on how to generally install HEASoft can be found here: https://youtu.be/3-gobnSEuDo

• CALDB Remote or Local is ok

Link: https://heasarc.gsfc.nasa.gov/docs/heasarc/caldb/caldb_remote_access.html

A video tutorial on how to setup Remote CALDB can be found here: https://youtu.be/s01DF0cwOvM

• wget

Tested OSs

• Ubuntu 20.04 LTS, 22.04 LTS
• Pop!_OS 22.04
• Fedora Linux (version not disclosed to maintainer)

Installation with pip

For standard non-dev use cases download and install autoNICER via pip.

$ pip3 install autonicer

OR

$ pip install autonicer

** Make sure you have this added to your PATH so you can run it with just $ autonicer

Try running the following to see if autoNICER is installed properly:

    $ autonicer --help

Alternatively you can download the distribution files from the releases here on github (https://github.com/nkphysics/autoNICER/releases) and install with the following:

    $ pip install /PATH-TO/autonicer-X.X.X..tar.gz

Python Dependencies

• python = "^3.8"
• astropy = ">4.2.1"
• astroquery = ">0.4.3"
• numpy = ">1.20.3"
• pandas = ">1.2.4"
• termcolor = "^1.1.0"
• certifi = "^2022.12.7"

Python Dependencies for Development

• pytest-cov = ">=3.0.0"
• black = "^22.6.0"
• pytest = ">=7.2.0"