NuSTAR Tools

Relevant Links

• The Github repository can be found here.
• The PyPI webpage can be found here.

---

Installation

Install nustar_tools through pip:

git clone https://github.com/masek014/nustar_tools.git
cd nustar_tools
pip install -e .

If you want to generate documentation, pdoc3 is required. Execute the following commands to build the documentation:

cd nustar_tools/
pdoc3 nustar_tools --html --output-dir docs

You will find the documentation in HTML files in the newly created docs/ directory. Begin with index.html.

Requirements

nustar_tools was tested on Python 3.11. It is currently unknown how it will perform on other versions of Python.

This package has several dependencies that are listed in requirements.txt. These packages can be installed all at once by locally saving the requirements.txt file and executing the following command:

pip install -r requirements.txt

The only package that must be installed manually is nustar_pysolar, which can be found here. While the installation instructions make use of a Conda environment, this is not necessary in order to install the package. Follow the instructions as outlined on the page except execute the same pip command from above instead of what's listed on the page when installing the requirements.