Skip to content

wcxve/elisa

Repository files navigation

ELISA: Efficient Library for Spectral Analysis in High-Energy Astrophysics

PyPI - Python Version PyPI - Version License: GPL v3
Coverage Status Documentation Status

ELISA aims to provide a modern and efficient tool to explore and analyze the spectral data. It is designed to be user-friendly and flexible. The key features of ELISA include:

  • Ease of Use: Simple and intuitive interfaces
  • Robustness: Utilizing the state-of-the-art algorithm to fit, test, and compare models
  • Performance: Efficient computation backend based on JAX
  • ...

NOTE: ELISA is currently under active development. Please be aware of potential brittleness, bugs, and changes to the API as the design evolves.


Table of Contents

Installation

Stable Version

It is recommended to install ELISA in a new conda environment as follows:

  1. Create a new conda environment. The following command creates a new environment named "elisa" with Python 3.11:

    conda create -n elisa python=3.11

    Note that you can customize the environment name to your preference, and the Python version should range from 3.9 to 3.12.

  2. Activate the environment we just created:

    conda activate elisa
  3. Install ELISA using pip:

    pip install astro-elisa

Use Xspec Models

If you want to use models from Xspec, make sure HEASoft and Xspec v12.12.1+ are installed on your system, and the HEASoft environment is initialized, then use the following command to install xspex:

pip install xspex

Development Version

The latest version of ELISA can be installed by the following command:

pip install -U git+https://github.com/wcxve/elisa.git

Documentation

Read the documentation at: https://astro-elisa.readthedocs.io

License

ELISA is distributed under the terms of the GPL-3.0 license.