Metadata-Version: 2.4
Name: sheap
Version: 0.0.11
Summary: sheap: Spectral Handling and Estimation of AGN Parameters
Keywords: python package
Author: Felipe Avila-Vera
Author-email: Felipe Avila-Vera <felipe.avilav@postgrado.uv.cl>
License-Expression: AGPL-3.0-only
Requires-Dist: numpy>=2.0,<2.3
Requires-Dist: pandas>=2.2
Requires-Dist: scipy>=1.11
Requires-Dist: astropy>=7.2
Requires-Dist: matplotlib>=3.8
Requires-Dist: jax==0.4.38
Requires-Dist: jaxlib==0.4.38
Requires-Dist: optax>=0.2.3,<0.3
Requires-Dist: tqdm>=4.66
Requires-Dist: uncertainties>=3.1
Requires-Dist: sfdmap2
Requires-Dist: requests
Maintainer: Felipe Avila-Vera
Maintainer-email: Felipe Avila-Vera <felipe.avilav@postgrado.uv.cl>
Requires-Python: >=3.11, <3.13
Project-URL: Homepage, https://github.com/favila/sheap
Project-URL: Repository, https://github.com/favila/sheap
Project-URL: Documentation, https://sheap.readthedocs.io/
Project-URL: Bug Tracker, https://github.com/favila/sheap/issues
Project-URL: CI: Github Actions, https://github.com/favila/sheap/actions
Project-URL: Source Code, https://github.com/favila/sheap
Project-URL: Changelog, https://github.com/favila/sheap/blob/master/CHANGELOG.rst
Project-URL: Code of Conduct, https://github.com/favila/sheap/blob/master/CONTRIBUTING.rst
Description-Content-Type: text/x-rst

.. image:: https://raw.githubusercontent.com/felavila/sheap/main/docs/source/_static/sheap_withname.png
   :alt: SHEAP Logo
   :align: left
   :width: 700


Spectral Handling and Estimation of AGN Parameters
==================================================
|pypi_badge| |docs_badge|

**sheap** (Spectral Handling and Estimation of AGN Parameters) is a Python 3 package designed to analyze and estimate key parameters of Active Galactic Nuclei (AGN) from spectral data. This package provides tools to streamline the handling of spectral data and applies models to extract relevant AGN properties efficiently.

Features
========

- **Spectral Fitting**: Automatically fits AGN spectra to estimate key physical parameters.
- **Model Customization**: Allows flexible models for AGN spectra to suit a variety of use cases.
- **AGN Parameter Estimation**: Extract black hole mass from observed spectra.

Installation
============

You can install sheap locally using the following command:

.. code-block:: shell

    pip install -e .

Prerequisites
=============

You need to have Python (>=3.12) and the required dependencies installed. Dependencies are managed using Poetry or can be installed manually via `requirements.txt`.

References
==========

sheap is based on methodologies and models outlined in the following paper:

-  **Ávila-Vera, F., et al. (xxx)**.
   *Spectral Handling and Estimation of AGN Parameters (SHEAP):
   The first GPU-based AGN spectral-fitting code*.
   **xxx**, xxx.
   Available at: `ADS Abstract <#>`_.


License
=======

* `GNU Affero General Public License v3.0 <https://www.gnu.org/licenses/agpl-3.0.html>`_

.. |pypi_badge| image:: https://img.shields.io/pypi/v/sheap.svg
   :alt: PyPI version
   :target: https://pypi.org/project/sheap/

.. |docs_badge| image:: https://readthedocs.org/projects/sheap/badge/?version=latest
   :alt: Documentation Status
   :target: https://sheap.readthedocs.io/en/latest/?badge=latest

